com.esri.arcgis.datasourcesraster
Class QueryPathsParameters

java.lang.Object
  com.esri.arcgis.datasourcesraster.QueryPathsParameters

All Implemented Interfaces:

IMosaicDatasetOperationParameters, IQueryPathsParameters, ISelectionParameters, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class QueryPathsParameters
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IMosaicDatasetOperationParameters, IQueryPathsParameters, ISelectionParameters

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

Product Availability

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

See Also:

Serialized Form

Constructor Summary

QueryPathsParameters()
Constructs a QueryPathsParameters using ArcGIS Engine.

QueryPathsParameters(Object obj)
Construct a QueryPathsParameters 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.
IPropertySet	getParameters() All parameters associated with the mosaic dataset operation.
int	getPathDepth() The maximum depth of each folder path returned.
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	isBrokenPathsOnly() Indicates whether only broken paths are returned.
boolean	isDatasetReadOnly() Indicates whether the mosaic dataset is in read-only mode.
boolean	isFoldersOnly() Indicates whether only folder paths are returned.
boolean	isQueryDatasetPaths() Indicates whether paths associated with each raster dataset is queried.
boolean	isQueryItemURIPaths() Indicates whether paths from URI objects that identify source to the raster type are queried.
void	setBrokenPathsOnly(boolean pbBrokenOnly) Indicates whether only broken paths are returned.
void	setFoldersOnly(boolean pbFoldersOnly) Indicates whether only folder paths are returned.
void	setIsDatasetReadOnly(boolean pbIsDatasetReadOnly) Indicates whether the mosaic dataset is in read-only mode.
void	setParametersByRef(IPropertySet ppAllParameters) All parameters associated with the mosaic dataset operation.
void	setPathDepth(int pPathDepth) The maximum depth of each folder path returned.
void	setProgressorByRef(IProgressor ppProgressor) The external progressor object associated with the mosaic dataset operation.
void	setQueryDatasetPaths(boolean pbQueryDatasetPaths) Indicates whether paths associated with each raster dataset is queried.
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	setQueryItemURIPaths(boolean pbQueryURIPaths) Indicates whether paths from URI objects that identify source to the raster type are queried.
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

QueryPathsParameters

public QueryPathsParameters()
                     throws IOException,
                            UnknownHostException

Constructs a QueryPathsParameters using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

QueryPathsParameters

public QueryPathsParameters(Object obj)
                     throws IOException

Construct a QueryPathsParameters using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to QueryPathsParameters.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems QueryPathsParameters theQueryPathsParameters = (QueryPathsParameters) 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.

setQueryDatasetPaths

public void setQueryDatasetPaths(boolean pbQueryDatasetPaths)
                          throws IOException,
                                 AutomationException

Indicates whether paths associated with each raster dataset is queried.

Product Availability

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

Specified by:

setQueryDatasetPaths in interface IQueryPathsParameters

Parameters:

pbQueryDatasetPaths - The pbQueryDatasetPaths (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isQueryDatasetPaths

public boolean isQueryDatasetPaths()
                            throws IOException,
                                   AutomationException

Indicates whether paths associated with each raster dataset is queried.

Product Availability

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

Specified by:

isQueryDatasetPaths in interface IQueryPathsParameters

Returns:

The pbQueryDatasetPaths

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setQueryItemURIPaths

public void setQueryItemURIPaths(boolean pbQueryURIPaths)
                          throws IOException,
                                 AutomationException

Indicates whether paths from URI objects that identify source to the raster type are queried.

Product Availability

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

Specified by:

setQueryItemURIPaths in interface IQueryPathsParameters

Parameters:

pbQueryURIPaths - The pbQueryURIPaths (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isQueryItemURIPaths

public boolean isQueryItemURIPaths()
                            throws IOException,
                                   AutomationException

Indicates whether paths from URI objects that identify source to the raster type are queried.

Product Availability

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

Specified by:

isQueryItemURIPaths in interface IQueryPathsParameters

Returns:

The pbQueryURIPaths

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBrokenPathsOnly

public void setBrokenPathsOnly(boolean pbBrokenOnly)
                        throws IOException,
                               AutomationException

Indicates whether only broken paths are returned.

Product Availability

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

Specified by:

setBrokenPathsOnly in interface IQueryPathsParameters

Parameters:

pbBrokenOnly - The pbBrokenOnly (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isBrokenPathsOnly

public boolean isBrokenPathsOnly()
                          throws IOException,
                                 AutomationException

Indicates whether only broken paths are returned.

Product Availability

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

Specified by:

isBrokenPathsOnly in interface IQueryPathsParameters

Returns:

The pbBrokenOnly

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFoldersOnly

public void setFoldersOnly(boolean pbFoldersOnly)
                    throws IOException,
                           AutomationException

Indicates whether only folder paths are returned.

Product Availability

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

Specified by:

setFoldersOnly in interface IQueryPathsParameters

Parameters:

pbFoldersOnly - The pbFoldersOnly (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFoldersOnly

public boolean isFoldersOnly()
                      throws IOException,
                             AutomationException

Indicates whether only folder paths are returned.

Product Availability

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

Specified by:

isFoldersOnly in interface IQueryPathsParameters

Returns:

The pbFoldersOnly

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPathDepth

public void setPathDepth(int pPathDepth)
                  throws IOException,
                         AutomationException

The maximum depth of each folder path returned.

Product Availability

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

Specified by:

setPathDepth in interface IQueryPathsParameters

Parameters:

pPathDepth - The pPathDepth (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPathDepth

public int getPathDepth()
                 throws IOException,
                        AutomationException

The maximum depth of each folder path returned.

Product Availability

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

Specified by:

getPathDepth in interface IQueryPathsParameters

Returns:

The pPathDepth

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.