com.esri.arcgis.datasourcesraster
Class ReplacePathsParameters

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

public class ReplacePathsParameters
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IMosaicDatasetOperationParameters, IReplacePathsParameters2, ISelectionParameters

COM Class 'ReplacePathsParameters'. Generated 3/19/2015 1:20:42 PM from 'C:\ArcGIS\COM\esriDataSourcesRaster.olb'

Description 'An object that controls how paths referenced by a mosaic dataset and items in the mosaic dataset are updated.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.esri.arcgis.datasourcesraster.IMosaicDatasetOperationParameters
IID, IID379006f4_6f75_4c3b_b783_0c2e88a7b280, xxDummy
 
Fields inherited from interface com.esri.arcgis.datasourcesraster.IReplacePathsParameters2
IID, IID8d43cb3f_8856_440c_a182_46e78843d80e, xxDummy
 
Fields inherited from interface com.esri.arcgis.datasourcesraster.IReplacePathsParameters
IIDd9179edc_c88a_4b6f_818f_f53d83a05519
 
Fields inherited from interface com.esri.arcgis.datasourcesraster.ISelectionParameters
IID, IID95627b93_1275_4714_94a7_a55df27e70a2, xxDummy
 
Constructor Summary
ReplacePathsParameters()
          Constructs a ReplacePathsParameters using ArcGIS Engine.
ReplacePathsParameters(java.lang.Object obj)
          Construct a ReplacePathsParameters using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 boolean equals(java.lang.Object o)
          Compare this object with another
static java.lang.String getClsid()
          getClsid.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 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.
 IFIDSet getRasterTypeInstanceIDs()
          The collection of raster type instances for which paths are replaced.
 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 isReplaceCachePaths()
          Indicates whether paths in raster dataset cache are replaced.
 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.
 boolean isReplaceRasterTypePaths()
          Indicates whether paths in raster types are replaced.
 void release()
          Release a ReplacePathsParameters.
 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 setRasterTypeInstanceIDsByRef(IFIDSet ppRasterTypeInstanceIDs)
          The collection of raster type instances for which paths are replaced.
 void setReplaceCachePaths(boolean pbReplaceCachePaths)
          Indicates whether paths in raster dataset cache are replaced.
 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 setReplaceRasterTypePaths(boolean pbReplaceRasterTypePaths)
          Indicates whether paths in raster types 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
 

Constructor Detail

ReplacePathsParameters

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

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

ReplacePathsParameters

public ReplacePathsParameters(java.lang.Object obj)
                       throws java.io.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:
java.io.IOException - if there are interop problems ReplacePathsParameters theReplacePathsParameters = (ReplacePathsParameters) obj;
Method Detail

getClsid

public static java.lang.String getClsid()
getClsid.


equals

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

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a ReplacePathsParameters.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

setParametersByRef

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

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

getParameters

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

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

setProgressorByRef

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

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

getProgressor

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

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

setIsDatasetReadOnly

public void setIsDatasetReadOnly(boolean pbIsDatasetReadOnly)
                          throws java.io.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.

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

isDatasetReadOnly

public boolean isDatasetReadOnly()
                          throws java.io.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.

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

setResultsByRef

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

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

getResults

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

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

setReplaceRasterTypePaths

public void setReplaceRasterTypePaths(boolean pbReplaceRasterTypePaths)
                               throws java.io.IOException,
                                      AutomationException
Indicates whether paths in raster types are replaced.

Specified by:
setReplaceRasterTypePaths in interface IReplacePathsParameters2
Parameters:
pbReplaceRasterTypePaths - The pbReplaceRasterTypePaths (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isReplaceRasterTypePaths

public boolean isReplaceRasterTypePaths()
                                 throws java.io.IOException,
                                        AutomationException
Indicates whether paths in raster types are replaced.

Specified by:
isReplaceRasterTypePaths in interface IReplacePathsParameters2
Returns:
The pbReplaceRasterTypePaths
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRasterTypeInstanceIDsByRef

public void setRasterTypeInstanceIDsByRef(IFIDSet ppRasterTypeInstanceIDs)
                                   throws java.io.IOException,
                                          AutomationException
The collection of raster type instances for which paths are replaced. If this property is not set, paths are replaced for only those raster type instances associated with selected mosaic dataset items.

Specified by:
setRasterTypeInstanceIDsByRef in interface IReplacePathsParameters2
Parameters:
ppRasterTypeInstanceIDs - A reference to a com.esri.arcgis.geodatabase.IFIDSet (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRasterTypeInstanceIDs

public IFIDSet getRasterTypeInstanceIDs()
                                 throws java.io.IOException,
                                        AutomationException
The collection of raster type instances for which paths are replaced. If this property is not set, paths are replaced for only those raster type instances associated with selected mosaic dataset items.

Specified by:
getRasterTypeInstanceIDs in interface IReplacePathsParameters2
Returns:
A reference to a com.esri.arcgis.geodatabase.IFIDSet
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setReplaceCachePaths

public void setReplaceCachePaths(boolean pbReplaceCachePaths)
                          throws java.io.IOException,
                                 AutomationException
Indicates whether paths in raster dataset cache are replaced.

Specified by:
setReplaceCachePaths in interface IReplacePathsParameters2
Parameters:
pbReplaceCachePaths - The pbReplaceCachePaths (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isReplaceCachePaths

public boolean isReplaceCachePaths()
                            throws java.io.IOException,
                                   AutomationException
Indicates whether paths in raster dataset cache are replaced.

Specified by:
isReplaceCachePaths in interface IReplacePathsParameters2
Returns:
The pbReplaceCachePaths
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setReplaceMosaicDatasetPaths

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

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

isReplaceMosaicDatasetPaths

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

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

setReplaceCatalogItemPaths

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

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

isReplaceCatalogItemPaths

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

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

setReplaceItemURIPaths

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

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

isReplaceItemURIPaths

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

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

setOldPathsByRef

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

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

getOldPaths

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

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

setNewPathsByRef

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

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

getNewPaths

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

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

setSelectionSetByRef

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

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

getSelectionSet

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

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

setQueryFilterByRef

public void setQueryFilterByRef(IQueryFilter ppQueryFilter)
                         throws java.io.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.

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

getQueryFilter

public IQueryFilter getQueryFilter()
                            throws java.io.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.

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