com.esri.arcgis.datasourcesraster

Class RasterTypeDataSourceHandlerParameters

java.lang.Object

com.esri.arcgis.datasourcesraster.RasterTypeDataSourceHandlerParameters

All Implemented Interfaces:

IRasterTypeDataSourceHandlerParameters, IRasterTypeDataSourceHandlerParameters2, IRasterTypeDataSourceHandlerParameters3, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class RasterTypeDataSourceHandlerParameters
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterTypeDataSourceHandlerParameters, IRasterTypeDataSourceHandlerParameters2, IRasterTypeDataSourceHandlerParameters3

COM Class 'RasterTypeDataSourceHandlerParameters'. Generated 9/24/2024 11:01:26 AM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description 'Parameters that control raster type data source handler operations.' 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.IRasterTypeDataSourceHandlerParameters3

IID, IID4bf06473_9abb_4b1f_8656_30950277279f, xxDummy

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

IID2127d1ae_1e6f_4b55_8295_ec0d343e5893

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

IID5f88e212_6325_4c5a_bb8f_eeae77a56f87

Constructor Summary

Constructors

Constructor and Description
RasterTypeDataSourceHandlerParameters() Constructs a RasterTypeDataSourceHandlerParameters using ArcGIS Engine.
RasterTypeDataSourceHandlerParameters(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. RasterTypeDataSourceHandlerParameters theRasterTypeDataSourceHandlerParameters = (RasterTypeDataSourceHandlerParameters) obj;

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Compare this object with another
java.lang.String	getActiveTemplate() The name of the active item template associated with the raster type used for building the specified data source.
static java.lang.String	getClsid() getClsid.
java.lang.Object	getDataSource() The data source to be supplied to handler operations.
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	getRasterTypeParameters() Override parameters injected into the raster types while contructing a function raster dataset from a data source.
IArray	getRasterTypes() The collection of raster types on which the handler operates.
ITrackCancel	getTrackCancel() The cancel tracker associated with handler operations.
int	hashCode() the hashcode for this object
boolean	isAllowAncillaryDatasets() Indicates whether ancillary dataset generated by complex raster type item templates are to be allowed by handler operations.
boolean	isAllowBuilderItems() Indicates whether sensor raster types are used in the attempt to load the data source.
boolean	isAllowQuickOpen() Indicates whether an applicable data source (like a mosaic dataset item) loads with only basic information.
boolean	isAllowRasterDatasets() Indicates whether an attempt is made to load the data source as a non-sensor-dataset: i.e., a regular raster dataset, a mosaic dataset or a raster catalog item, a web service or image service item URL.
boolean	isStopAtFirstFind() Indicates whether handler operations stops searching for candidate raster types or templates once the first candidate is found.
boolean	isTryQuickCheckOnly() Indicates whether handler operations perform only cursory checks (via IRasterBuilder.CanBuild) on data sources to identify candidate raster types and templates.
void	release() Release this COM object reference
void	setActiveTemplate(java.lang.String pbsActiveTemplate) The name of the active item template associated with the raster type used for building the specified data source.
void	setAllowAncillaryDatasets(boolean pbAllowAncillaryDatasets) Indicates whether ancillary dataset generated by complex raster type item templates are to be allowed by handler operations.
void	setAllowBuilderItems(boolean pbAllowBuilderItems) Indicates whether sensor raster types are used in the attempt to load the data source.
void	setAllowQuickOpen(boolean pbAllowQuickOpen) Indicates whether an applicable data source (like a mosaic dataset item) loads with only basic information.
void	setAllowRasterDatasets(boolean pbAllowRasterDatasets) Indicates whether an attempt is made to load the data source as a non-sensor-dataset: i.e., a regular raster dataset, a mosaic dataset or a raster catalog item, a web service or image service item URL.
void	setDataSource(java.lang.Object pvtDataSource) The data source to be supplied to handler operations.
void	setRasterTypeParametersByRef(IPropertySet ppRasterTypeParameters) Override parameters injected into the raster types while contructing a function raster dataset from a data source.
void	setRasterTypesByRef(IArray ppRasterTypes) The collection of raster types on which the handler operates.
void	setStopAtFirstFind(boolean pbStopAtFirstFind) Indicates whether handler operations stops searching for candidate raster types or templates once the first candidate is found.
void	setTrackCancelByRef(ITrackCancel ppTrackCancel) The cancel tracker associated with handler operations.
void	setTryQuickCheckOnly(boolean pbTryQuickCheckOnly) Indicates whether handler operations perform only cursory checks (via IRasterBuilder.CanBuild) on data sources to identify candidate raster types and templates.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RasterTypeDataSourceHandlerParameters

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

Constructs a RasterTypeDataSourceHandlerParameters using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

RasterTypeDataSourceHandlerParameters

public RasterTypeDataSourceHandlerParameters(java.lang.Object obj)
                                      throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterTypeDataSourceHandlerParameters theRasterTypeDataSourceHandlerParameters = (RasterTypeDataSourceHandlerParameters) obj;

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

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

setDataSource

public void setDataSource(java.lang.Object pvtDataSource)
                   throws java.io.IOException,
                          AutomationException

The data source to be supplied to handler operations.

Specified by:

setDataSource in interface IRasterTypeDataSourceHandlerParameters

Parameters:

pvtDataSource - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDataSource

public java.lang.Object getDataSource()
                               throws java.io.IOException,
                                      AutomationException

The data source to be supplied to handler operations.

Specified by:

getDataSource in interface IRasterTypeDataSourceHandlerParameters

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRasterTypesByRef

public void setRasterTypesByRef(IArray ppRasterTypes)
                         throws java.io.IOException,
                                AutomationException

The collection of raster types on which the handler operates.

Specified by:

setRasterTypesByRef in interface IRasterTypeDataSourceHandlerParameters

Parameters:

ppRasterTypes - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRasterTypes

public IArray getRasterTypes()
                      throws java.io.IOException,
                             AutomationException

The collection of raster types on which the handler operates.

Specified by:

getRasterTypes in interface IRasterTypeDataSourceHandlerParameters

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTrackCancelByRef

public void setTrackCancelByRef(ITrackCancel ppTrackCancel)
                         throws java.io.IOException,
                                AutomationException

The cancel tracker associated with handler operations.

Specified by:

setTrackCancelByRef in interface IRasterTypeDataSourceHandlerParameters

Parameters:

ppTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTrackCancel

public ITrackCancel getTrackCancel()
                            throws java.io.IOException,
                                   AutomationException

The cancel tracker associated with handler operations.

Specified by:

getTrackCancel in interface IRasterTypeDataSourceHandlerParameters

Returns:

A reference to a com.esri.arcgis.system.ITrackCancel

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTryQuickCheckOnly

public void setTryQuickCheckOnly(boolean pbTryQuickCheckOnly)
                          throws java.io.IOException,
                                 AutomationException

Indicates whether handler operations perform only cursory checks (via IRasterBuilder.CanBuild) on data sources to identify candidate raster types and templates.

Specified by:

setTryQuickCheckOnly in interface IRasterTypeDataSourceHandlerParameters

Parameters:

pbTryQuickCheckOnly - The pbTryQuickCheckOnly (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isTryQuickCheckOnly

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

Indicates whether handler operations perform only cursory checks (via IRasterBuilder.CanBuild) on data sources to identify candidate raster types and templates.

Specified by:

isTryQuickCheckOnly in interface IRasterTypeDataSourceHandlerParameters

Returns:

The pbTryQuickCheckOnly

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStopAtFirstFind

public void setStopAtFirstFind(boolean pbStopAtFirstFind)
                        throws java.io.IOException,
                               AutomationException

Indicates whether handler operations stops searching for candidate raster types or templates once the first candidate is found.

Specified by:

setStopAtFirstFind in interface IRasterTypeDataSourceHandlerParameters

Parameters:

pbStopAtFirstFind - The pbStopAtFirstFind (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isStopAtFirstFind

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

Indicates whether handler operations stops searching for candidate raster types or templates once the first candidate is found.

Specified by:

isStopAtFirstFind in interface IRasterTypeDataSourceHandlerParameters

Returns:

The pbStopAtFirstFind

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAllowAncillaryDatasets

public void setAllowAncillaryDatasets(boolean pbAllowAncillaryDatasets)
                               throws java.io.IOException,
                                      AutomationException

Indicates whether ancillary dataset generated by complex raster type item templates are to be allowed by handler operations.

Specified by:

setAllowAncillaryDatasets in interface IRasterTypeDataSourceHandlerParameters

Parameters:

pbAllowAncillaryDatasets - The pbAllowAncillaryDatasets (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAllowAncillaryDatasets

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

Indicates whether ancillary dataset generated by complex raster type item templates are to be allowed by handler operations.

Specified by:

isAllowAncillaryDatasets in interface IRasterTypeDataSourceHandlerParameters

Returns:

The pbAllowAncillaryDatasets

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRasterTypeParametersByRef

public void setRasterTypeParametersByRef(IPropertySet ppRasterTypeParameters)
                                  throws java.io.IOException,
                                         AutomationException

Override parameters injected into the raster types while contructing a function raster dataset from a data source.

Specified by:

setRasterTypeParametersByRef in interface IRasterTypeDataSourceHandlerParameters2

Parameters:

ppRasterTypeParameters - 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.

getRasterTypeParameters

public IPropertySet getRasterTypeParameters()
                                     throws java.io.IOException,
                                            AutomationException

Override parameters injected into the raster types while contructing a function raster dataset from a data source.

Specified by:

getRasterTypeParameters in interface IRasterTypeDataSourceHandlerParameters2

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.

setAllowBuilderItems

public void setAllowBuilderItems(boolean pbAllowBuilderItems)
                          throws java.io.IOException,
                                 AutomationException

Indicates whether sensor raster types are used in the attempt to load the data source.

Specified by:

setAllowBuilderItems in interface IRasterTypeDataSourceHandlerParameters2

Parameters:

pbAllowBuilderItems - The pbAllowBuilderItems (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAllowBuilderItems

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

Indicates whether sensor raster types are used in the attempt to load the data source.

Specified by:

isAllowBuilderItems in interface IRasterTypeDataSourceHandlerParameters2

Returns:

The pbAllowBuilderItems

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAllowRasterDatasets

public void setAllowRasterDatasets(boolean pbAllowRasterDatasets)
                            throws java.io.IOException,
                                   AutomationException

Indicates whether an attempt is made to load the data source as a non-sensor-dataset: i.e., a regular raster dataset, a mosaic dataset or a raster catalog item, a web service or image service item URL.

Specified by:

setAllowRasterDatasets in interface IRasterTypeDataSourceHandlerParameters2

Parameters:

pbAllowRasterDatasets - The pbAllowRasterDatasets (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAllowRasterDatasets

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

Indicates whether an attempt is made to load the data source as a non-sensor-dataset: i.e., a regular raster dataset, a mosaic dataset or a raster catalog item, a web service or image service item URL.

Specified by:

isAllowRasterDatasets in interface IRasterTypeDataSourceHandlerParameters2

Returns:

The pbAllowRasterDatasets

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAllowQuickOpen

public void setAllowQuickOpen(boolean pbAllowQuickOpen)
                       throws java.io.IOException,
                              AutomationException

Indicates whether an applicable data source (like a mosaic dataset item) loads with only basic information. Preventing it from connecting to pixel data (referenced by the underlying rasters in the function stack) can substantially improve performance of IRaste

Specified by:

setAllowQuickOpen in interface IRasterTypeDataSourceHandlerParameters2

Parameters:

pbAllowQuickOpen - The pbAllowQuickOpen (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAllowQuickOpen

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

Indicates whether an applicable data source (like a mosaic dataset item) loads with only basic information. Preventing it from connecting to pixel data (referenced by the underlying rasters in the function stack) can substantially improve performance of IRaste

Specified by:

isAllowQuickOpen in interface IRasterTypeDataSourceHandlerParameters2

Returns:

The pbAllowQuickOpen

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setActiveTemplate

public void setActiveTemplate(java.lang.String pbsActiveTemplate)
                       throws java.io.IOException,
                              AutomationException

The name of the active item template associated with the raster type used for building the specified data source. A raster type that doesn't contain the matching template is not considered candidate. All other templates are disabled when building the data sour

Specified by:

setActiveTemplate in interface IRasterTypeDataSourceHandlerParameters3

Parameters:

pbsActiveTemplate - The pbsActiveTemplate (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getActiveTemplate

public java.lang.String getActiveTemplate()
                                   throws java.io.IOException,
                                          AutomationException

The name of the active item template associated with the raster type used for building the specified data source. A raster type that doesn't contain the matching template is not considered candidate. All other templates are disabled when building the data sour

Specified by:

getActiveTemplate in interface IRasterTypeDataSourceHandlerParameters3

Returns:

The pbsActiveTemplate

Throws:

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

AutomationException - If the ArcObject component throws an exception.