com.esri.arcgis.datasourcesraster
Interface IRasterCatalogLoader

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
IRasterCatalogLoaderProxy, RasterCatalogLoader

public interface IRasterCatalogLoader
extends java.io.Serializable

COM Interface 'IRasterCatalogLoader'. Generated 3/19/2015 1:20:54 PM from 'C:\ArcGIS\COM\esriDataSourcesRaster.olb'

Description: 'Provides access to members that control rastercatalog loading.' 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 =


Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IIDc285b597_951b_4763_bb62_a7e2074fbac5
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 java.lang.Object getBackground()
          The background value to filtered.
 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.
 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.
 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 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.
 

Field Detail

IIDc285b597_951b_4763_bb62_a7e2074fbac5

static final int IIDc285b597_951b_4763_bb62_a7e2074fbac5
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

getConnectionProperties

IPropertySet getConnectionProperties()
                                     throws java.io.IOException,
                                            AutomationException
The GeoDatabase connection properties.

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

void setConnectionPropertiesByRef(IPropertySet ppConnectionProperties)
                                  throws java.io.IOException,
                                         AutomationException
The GeoDatabase connection properties.

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

IWorkspace getWorkspace()
                        throws java.io.IOException,
                               AutomationException
The GeoDatabase workspace.

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

void setWorkspaceByRef(IWorkspace pWorkspace)
                       throws java.io.IOException,
                              AutomationException
The GeoDatabase workspace.

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

java.lang.Object getBackground()
                               throws java.io.IOException,
                                      AutomationException
The background value to filtered.

Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBackground

void setBackground(java.lang.Object background)
                   throws java.io.IOException,
                          AutomationException
The background value to filtered.

Parameters:
background - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getForeground

java.lang.Object getForeground()
                               throws java.io.IOException,
                                      AutomationException
The foreground value for 1-Bit images.

Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setForeground

void setForeground(java.lang.Object foreground)
                   throws java.io.IOException,
                          AutomationException
The foreground value for 1-Bit images.

Parameters:
foreground - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStorageDef

IRasterStorageDef getStorageDef()
                                throws java.io.IOException,
                                       AutomationException
The GeoDatabase storage definition.

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

void setStorageDefByRef(IRasterStorageDef ppStorageDef)
                        throws java.io.IOException,
                               AutomationException
The GeoDatabase storage definition.

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

boolean isTransformed()
                      throws java.io.IOException,
                             AutomationException
Indicates if datasets are to be transformed on loading.

Returns:
The xformed
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTransformed

void setTransformed(boolean xformed)
                    throws java.io.IOException,
                           AutomationException
Indicates if datasets are to be transformed on loading.

Parameters:
xformed - The xformed (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isProjected

boolean isProjected()
                    throws java.io.IOException,
                           AutomationException
Indicates if datasets are to be reprojected on loading.

Returns:
The projected
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setProjected

void setProjected(boolean projected)
                  throws java.io.IOException,
                         AutomationException
Indicates if datasets are to be reprojected on loading.

Parameters:
projected - The projected (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEnableBuildStatistics

boolean isEnableBuildStatistics()
                                throws java.io.IOException,
                                       AutomationException
Indicates if statistics should be built on loading.

Returns:
The pEnableBuildStats
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEnableBuildStatistics

void setEnableBuildStatistics(boolean pEnableBuildStats)
                              throws java.io.IOException,
                                     AutomationException
Indicates if statistics should be built on loading.

Parameters:
pEnableBuildStats - The pEnableBuildStats (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getXSkipFactor

int getXSkipFactor()
                   throws java.io.IOException,
                          AutomationException
The X skip factor for statistics.

Returns:
The xSkipFactor
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setXSkipFactor

void setXSkipFactor(int xSkipFactor)
                    throws java.io.IOException,
                           AutomationException
The X skip factor for statistics.

Parameters:
xSkipFactor - The xSkipFactor (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getYSkipFactor

int getYSkipFactor()
                   throws java.io.IOException,
                          AutomationException
The Y skip factor for statistics.

Returns:
The ySkipFactor
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setYSkipFactor

void setYSkipFactor(int ySkipFactor)
                    throws java.io.IOException,
                           AutomationException
The Y skip factor for statistics.

Parameters:
ySkipFactor - The ySkipFactor (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getIgnoreValues

java.lang.Object getIgnoreValues()
                                 throws java.io.IOException,
                                        AutomationException
The ignore values for statistics.

Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIgnoreValues

void setIgnoreValues(java.lang.Object vIgnoreValues)
                     throws java.io.IOException,
                            AutomationException
The ignore values for statistics.

Parameters:
vIgnoreValues - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

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.

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

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.

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

IErrorInfo getLastError()
                        throws java.io.IOException,
                               AutomationException
The last loading error.

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

java.lang.String getInvalidDatasets()
                                    throws java.io.IOException,
                                           AutomationException
The current list of newline delimited failed dataset names.

Returns:
The pInvalidDatasetNames
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLastLoadedDataset

java.lang.String getLastLoadedDataset()
                                      throws java.io.IOException,
                                             AutomationException
The last loaded dataset name.

Returns:
The pDatasetName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.