com.esri.arcgis.datasourcesraster
Class RasterTypeEnvironment

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

All Implemented Interfaces:

IRasterTypeDataSourceHandler, IRasterTypeEnvironment, IRasterTypeEnvironment2, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class RasterTypeEnvironment
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterTypeEnvironment, IRasterTypeEnvironment2, IRasterTypeDataSourceHandler

The raster type environment.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

RasterTypeEnvironment()
Constructs a RasterTypeEnvironment using ArcGIS Engine.

RasterTypeEnvironment(Object obj)
Construct a RasterTypeEnvironment using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

IArray	canOpen(IRasterTypeDataSourceHandlerParameters pParameters) Indicates whether a valid raster type is available in the specified collection that's capable of opening the given data source and returns a collection of all such valid raster types.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
IStringArray	getRasterTypeNames() Names of all raster types installed on the system.
Date	getTimeStamp(String filePath) Returns a time stamp associated either with the present instance in time or with the optional file path.
int	hashCode() the hashcode for this object
IItemURI	loadItemURI(IMemoryBlobStream pBlob) Loads an item URI object from a blob.
IRasterType	loadRasterType(IMemoryBlobStream pBlob) Loads a raster type object from a blob.
IBuilderItem	open(IRasterTypeDataSourceHandlerParameters pParameters) Builds the specified data source using the specified raster types and returns the constructed function raster dataset.
void	querySupportedFilesInFolder(IRasterTypeDataSourceHandlerParameters pParameters, IStringArray[] ppSupportedFilePaths, IArray[] ppAssociatedRasterTypes) Searches the given folder path, non-recursively, for files that can be opened by the specified collection of raster types and returns an array of valid file paths.
String	replacePath(IStringArray pOldPaths, IStringArray pNewPaths, String inputPath) Replaces one or more parts of the specified input path using two arrays that map path values.
IMemoryBlobStream	saveItemURI(IItemURI pItemURI) Saves an item URI object to a blob.
IMemoryBlobStream	saveRasterType(IRasterType pRasterType) Saves a raster type object to a blob.
void	updateRasterTypeDefaults(IRasterType pRasterType, IMosaicDataset pMosaicDataset, IDataSourceCrawler pCrawler) Resets properties of the raster type based on an optional mosaic dataset and an optional data source crawler.

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

RasterTypeEnvironment

public RasterTypeEnvironment()
                      throws IOException,
                             UnknownHostException

Constructs a RasterTypeEnvironment using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

RasterTypeEnvironment

public RasterTypeEnvironment(Object obj)
                      throws IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems RasterTypeEnvironment theRasterTypeEnvironment = (RasterTypeEnvironment) 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

getRasterTypeNames

public IStringArray getRasterTypeNames()
                                throws IOException,
                                       AutomationException

Names of all raster types installed on the system.

Product Availability

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

Specified by:

getRasterTypeNames in interface IRasterTypeEnvironment

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadItemURI

public IItemURI loadItemURI(IMemoryBlobStream pBlob)
                     throws IOException,
                            AutomationException

Loads an item URI object from a blob.

Product Availability

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

Specified by:

loadItemURI in interface IRasterTypeEnvironment

Parameters:

pBlob - A reference to a com.esri.arcgis.system.IMemoryBlobStream (in)

Returns:

A reference to a com.esri.arcgis.datasourcesraster.IItemURI

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

saveItemURI

public IMemoryBlobStream saveItemURI(IItemURI pItemURI)
                              throws IOException,
                                     AutomationException

Saves an item URI object to a blob.

Product Availability

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

Specified by:

saveItemURI in interface IRasterTypeEnvironment

Parameters:

pItemURI - A reference to a com.esri.arcgis.datasourcesraster.IItemURI (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadRasterType

public IRasterType loadRasterType(IMemoryBlobStream pBlob)
                           throws IOException,
                                  AutomationException

Loads a raster type object from a blob.

Product Availability

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

Specified by:

loadRasterType in interface IRasterTypeEnvironment

Parameters:

pBlob - A reference to a com.esri.arcgis.system.IMemoryBlobStream (in)

Returns:

A reference to a com.esri.arcgis.datasourcesraster.IRasterType

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

saveRasterType

public IMemoryBlobStream saveRasterType(IRasterType pRasterType)
                                 throws IOException,
                                        AutomationException

Saves a raster type object to a blob.

Product Availability

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

Specified by:

saveRasterType in interface IRasterTypeEnvironment

Parameters:

pRasterType - A reference to a com.esri.arcgis.datasourcesraster.IRasterType (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeStamp

public Date getTimeStamp(String filePath)
                  throws IOException,
                         AutomationException

Returns a time stamp associated either with the present instance in time or with the optional file path.

Product Availability

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

Specified by:

getTimeStamp in interface IRasterTypeEnvironment

Parameters:

filePath - The filePath (in)

Returns:

The pTimeStamp

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

replacePath

public String replacePath(IStringArray pOldPaths,
                          IStringArray pNewPaths,
                          String inputPath)
                   throws IOException,
                          AutomationException

Replaces one or more parts of the specified input path using two arrays that map path values.

Product Availability

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

Specified by:

replacePath in interface IRasterTypeEnvironment

Parameters:

pOldPaths - A reference to a com.esri.arcgis.system.IStringArray (in)

pNewPaths - A reference to a com.esri.arcgis.system.IStringArray (in)

inputPath - The inputPath (in)

Returns:

The pOutputPath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateRasterTypeDefaults

public void updateRasterTypeDefaults(IRasterType pRasterType,
                                     IMosaicDataset pMosaicDataset,
                                     IDataSourceCrawler pCrawler)
                              throws IOException,
                                     AutomationException

Resets properties of the raster type based on an optional mosaic dataset and an optional data source crawler.

Product Availability

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

Specified by:

updateRasterTypeDefaults in interface IRasterTypeEnvironment2

Parameters:

pRasterType - A reference to a com.esri.arcgis.datasourcesraster.IRasterType (in)

pMosaicDataset - A reference to a com.esri.arcgis.datasourcesraster.IMosaicDataset (in)

pCrawler - A reference to a com.esri.arcgis.datasourcesraster.IDataSourceCrawler (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canOpen

public IArray canOpen(IRasterTypeDataSourceHandlerParameters pParameters)
               throws IOException,
                      AutomationException

Indicates whether a valid raster type is available in the specified collection that's capable of opening the given data source and returns a collection of all such valid raster types. This method uses RasterTypeEnvironment.GlobalSensorRasterTypes collection if????&

Product Availability

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

Specified by:

canOpen in interface IRasterTypeDataSourceHandler

Parameters:

pParameters - A reference to a com.esri.arcgis.datasourcesraster.IRasterTypeDataSourceHandlerParameters (in)

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.

querySupportedFilesInFolder

public void querySupportedFilesInFolder(IRasterTypeDataSourceHandlerParameters pParameters,
                                        IStringArray[] ppSupportedFilePaths,
                                        IArray[] ppAssociatedRasterTypes)
                                 throws IOException,
                                        AutomationException

Searches the given folder path, non-recursively, for files that can be opened by the specified collection of raster types and returns an array of valid file paths. This method uses RasterTypeEnvironment.GlobalSensorRasterTypes collection if no input raster typ????&

Product Availability

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

Specified by:

querySupportedFilesInFolder in interface IRasterTypeDataSourceHandler

Parameters:

pParameters - A reference to a com.esri.arcgis.datasourcesraster.IRasterTypeDataSourceHandlerParameters (in)

ppSupportedFilePaths - A reference to a com.esri.arcgis.system.IStringArray (out: use single element array)

ppAssociatedRasterTypes - A reference to a com.esri.arcgis.system.IArray (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

open

public IBuilderItem open(IRasterTypeDataSourceHandlerParameters pParameters)
                  throws IOException,
                         AutomationException

Builds the specified data source using the specified raster types and returns the constructed function raster dataset. This method uses RasterTypeEnvironment.GlobalSensorRasterTypes collection if no input raster type array is supplied.

Product Availability

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

Specified by:

open in interface IRasterTypeDataSourceHandler

Parameters:

pParameters - A reference to a com.esri.arcgis.datasourcesraster.IRasterTypeDataSourceHandlerParameters (in)

Returns:

A reference to a com.esri.arcgis.datasourcesraster.IBuilderItem

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.