com.esri.arcgis.datasourcesraster

Class QueryPathsParameters

java.lang.Object

com.esri.arcgis.datasourcesraster.QueryPathsParameters

All Implemented Interfaces:

IMosaicDatasetOperationParameters, IQueryPathsParameters, IQueryPathsParameters2, IQueryPathsParameters3, ISelectionParameters, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

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

COM Class 'QueryPathsParameters'. Generated 9/21/2023 10:01:44 AM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description 'An object that controls how paths referenced by a mosaic dataset and items in the mosaic dataset are queried.' 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.IQueryPathsParameters3

IID, IID4bfbdc86_a30a_4343_ad58_c80306554d07, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.IQueryPathsParameters2

IID204481d8_b38b_4b7b_897a_c33d112f5574

Fields inherited from interface com.esri.arcgis.datasourcesraster.IQueryPathsParameters

IID437435d9_ef2e_4018_ae93_21d3a29643dd

Fields inherited from interface com.esri.arcgis.datasourcesraster.ISelectionParameters

IID, IID95627b93_1275_4714_94a7_a55df27e70a2, xxDummy

Constructor Summary

Constructors

Constructor and Description
QueryPathsParameters() Constructs a QueryPathsParameters using ArcGIS Engine.
QueryPathsParameters(java.lang.Object obj) Construct a QueryPathsParameters using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Compare this object with another
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
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	isQueryCachePaths() Indicates whether paths associated with raster dataset cache are queried.
boolean	isQueryDatasetPaths() Indicates whether paths associated with each raster dataset are queried.
boolean	isQueryItemURIPaths() Indicates whether paths from URI objects that identify source to the raster type are queried.
boolean	isQueryRasterFunctionTemplatePaths() Indicates whether paths associated with raster function templates on the mosaic dataset are queried.
boolean	isQueryRasterTypePaths() Indicates whether paths associated with raster types are queried.
void	release() Release this COM object reference
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	setQueryCachePaths(boolean pbQueryCachePaths) Indicates whether paths associated with raster dataset cache are queried.
void	setQueryDatasetPaths(boolean pbQueryDatasetPaths) Indicates whether paths associated with each raster dataset are 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	setQueryRasterFunctionTemplatePaths(boolean pbQueryTemplatePaths) Indicates whether paths associated with raster function templates on the mosaic dataset are queried.
void	setQueryRasterTypePaths(boolean pbQueryRasterTypePaths) Indicates whether paths associated with raster types 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

Constructor Detail

QueryPathsParameters

public QueryPathsParameters()
                     throws java.io.IOException,
                            java.net.UnknownHostException

Constructs a QueryPathsParameters using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

QueryPathsParameters

public QueryPathsParameters(java.lang.Object obj)
                     throws java.io.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:

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

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

Returns:

the COM object reference

release

public void release()

Release this COM object reference

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.

setQueryDatasetPaths

public void setQueryDatasetPaths(boolean pbQueryDatasetPaths)
                          throws java.io.IOException,
                                 AutomationException

Indicates whether paths associated with each raster dataset are queried.

Specified by:

setQueryDatasetPaths in interface IQueryPathsParameters

Parameters:

pbQueryDatasetPaths - The pbQueryDatasetPaths (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isQueryDatasetPaths

public boolean isQueryDatasetPaths()
                            throws java.io.IOException,
                                   AutomationException

Indicates whether paths associated with each raster dataset are queried.

Specified by:

isQueryDatasetPaths in interface IQueryPathsParameters

Returns:

The pbQueryDatasetPaths

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setQueryItemURIPaths

public void setQueryItemURIPaths(boolean pbQueryURIPaths)
                          throws java.io.IOException,
                                 AutomationException

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

Specified by:

setQueryItemURIPaths in interface IQueryPathsParameters

Parameters:

pbQueryURIPaths - The pbQueryURIPaths (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isQueryItemURIPaths

public boolean isQueryItemURIPaths()
                            throws java.io.IOException,
                                   AutomationException

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

Specified by:

isQueryItemURIPaths in interface IQueryPathsParameters

Returns:

The pbQueryURIPaths

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBrokenPathsOnly

public void setBrokenPathsOnly(boolean pbBrokenOnly)
                        throws java.io.IOException,
                               AutomationException

Indicates whether only broken paths are returned.

Specified by:

setBrokenPathsOnly in interface IQueryPathsParameters

Parameters:

pbBrokenOnly - The pbBrokenOnly (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isBrokenPathsOnly

public boolean isBrokenPathsOnly()
                          throws java.io.IOException,
                                 AutomationException

Indicates whether only broken paths are returned.

Specified by:

isBrokenPathsOnly in interface IQueryPathsParameters

Returns:

The pbBrokenOnly

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFoldersOnly

public void setFoldersOnly(boolean pbFoldersOnly)
                    throws java.io.IOException,
                           AutomationException

Indicates whether only folder paths are returned.

Specified by:

setFoldersOnly in interface IQueryPathsParameters

Parameters:

pbFoldersOnly - The pbFoldersOnly (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFoldersOnly

public boolean isFoldersOnly()
                      throws java.io.IOException,
                             AutomationException

Indicates whether only folder paths are returned.

Specified by:

isFoldersOnly in interface IQueryPathsParameters

Returns:

The pbFoldersOnly

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPathDepth

public void setPathDepth(int pPathDepth)
                  throws java.io.IOException,
                         AutomationException

The maximum depth of each folder path returned.

Specified by:

setPathDepth in interface IQueryPathsParameters

Parameters:

pPathDepth - The pPathDepth (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPathDepth

public int getPathDepth()
                 throws java.io.IOException,
                        AutomationException

The maximum depth of each folder path returned.

Specified by:

getPathDepth in interface IQueryPathsParameters

Returns:

The pPathDepth

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setQueryRasterTypePaths

public void setQueryRasterTypePaths(boolean pbQueryRasterTypePaths)
                             throws java.io.IOException,
                                    AutomationException

Indicates whether paths associated with raster types are queried.

Specified by:

setQueryRasterTypePaths in interface IQueryPathsParameters2

Parameters:

pbQueryRasterTypePaths - The pbQueryRasterTypePaths (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isQueryRasterTypePaths

public boolean isQueryRasterTypePaths()
                               throws java.io.IOException,
                                      AutomationException

Indicates whether paths associated with raster types are queried.

Specified by:

isQueryRasterTypePaths in interface IQueryPathsParameters2

Returns:

The pbQueryRasterTypePaths

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setQueryCachePaths

public void setQueryCachePaths(boolean pbQueryCachePaths)
                        throws java.io.IOException,
                               AutomationException

Indicates whether paths associated with raster dataset cache are queried.

Specified by:

setQueryCachePaths in interface IQueryPathsParameters2

Parameters:

pbQueryCachePaths - The pbQueryCachePaths (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isQueryCachePaths

public boolean isQueryCachePaths()
                          throws java.io.IOException,
                                 AutomationException

Indicates whether paths associated with raster dataset cache are queried.

Specified by:

isQueryCachePaths in interface IQueryPathsParameters2

Returns:

The pbQueryCachePaths

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setQueryRasterFunctionTemplatePaths

public void setQueryRasterFunctionTemplatePaths(boolean pbQueryTemplatePaths)
                                         throws java.io.IOException,
                                                AutomationException

Indicates whether paths associated with raster function templates on the mosaic dataset are queried.

Specified by:

setQueryRasterFunctionTemplatePaths in interface IQueryPathsParameters3

Parameters:

pbQueryTemplatePaths - The pbQueryTemplatePaths (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isQueryRasterFunctionTemplatePaths

public boolean isQueryRasterFunctionTemplatePaths()
                                           throws java.io.IOException,
                                                  AutomationException

Indicates whether paths associated with raster function templates on the mosaic dataset are queried.

Specified by:

isQueryRasterFunctionTemplatePaths in interface IQueryPathsParameters3

Returns:

The pbQueryTemplatePaths

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.