com.esri.arcgis.datasourcesraster

Class RasterTypeEnvironment

java.lang.Object

com.esri.arcgis.datasourcesraster.RasterTypeEnvironment

All Implemented Interfaces:

IRasterTypeDataSourceHandler, IRasterTypeDataSourceHandler2, IRasterTypeDataSourceHandler3, IRasterTypeEnvironment, IRasterTypeEnvironment2, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

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

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

Description 'The raster type environment.' 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.IRasterTypeEnvironment2

IID, IIDfbefe2cd_7605_48b6_9663_e0588776e120, xxDummy

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

IID3eca95bb_3dd3_4f8b_8bb0_cb47071c456b

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

IID, IIDa62ce1ba_e195_4397_9658_a73f2b761dbc, xxDummy

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

IIDd14b8350_b7ce_4f80_b61d_5e93fa4adbdb

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

IIDca1d1ab9_63cc_40e6_ac24_5a69d2bbde4d

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
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(java.lang.Object o) Compare this object with another
static java.lang.String	getClsid() getClsid.
IObjectMemoizer	getDataSourceMemoizer() The object memoizer associated with the data source handler that's capable of caching datasets and workspaces.
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.
IStringArray	getRasterTypeNames() Names of all raster types installed on the system.
java.util.Date	getTimeStamp(java.lang.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.
IArray	openEx(IRasterTypeDataSourceHandlerParameters pParameters) Opens the specified data source as a raster dataset or builds it using the specified raster types and returns the set of constructed IRasterDataset and/or IBuilderItem objects depending on the values of IRasterTypeDataSourceHandlerParameters.AllowRasterDataset
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.
void	release() Release this COM object reference
java.lang.String	replacePath(IStringArray pOldPaths, IStringArray pNewPaths, java.lang.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	setDataSourceMemoizerByRef(IObjectMemoizer pDataSourceMemoizer) The object memoizer associated with the data source handler that's capable of caching datasets and workspaces.
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

Constructor Detail

RasterTypeEnvironment

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

Constructs a RasterTypeEnvironment using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

RasterTypeEnvironment

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

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

getRasterTypeNames

public IStringArray getRasterTypeNames()
                                throws java.io.IOException,
                                       AutomationException

Names of all raster types installed on the system.

Specified by:

getRasterTypeNames in interface IRasterTypeEnvironment

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

loadItemURI

public IItemURI loadItemURI(IMemoryBlobStream pBlob)
                     throws java.io.IOException,
                            AutomationException

Loads an item URI object from a blob.

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:

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

AutomationException - If the ArcObject component throws an exception.

saveItemURI

public IMemoryBlobStream saveItemURI(IItemURI pItemURI)
                              throws java.io.IOException,
                                     AutomationException

Saves an item URI object to a blob.

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:

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

AutomationException - If the ArcObject component throws an exception.

loadRasterType

public IRasterType loadRasterType(IMemoryBlobStream pBlob)
                           throws java.io.IOException,
                                  AutomationException

Loads a raster type object from a blob.

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:

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

AutomationException - If the ArcObject component throws an exception.

saveRasterType

public IMemoryBlobStream saveRasterType(IRasterType pRasterType)
                                 throws java.io.IOException,
                                        AutomationException

Saves a raster type object to a blob.

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:

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

AutomationException - If the ArcObject component throws an exception.

getTimeStamp

public java.util.Date getTimeStamp(java.lang.String filePath)
                            throws java.io.IOException,
                                   AutomationException

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

Specified by:

getTimeStamp in interface IRasterTypeEnvironment

Parameters:

filePath - The filePath (in)

Returns:

The pTimeStamp

Throws:

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

AutomationException - If the ArcObject component throws an exception.

replacePath

public java.lang.String replacePath(IStringArray pOldPaths,
                                    IStringArray pNewPaths,
                                    java.lang.String inputPath)
                             throws java.io.IOException,
                                    AutomationException

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

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:

java.io.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 java.io.IOException,
                                     AutomationException

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

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:

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

AutomationException - If the ArcObject component throws an exception.

canOpen

public IArray canOpen(IRasterTypeDataSourceHandlerParameters pParameters)
               throws java.io.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 all sensor raster types if IRasterTypeDataSourceHandlerPara

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:

java.io.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 java.io.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 all sensor raster types if IRasterTypeDataSourceHandlerParameters.AllowBuilderI

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:

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

AutomationException - If the ArcObject component throws an exception.

open

public IBuilderItem open(IRasterTypeDataSourceHandlerParameters pParameters)
                  throws java.io.IOException,
                         AutomationException

Builds the specified data source using the specified raster types and returns the constructed function raster dataset. This method uses all sensor raster types if no input raster type array is supplied. The method will set IRasterTypeDataSourceHandlerParameter

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:

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

AutomationException - If the ArcObject component throws an exception.

openEx

public IArray openEx(IRasterTypeDataSourceHandlerParameters pParameters)
              throws java.io.IOException,
                     AutomationException

Opens the specified data source as a raster dataset or builds it using the specified raster types and returns the set of constructed IRasterDataset and/or IBuilderItem objects depending on the values of IRasterTypeDataSourceHandlerParameters.AllowRasterDataset

Specified by:

openEx in interface IRasterTypeDataSourceHandler2

Parameters:

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

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.

setDataSourceMemoizerByRef

public void setDataSourceMemoizerByRef(IObjectMemoizer pDataSourceMemoizer)
                                throws java.io.IOException,
                                       AutomationException

The object memoizer associated with the data source handler that's capable of caching datasets and workspaces.

Specified by:

setDataSourceMemoizerByRef in interface IRasterTypeDataSourceHandler3

Parameters:

pDataSourceMemoizer - A reference to a com.esri.arcgis.datasourcesraster.IObjectMemoizer (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDataSourceMemoizer

public IObjectMemoizer getDataSourceMemoizer()
                                      throws java.io.IOException,
                                             AutomationException

The object memoizer associated with the data source handler that's capable of caching datasets and workspaces.

Specified by:

getDataSourceMemoizer in interface IRasterTypeDataSourceHandler3

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.