com.esri.arcgis.datasourcesraster
Class RasterTypeDataSourceHandlerParameters

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

All Implemented Interfaces:

IRasterTypeDataSourceHandlerParameters, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class RasterTypeDataSourceHandlerParameters
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterTypeDataSourceHandlerParameters

Parameters that control raster type data source handler operations.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

RasterTypeDataSourceHandlerParameters()
Constructs a RasterTypeDataSourceHandlerParameters using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
Object	getDataSource() The data source to be supplied to handler operations.
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	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	setAllowAncillaryDatasets(boolean pbAllowAncillaryDatasets) Indicates whether ancillary dataset generated by complex raster type item templates are to be allowed by handler operations.
void	setDataSource(Object pvtDataSource) The data source to be supplied to handler operations.
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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

RasterTypeDataSourceHandlerParameters

public RasterTypeDataSourceHandlerParameters()
                                      throws IOException,
                                             UnknownHostException

Constructs a RasterTypeDataSourceHandlerParameters using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

RasterTypeDataSourceHandlerParameters

public RasterTypeDataSourceHandlerParameters(Object obj)
                                      throws 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:

IOException - if there are interop problems

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

setDataSource

public void setDataSource(Object pvtDataSource)
                   throws IOException,
                          AutomationException

The data source to be supplied to handler operations.

Product Availability

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

Specified by:

setDataSource in interface IRasterTypeDataSourceHandlerParameters

Parameters:

pvtDataSource - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataSource

public Object getDataSource()
                     throws IOException,
                            AutomationException

The data source to be supplied to handler operations.

Product Availability

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

Specified by:

getDataSource in interface IRasterTypeDataSourceHandlerParameters

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRasterTypesByRef

public void setRasterTypesByRef(IArray ppRasterTypes)
                         throws IOException,
                                AutomationException

The collection of raster types on which the handler operates.

Product Availability

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

Specified by:

setRasterTypesByRef in interface IRasterTypeDataSourceHandlerParameters

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRasterTypes

public IArray getRasterTypes()
                      throws IOException,
                             AutomationException

The collection of raster types on which the handler operates.

Product Availability

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

Specified by:

getRasterTypes in interface IRasterTypeDataSourceHandlerParameters

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTrackCancelByRef

public void setTrackCancelByRef(ITrackCancel ppTrackCancel)
                         throws IOException,
                                AutomationException

The cancel tracker associated with handler operations.

Product Availability

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

Specified by:

setTrackCancelByRef in interface IRasterTypeDataSourceHandlerParameters

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTrackCancel

public ITrackCancel getTrackCancel()
                            throws IOException,
                                   AutomationException

The cancel tracker associated with handler operations.

Product Availability

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

Specified by:

getTrackCancel in interface IRasterTypeDataSourceHandlerParameters

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTryQuickCheckOnly

public void setTryQuickCheckOnly(boolean pbTryQuickCheckOnly)
                          throws IOException,
                                 AutomationException

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

Product Availability

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

Specified by:

setTryQuickCheckOnly in interface IRasterTypeDataSourceHandlerParameters

Parameters:

pbTryQuickCheckOnly - The pbTryQuickCheckOnly (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTryQuickCheckOnly

public boolean isTryQuickCheckOnly()
                            throws IOException,
                                   AutomationException

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

Product Availability

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

Specified by:

isTryQuickCheckOnly in interface IRasterTypeDataSourceHandlerParameters

Returns:

The pbTryQuickCheckOnly

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStopAtFirstFind

public void setStopAtFirstFind(boolean pbStopAtFirstFind)
                        throws IOException,
                               AutomationException

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

Product Availability

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

Specified by:

setStopAtFirstFind in interface IRasterTypeDataSourceHandlerParameters

Parameters:

pbStopAtFirstFind - The pbStopAtFirstFind (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isStopAtFirstFind

public boolean isStopAtFirstFind()
                          throws IOException,
                                 AutomationException

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

Product Availability

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

Specified by:

isStopAtFirstFind in interface IRasterTypeDataSourceHandlerParameters

Returns:

The pbStopAtFirstFind

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAllowAncillaryDatasets

public void setAllowAncillaryDatasets(boolean pbAllowAncillaryDatasets)
                               throws IOException,
                                      AutomationException

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

Product Availability

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

Specified by:

setAllowAncillaryDatasets in interface IRasterTypeDataSourceHandlerParameters

Parameters:

pbAllowAncillaryDatasets - The pbAllowAncillaryDatasets (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAllowAncillaryDatasets

public boolean isAllowAncillaryDatasets()
                                 throws IOException,
                                        AutomationException

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

Product Availability

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

Specified by:

isAllowAncillaryDatasets in interface IRasterTypeDataSourceHandlerParameters

Returns:

The pbAllowAncillaryDatasets

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.