com.esri.arcgis.datasourcesraster
Class BuildBoundaryParameters

java.lang.Object
  extended by com.esri.arcgis.datasourcesraster.BuildBoundaryParameters
All Implemented Interfaces:
IBuildBoundaryParameters, IMosaicDatasetOperationParameters, IRemoveSliversParameters, ISelectionParameters, IThreadedOperationParameters, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class BuildBoundaryParameters
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IMosaicDatasetOperationParameters, IBuildBoundaryParameters, IRemoveSliversParameters, ISelectionParameters, IThreadedOperationParameters

An object that controls how the boundary of a mosaic dataset is computed.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:
Serialized Form

Constructor Summary
BuildBoundaryParameters()
          Constructs a BuildBoundaryParameters using ArcGIS Engine.
BuildBoundaryParameters(Object obj)
          Construct a BuildBoundaryParameters using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
 double getBufferDistanceFactor()
          The buffer factor applied on each item footprint before it is merged with the cumulative boundary geometry.
static String getClsid()
          getClsid.
 double getMinArea()
          The area below which a polygon is considered a sliver.
 double getMinCircularityRatio()
          The circularity value below which a polygon is considered a sliver.
 int getMinPointsForElimination()
          A number of points in a polygon below which it is eligible to be considered a sliver using minimum area or minimum circularity tests.
 int getNumThreads()
          The number of parallel threads that execute parts of the associated operation.
 IPropertySet getParameters()
          All parameters associated with the mosaic dataset operation.
 IProgressor getProgressor()
          The external progressor object associated with the mosaic dataset operation.
 IQueryFilter getQueryFilter()
          The query filter applied on the selection set to identify the collection of catalog items on which to perform the associated operation.
 void getRecommendedNumThreads(int[] pRecommendedNumThreads)
          The number of parallel threads of execution recommended by the system.
 IPropertySet getResults()
          The properties of the result associated with the mosaic dataset operation.
 ISelectionSet getSelectionSet()
          The selection set that identifies the collection of catalog items on which to perform the associated operation.
 String getServerName()
          The host machine name where parts of the operation are remotely executed.
 double getWeedTolerance()
          The tolerance for weeding points.
 int hashCode()
          the hashcode for this object
 boolean isAppendToExistingBoundary()
          Indicates whether the computed boundary geometry is merged with existing mosaic boundary.
 boolean isDatasetReadOnly()
          Indicates whether the mosaic dataset is in read-only mode.
 boolean isPerformWeeding()
          Indicates whether the computed boundary geometry is run through a point-weeding routine.
 boolean isRemoveSlivers()
          Indicates whether polygons designated as slivers are removed from the boundary geometry.
 boolean isUpdateBoundary()
          Indicates whether the mosaic dataset is updated with the computed boundary geometry.
 void setAppendToExistingBoundary(boolean pbAppendToExistingBoundary)
          Indicates whether the computed boundary geometry is merged with existing mosaic boundary.
 void setBufferDistanceFactor(double pBufferDistanceFactor)
          The buffer factor applied on each item footprint before it is merged with the cumulative boundary geometry.
 void setIsDatasetReadOnly(boolean pbIsDatasetReadOnly)
          Indicates whether the mosaic dataset is in read-only mode.
 void setMinArea(double pMinArea)
          The area below which a polygon is considered a sliver.
 void setMinCircularityRatio(double pMinCircularityRatio)
          The circularity value below which a polygon is considered a sliver.
 void setMinPointsForElimination(int pMinPointsForElimination)
          A number of points in a polygon below which it is eligible to be considered a sliver using minimum area or minimum circularity tests.
 void setNumThreads(int pNumThreads)
          The number of parallel threads that execute parts of the associated operation.
 void setParametersByRef(IPropertySet ppAllParameters)
          All parameters associated with the mosaic dataset operation.
 void setPerformWeeding(boolean pbPerformWeeding)
          Indicates whether the computed boundary geometry is run through a point-weeding routine.
 void setProgressorByRef(IProgressor ppProgressor)
          The external progressor object associated with the mosaic dataset operation.
 void setQueryFilterByRef(IQueryFilter ppQueryFilter)
          The query filter applied on the selection set to identify the collection of catalog items on which to perform the associated operation.
 void setRemoveSlivers(boolean pbRemoveSlivers)
          Indicates whether polygons designated as slivers are removed from the boundary geometry.
 void setResultsByRef(IPropertySet ppOperationResults)
          The properties of the result associated with the mosaic dataset operation.
 void setSelectionSetByRef(ISelectionSet ppSelectionSet)
          The selection set that identifies the collection of catalog items on which to perform the associated operation.
 void setServerName(String pServerName)
          The host machine name where parts of the operation are remotely executed.
 void setUpdateBoundary(boolean pbUpdateBoundary)
          Indicates whether the mosaic dataset is updated with the computed boundary geometry.
 void setWeedTolerance(double pWeedTolerance)
          The tolerance for weeding points.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

BuildBoundaryParameters

public BuildBoundaryParameters()
                        throws IOException,
                               UnknownHostException
Constructs a BuildBoundaryParameters using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

BuildBoundaryParameters

public BuildBoundaryParameters(Object obj)
                        throws IOException
Construct a BuildBoundaryParameters using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to BuildBoundaryParameters.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems BuildBoundaryParameters theBuildBoundaryParameters = (BuildBoundaryParameters) obj;
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

setParametersByRef

public void setParametersByRef(IPropertySet ppAllParameters)
                        throws IOException,
                               AutomationException
All parameters associated with the mosaic dataset operation.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setParametersByRef in interface IMosaicDatasetOperationParameters
Parameters:
ppAllParameters - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getParameters

public IPropertySet getParameters()
                           throws IOException,
                                  AutomationException
All parameters associated with the mosaic dataset operation.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getParameters in interface IMosaicDatasetOperationParameters
Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setProgressorByRef

public void setProgressorByRef(IProgressor ppProgressor)
                        throws IOException,
                               AutomationException
The external progressor object associated with the mosaic dataset operation.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setProgressorByRef in interface IMosaicDatasetOperationParameters
Parameters:
ppProgressor - A reference to a com.esri.arcgis.system.IProgressor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getProgressor

public IProgressor getProgressor()
                          throws IOException,
                                 AutomationException
The external progressor object associated with the mosaic dataset operation.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getProgressor in interface IMosaicDatasetOperationParameters
Returns:
A reference to a com.esri.arcgis.system.IProgressor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsDatasetReadOnly

public void setIsDatasetReadOnly(boolean pbIsDatasetReadOnly)
                          throws IOException,
                                 AutomationException
Indicates whether the mosaic dataset is in read-only mode. Mosaic dataset operations do not perform write operations on a read-only mosaic.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setIsDatasetReadOnly in interface IMosaicDatasetOperationParameters
Parameters:
pbIsDatasetReadOnly - The pbIsDatasetReadOnly (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDatasetReadOnly

public boolean isDatasetReadOnly()
                          throws IOException,
                                 AutomationException
Indicates whether the mosaic dataset is in read-only mode. Mosaic dataset operations do not perform write operations on a read-only mosaic.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
isDatasetReadOnly in interface IMosaicDatasetOperationParameters
Returns:
The pbIsDatasetReadOnly
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setResultsByRef

public void setResultsByRef(IPropertySet ppOperationResults)
                     throws IOException,
                            AutomationException
The properties of the result associated with the mosaic dataset operation.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setResultsByRef in interface IMosaicDatasetOperationParameters
Parameters:
ppOperationResults - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getResults

public IPropertySet getResults()
                        throws IOException,
                               AutomationException
The properties of the result associated with the mosaic dataset operation.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getResults in interface IMosaicDatasetOperationParameters
Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAppendToExistingBoundary

public void setAppendToExistingBoundary(boolean pbAppendToExistingBoundary)
                                 throws IOException,
                                        AutomationException
Indicates whether the computed boundary geometry is merged with existing mosaic boundary.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setAppendToExistingBoundary in interface IBuildBoundaryParameters
Parameters:
pbAppendToExistingBoundary - The pbAppendToExistingBoundary (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAppendToExistingBoundary

public boolean isAppendToExistingBoundary()
                                   throws IOException,
                                          AutomationException
Indicates whether the computed boundary geometry is merged with existing mosaic boundary.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
isAppendToExistingBoundary in interface IBuildBoundaryParameters
Returns:
The pbAppendToExistingBoundary
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPerformWeeding

public void setPerformWeeding(boolean pbPerformWeeding)
                       throws IOException,
                              AutomationException
Indicates whether the computed boundary geometry is run through a point-weeding routine.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setPerformWeeding in interface IBuildBoundaryParameters
Parameters:
pbPerformWeeding - The pbPerformWeeding (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isPerformWeeding

public boolean isPerformWeeding()
                         throws IOException,
                                AutomationException
Indicates whether the computed boundary geometry is run through a point-weeding routine.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
isPerformWeeding in interface IBuildBoundaryParameters
Returns:
The pbPerformWeeding
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setWeedTolerance

public void setWeedTolerance(double pWeedTolerance)
                      throws IOException,
                             AutomationException
The tolerance for weeding points.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setWeedTolerance in interface IBuildBoundaryParameters
Parameters:
pWeedTolerance - The pWeedTolerance (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWeedTolerance

public double getWeedTolerance()
                        throws IOException,
                               AutomationException
The tolerance for weeding points.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getWeedTolerance in interface IBuildBoundaryParameters
Returns:
The pWeedTolerance
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBufferDistanceFactor

public void setBufferDistanceFactor(double pBufferDistanceFactor)
                             throws IOException,
                                    AutomationException
The buffer factor applied on each item footprint before it is merged with the cumulative boundary geometry.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setBufferDistanceFactor in interface IBuildBoundaryParameters
Parameters:
pBufferDistanceFactor - The pBufferDistanceFactor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBufferDistanceFactor

public double getBufferDistanceFactor()
                               throws IOException,
                                      AutomationException
The buffer factor applied on each item footprint before it is merged with the cumulative boundary geometry.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getBufferDistanceFactor in interface IBuildBoundaryParameters
Returns:
The pBufferDistanceFactor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRemoveSlivers

public void setRemoveSlivers(boolean pbRemoveSlivers)
                      throws IOException,
                             AutomationException
Indicates whether polygons designated as slivers are removed from the boundary geometry.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setRemoveSlivers in interface IBuildBoundaryParameters
Parameters:
pbRemoveSlivers - The pbRemoveSlivers (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isRemoveSlivers

public boolean isRemoveSlivers()
                        throws IOException,
                               AutomationException
Indicates whether polygons designated as slivers are removed from the boundary geometry.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
isRemoveSlivers in interface IBuildBoundaryParameters
Returns:
The pbRemoveSlivers
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUpdateBoundary

public void setUpdateBoundary(boolean pbUpdateBoundary)
                       throws IOException,
                              AutomationException
Indicates whether the mosaic dataset is updated with the computed boundary geometry.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setUpdateBoundary in interface IBuildBoundaryParameters
Parameters:
pbUpdateBoundary - The pbUpdateBoundary (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUpdateBoundary

public boolean isUpdateBoundary()
                         throws IOException,
                                AutomationException
Indicates whether the mosaic dataset is updated with the computed boundary geometry.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
isUpdateBoundary in interface IBuildBoundaryParameters
Returns:
The pbUpdateBoundary
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMinPointsForElimination

public void setMinPointsForElimination(int pMinPointsForElimination)
                                throws IOException,
                                       AutomationException
A number of points in a polygon below which it is eligible to be considered a sliver using minimum area or minimum circularity tests. A value of zero indicates that polygons are eligible.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setMinPointsForElimination in interface IRemoveSliversParameters
Parameters:
pMinPointsForElimination - The pMinPointsForElimination (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinPointsForElimination

public int getMinPointsForElimination()
                               throws IOException,
                                      AutomationException
A number of points in a polygon below which it is eligible to be considered a sliver using minimum area or minimum circularity tests. A value of zero indicates that polygons are eligible.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getMinPointsForElimination in interface IRemoveSliversParameters
Returns:
The pMinPointsForElimination
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMinArea

public void setMinArea(double pMinArea)
                throws IOException,
                       AutomationException
The area below which a polygon is considered a sliver.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setMinArea in interface IRemoveSliversParameters
Parameters:
pMinArea - The pMinArea (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinArea

public double getMinArea()
                  throws IOException,
                         AutomationException
The area below which a polygon is considered a sliver.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getMinArea in interface IRemoveSliversParameters
Returns:
The pMinArea
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMinCircularityRatio

public void setMinCircularityRatio(double pMinCircularityRatio)
                            throws IOException,
                                   AutomationException
The circularity value below which a polygon is considered a sliver.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setMinCircularityRatio in interface IRemoveSliversParameters
Parameters:
pMinCircularityRatio - The pMinCircularityRatio (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinCircularityRatio

public double getMinCircularityRatio()
                              throws IOException,
                                     AutomationException
The circularity value below which a polygon is considered a sliver.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getMinCircularityRatio in interface IRemoveSliversParameters
Returns:
The pMinCircularityRatio
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSelectionSetByRef

public void setSelectionSetByRef(ISelectionSet ppSelectionSet)
                          throws IOException,
                                 AutomationException
The selection set that identifies the collection of catalog items on which to perform the associated operation.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setSelectionSetByRef in interface ISelectionParameters
Parameters:
ppSelectionSet - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSelectionSet

public ISelectionSet getSelectionSet()
                              throws IOException,
                                     AutomationException
The selection set that identifies the collection of catalog items on which to perform the associated operation.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getSelectionSet in interface ISelectionParameters
Returns:
A reference to a com.esri.arcgis.geodatabase.ISelectionSet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setQueryFilterByRef

public void setQueryFilterByRef(IQueryFilter ppQueryFilter)
                         throws IOException,
                                AutomationException
The query filter applied on the selection set to identify the collection of catalog items on which to perform the associated operation. If no selection is specified, the query filter is applied on the entire catalog.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setQueryFilterByRef in interface ISelectionParameters
Parameters:
ppQueryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getQueryFilter

public IQueryFilter getQueryFilter()
                            throws IOException,
                                   AutomationException
The query filter applied on the selection set to identify the collection of catalog items on which to perform the associated operation. If no selection is specified, the query filter is applied on the entire catalog.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getQueryFilter in interface ISelectionParameters
Returns:
A reference to a com.esri.arcgis.geodatabase.IQueryFilter
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setServerName

public void setServerName(String pServerName)
                   throws IOException,
                          AutomationException
The host machine name where parts of the operation are remotely executed.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setServerName in interface IThreadedOperationParameters
Parameters:
pServerName - The pServerName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getServerName

public String getServerName()
                     throws IOException,
                            AutomationException
The host machine name where parts of the operation are remotely executed.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getServerName in interface IThreadedOperationParameters
Returns:
The pServerName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNumThreads

public void setNumThreads(int pNumThreads)
                   throws IOException,
                          AutomationException
The number of parallel threads that execute parts of the associated operation.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setNumThreads in interface IThreadedOperationParameters
Parameters:
pNumThreads - The pNumThreads (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNumThreads

public int getNumThreads()
                  throws IOException,
                         AutomationException
The number of parallel threads that execute parts of the associated operation.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getNumThreads in interface IThreadedOperationParameters
Returns:
The pNumThreads
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRecommendedNumThreads

public void getRecommendedNumThreads(int[] pRecommendedNumThreads)
                              throws IOException,
                                     AutomationException
The number of parallel threads of execution recommended by the system.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getRecommendedNumThreads in interface IThreadedOperationParameters
Parameters:
pRecommendedNumThreads - The pRecommendedNumThreads (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.