com.esri.arcgis.datasourcesraster

Class RasterCatalogLoader

java.lang.Object

com.esri.arcgis.datasourcesraster.RasterCatalogLoader

All Implemented Interfaces:

IRasterCatalogLoader, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, java.io.Serializable

public class RasterCatalogLoader
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterCatalogLoader, ISupportErrorInfo

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

Description 'A raster catalog loader class.' 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.IRasterCatalogLoader

IID, IIDc285b597_951b_4763_bb62_a7e2074fbac5, xxDummy

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Compare this object with another
java.lang.Object	getBackground() The background value to filtered.
static java.lang.String	getClsid() getClsid.
IPropertySet	getConnectionProperties() The GeoDatabase connection properties.
java.lang.Object	getForeground() The foreground value for 1-Bit images.
java.lang.Object	getIgnoreValues() The ignore values for statistics.
java.lang.String	getInvalidDatasets() The current list of newline delimited failed dataset names.
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.
IErrorInfo	getLastError() The last loading error.
java.lang.String	getLastLoadedDataset() The last loaded dataset name.
IRasterStorageDef	getStorageDef() The GeoDatabase storage definition.
IWorkspace	getWorkspace() The GeoDatabase workspace.
int	getXSkipFactor() The X skip factor for statistics.
int	getYSkipFactor() The Y skip factor for statistics.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isEnableBuildStatistics() Indicates if statistics should be built on loading.
boolean	isProjected() Indicates if datasets are to be reprojected on loading.
boolean	isTransformed() Indicates if datasets are to be transformed on loading.
void	load(java.lang.String catalog, java.lang.String directory, ITrackCancel pCancelTracker) Loads all raster datasets in a given directory into a raster catalog.
void	loadDatasets(java.lang.String catalog, java.lang.String namelist, ITrackCancel pCancelTracker) Loads all raster datasets in a given name list file into a raster catalog.
void	release() Release this COM object reference
void	setBackground(java.lang.Object background) The background value to filtered.
void	setConnectionPropertiesByRef(IPropertySet ppConnectionProperties) The GeoDatabase connection properties.
void	setEnableBuildStatistics(boolean pEnableBuildStats) Indicates if statistics should be built on loading.
void	setForeground(java.lang.Object foreground) The foreground value for 1-Bit images.
void	setIgnoreValues(java.lang.Object vIgnoreValues) The ignore values for statistics.
void	setProjected(boolean projected) Indicates if datasets are to be reprojected on loading.
void	setStorageDefByRef(IRasterStorageDef ppStorageDef) The GeoDatabase storage definition.
void	setTransformed(boolean xformed) Indicates if datasets are to be transformed on loading.
void	setWorkspaceByRef(IWorkspace pWorkspace) The GeoDatabase workspace.
void	setXSkipFactor(int xSkipFactor) The X skip factor for statistics.
void	setYSkipFactor(int ySkipFactor) The Y skip factor for statistics.

Methods inherited from class java.lang.Object

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

Constructor Detail

RasterCatalogLoader

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

Constructs a RasterCatalogLoader using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

RasterCatalogLoader

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

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

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

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

getConnectionProperties

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

The GeoDatabase connection properties.

Specified by:

getConnectionProperties in interface IRasterCatalogLoader

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.

setConnectionPropertiesByRef

public void setConnectionPropertiesByRef(IPropertySet ppConnectionProperties)
                                  throws java.io.IOException,
                                         AutomationException

The GeoDatabase connection properties.

Specified by:

setConnectionPropertiesByRef in interface IRasterCatalogLoader

Parameters:

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

getWorkspace

public IWorkspace getWorkspace()
                        throws java.io.IOException,
                               AutomationException

The GeoDatabase workspace.

Specified by:

getWorkspace in interface IRasterCatalogLoader

Returns:

A reference to a com.esri.arcgis.geodatabase.IWorkspace

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setWorkspaceByRef

public void setWorkspaceByRef(IWorkspace pWorkspace)
                       throws java.io.IOException,
                              AutomationException

The GeoDatabase workspace.

Specified by:

setWorkspaceByRef in interface IRasterCatalogLoader

Parameters:

pWorkspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBackground

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

The background value to filtered.

Specified by:

getBackground in interface IRasterCatalogLoader

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBackground

public void setBackground(java.lang.Object background)
                   throws java.io.IOException,
                          AutomationException

The background value to filtered.

Specified by:

setBackground in interface IRasterCatalogLoader

Parameters:

background - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getForeground

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

The foreground value for 1-Bit images.

Specified by:

getForeground in interface IRasterCatalogLoader

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setForeground

public void setForeground(java.lang.Object foreground)
                   throws java.io.IOException,
                          AutomationException

The foreground value for 1-Bit images.

Specified by:

setForeground in interface IRasterCatalogLoader

Parameters:

foreground - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStorageDef

public IRasterStorageDef getStorageDef()
                                throws java.io.IOException,
                                       AutomationException

The GeoDatabase storage definition.

Specified by:

getStorageDef in interface IRasterCatalogLoader

Returns:

A reference to a com.esri.arcgis.geodatabase.IRasterStorageDef

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStorageDefByRef

public void setStorageDefByRef(IRasterStorageDef ppStorageDef)
                        throws java.io.IOException,
                               AutomationException

The GeoDatabase storage definition.

Specified by:

setStorageDefByRef in interface IRasterCatalogLoader

Parameters:

ppStorageDef - A reference to a com.esri.arcgis.geodatabase.IRasterStorageDef (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isTransformed

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

Indicates if datasets are to be transformed on loading.

Specified by:

isTransformed in interface IRasterCatalogLoader

Returns:

The xformed

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTransformed

public void setTransformed(boolean xformed)
                    throws java.io.IOException,
                           AutomationException

Indicates if datasets are to be transformed on loading.

Specified by:

setTransformed in interface IRasterCatalogLoader

Parameters:

xformed - The xformed (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isProjected

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

Indicates if datasets are to be reprojected on loading.

Specified by:

isProjected in interface IRasterCatalogLoader

Returns:

The projected

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setProjected

public void setProjected(boolean projected)
                  throws java.io.IOException,
                         AutomationException

Indicates if datasets are to be reprojected on loading.

Specified by:

setProjected in interface IRasterCatalogLoader

Parameters:

projected - The projected (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEnableBuildStatistics

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

Indicates if statistics should be built on loading.

Specified by:

isEnableBuildStatistics in interface IRasterCatalogLoader

Returns:

The pEnableBuildStats

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setEnableBuildStatistics

public void setEnableBuildStatistics(boolean pEnableBuildStats)
                              throws java.io.IOException,
                                     AutomationException

Indicates if statistics should be built on loading.

Specified by:

setEnableBuildStatistics in interface IRasterCatalogLoader

Parameters:

pEnableBuildStats - The pEnableBuildStats (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getXSkipFactor

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

The X skip factor for statistics.

Specified by:

getXSkipFactor in interface IRasterCatalogLoader

Returns:

The xSkipFactor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setXSkipFactor

public void setXSkipFactor(int xSkipFactor)
                    throws java.io.IOException,
                           AutomationException

The X skip factor for statistics.

Specified by:

setXSkipFactor in interface IRasterCatalogLoader

Parameters:

xSkipFactor - The xSkipFactor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getYSkipFactor

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

The Y skip factor for statistics.

Specified by:

getYSkipFactor in interface IRasterCatalogLoader

Returns:

The ySkipFactor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setYSkipFactor

public void setYSkipFactor(int ySkipFactor)
                    throws java.io.IOException,
                           AutomationException

The Y skip factor for statistics.

Specified by:

setYSkipFactor in interface IRasterCatalogLoader

Parameters:

ySkipFactor - The ySkipFactor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getIgnoreValues

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

The ignore values for statistics.

Specified by:

getIgnoreValues in interface IRasterCatalogLoader

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIgnoreValues

public void setIgnoreValues(java.lang.Object vIgnoreValues)
                     throws java.io.IOException,
                            AutomationException

The ignore values for statistics.

Specified by:

setIgnoreValues in interface IRasterCatalogLoader

Parameters:

vIgnoreValues - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(java.lang.String catalog,
                 java.lang.String directory,
                 ITrackCancel pCancelTracker)
          throws java.io.IOException,
                 AutomationException

Loads all raster datasets in a given directory into a raster catalog.

Specified by:

load in interface IRasterCatalogLoader

Parameters:

catalog - The catalog (in)

directory - The directory (in)

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

loadDatasets

public void loadDatasets(java.lang.String catalog,
                         java.lang.String namelist,
                         ITrackCancel pCancelTracker)
                  throws java.io.IOException,
                         AutomationException

Loads all raster datasets in a given name list file into a raster catalog.

Specified by:

loadDatasets in interface IRasterCatalogLoader

Parameters:

catalog - The catalog (in)

namelist - The namelist (in)

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

getLastError

public IErrorInfo getLastError()
                        throws java.io.IOException,
                               AutomationException

The last loading error.

Specified by:

getLastError in interface IRasterCatalogLoader

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getInvalidDatasets

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

The current list of newline delimited failed dataset names.

Specified by:

getInvalidDatasets in interface IRasterCatalogLoader

Returns:

The pInvalidDatasetNames

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLastLoadedDataset

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

The last loaded dataset name.

Specified by:

getLastLoadedDataset in interface IRasterCatalogLoader

Returns:

The pDatasetName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.