com.esri.arcgis.datasourcesraster
Class ReplacePathsParameters

java.lang.Object
  extended by com.esri.arcgis.datasourcesraster.ReplacePathsParameters
All Implemented Interfaces:
IMosaicDatasetOperationParameters, IReplacePathsParameters, ISelectionParameters, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class ReplacePathsParameters
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IMosaicDatasetOperationParameters, IReplacePathsParameters, ISelectionParameters

An object that controls how paths referenced by a mosaic dataset and items in the mosaic dataset are updated.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
ReplacePathsParameters()
          Constructs a ReplacePathsParameters using ArcGIS Engine.
ReplacePathsParameters(Object obj)
          Construct a ReplacePathsParameters using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 IStringArray getNewPaths()
          The array of possible target paths that each item is replaced with.
 IStringArray getOldPaths()
          The array of source paths to be replaced.
 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.
 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.
 int hashCode()
          the hashcode for this object
 boolean isDatasetReadOnly()
          Indicates whether the mosaic dataset is in read-only mode.
 boolean isReplaceCatalogItemPaths()
          Indicates whether paths in selected mosaic catalog items are replaced.
 boolean isReplaceItemURIPaths()
          Indicates whether paths in item URIs are replaced.
 boolean isReplaceMosaicDatasetPaths()
          Indicates whether paths in mosaic dataset level objects are replaced.
 void setIsDatasetReadOnly(boolean pbIsDatasetReadOnly)
          Indicates whether the mosaic dataset is in read-only mode.
 void setNewPathsByRef(IStringArray ppPaths)
          The array of possible target paths that each item is replaced with.
 void setOldPathsByRef(IStringArray ppPaths)
          The array of source paths to be replaced.
 void setParametersByRef(IPropertySet ppAllParameters)
          All parameters associated with the mosaic dataset operation.
 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 setReplaceCatalogItemPaths(boolean pbReplaceCatalogPaths)
          Indicates whether paths in selected mosaic catalog items are replaced.
 void setReplaceItemURIPaths(boolean pbReplaceURIPaths)
          Indicates whether paths in item URIs are replaced.
 void setReplaceMosaicDatasetPaths(boolean pbReplaceMosaicPaths)
          Indicates whether paths in mosaic dataset level objects are replaced.
 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.
 
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

ReplacePathsParameters

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

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

ReplacePathsParameters

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

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems ReplacePathsParameters theReplacePathsParameters = (ReplacePathsParameters) 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.

setReplaceMosaicDatasetPaths

public void setReplaceMosaicDatasetPaths(boolean pbReplaceMosaicPaths)
                                  throws IOException,
                                         AutomationException
Indicates whether paths in mosaic dataset level objects are replaced.

Product Availability

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

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

isReplaceMosaicDatasetPaths

public boolean isReplaceMosaicDatasetPaths()
                                    throws IOException,
                                           AutomationException
Indicates whether paths in mosaic dataset level objects are replaced.

Product Availability

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

Specified by:
isReplaceMosaicDatasetPaths in interface IReplacePathsParameters
Returns:
The pbReplaceMosaicPaths
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setReplaceCatalogItemPaths

public void setReplaceCatalogItemPaths(boolean pbReplaceCatalogPaths)
                                throws IOException,
                                       AutomationException
Indicates whether paths in selected mosaic catalog items are replaced.

Product Availability

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

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

isReplaceCatalogItemPaths

public boolean isReplaceCatalogItemPaths()
                                  throws IOException,
                                         AutomationException
Indicates whether paths in selected mosaic catalog items are replaced.

Product Availability

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

Specified by:
isReplaceCatalogItemPaths in interface IReplacePathsParameters
Returns:
The pbReplaceCatalogPaths
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setReplaceItemURIPaths

public void setReplaceItemURIPaths(boolean pbReplaceURIPaths)
                            throws IOException,
                                   AutomationException
Indicates whether paths in item URIs are replaced.

Product Availability

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

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

isReplaceItemURIPaths

public boolean isReplaceItemURIPaths()
                              throws IOException,
                                     AutomationException
Indicates whether paths in item URIs are replaced.

Product Availability

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

Specified by:
isReplaceItemURIPaths in interface IReplacePathsParameters
Returns:
The pbReplaceURIPaths
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOldPathsByRef

public void setOldPathsByRef(IStringArray ppPaths)
                      throws IOException,
                             AutomationException
The array of source paths to be replaced.

Product Availability

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

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

getOldPaths

public IStringArray getOldPaths()
                         throws IOException,
                                AutomationException
The array of source paths to be replaced.

Product Availability

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

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

setNewPathsByRef

public void setNewPathsByRef(IStringArray ppPaths)
                      throws IOException,
                             AutomationException
The array of possible target paths that each item is replaced with.

Product Availability

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

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

getNewPaths

public IStringArray getNewPaths()
                         throws IOException,
                                AutomationException
The array of possible target paths that each item is replaced with.

Product Availability

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

Specified by:
getNewPaths in interface IReplacePathsParameters
Returns:
A reference to a com.esri.arcgis.system.IStringArray
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.