com.esri.arcgis.datasourcesraster
Interface IRasterCatalogTable

All Superinterfaces:
Serializable
All Known Implementing Classes:
RasterCatalogTable, SdeRasterCatalogTable

public interface IRasterCatalogTable
extends Serializable

Provides access to members that control a raster catalog table.

Description

A raster catalog is a table in any supported table format (including INFO, dbf, access, text, and others) that contains a list of raster datasets and their geographic extents.

The first five columns of the table must be called "Image", "Xmin", "Ymin", "Xmax", and "YMax" for the table to be identified as a raster catalog. The first column contains the path to a dataset on disk, while the next four contain the bounding box of the dataset. Additional fields in the table are allowed but will have no effect on the display of the raster catalog.

Remarks

The IRasterCatalogTable object allows you to access information about a raster catalog including the extent and name for each dataset in the catalog and the number of datasets (Size) and Extent of the entire raster catalog.

You can also provide a table in the correct format to be used as the RasterCatalogTable (The counterpart for 8.x tyle ArcSDE raster catalog is SdeRasterCatalogTable). You must call the Update method after putting a table in the RasterCatalogTable.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void getFieldBoundsLocation(int[] pLocXmin, int[] pLocYmin, int[] pLocXmax, int[] pLocYMax)
          Bounds of the field location of the raster catalog.
 int getFieldNameLocation()
          Location of the field name of the raster catalog.
 int getOID(int idx)
          OID of the ith raster in the raster catalog.
 IRasterDataset getRasterDataset(int idx)
          Reference to the ith raster dataset in the raster catalog.
 IEnvelope getRasterExtent(int idx)
          Extent of the ith raster in the catalog.
 String getRasterName(int idx)
          Name of the ith raster in the raster catalog.
 int getSize()
          Number of rasters in the raster catalog.
 ITable getTable()
          The table object underlying the raster catalog table.
 String getWhereClause()
          A SQL expression limiting the list of rasters currently viewed.
 void setTableByRef(ITable ppTable)
          The table object underlying the raster catalog table.
 void setWhereClause(String whereClause)
          A SQL expression limiting the list of rasters currently viewed.
 void update()
          Updates the object after the table is changed.
 

Method Detail

getTable

ITable getTable()
                throws IOException,
                       AutomationException
The table object underlying the raster catalog table.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.geodatabase.ITable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTableByRef

void setTableByRef(ITable ppTable)
                   throws IOException,
                          AutomationException
The table object underlying the raster catalog table.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
ppTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

update

void update()
            throws IOException,
                   AutomationException
Updates the object after the table is changed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSize

int getSize()
            throws IOException,
                   AutomationException
Number of rasters in the raster catalog.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getRasterExtent

IEnvelope getRasterExtent(int idx)
                          throws IOException,
                                 AutomationException
Extent of the ith raster in the catalog.

Product Availability

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

Parameters:
idx - The idx (in)
Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRasterName

String getRasterName(int idx)
                     throws IOException,
                            AutomationException
Name of the ith raster in the raster catalog.

Product Availability

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

Parameters:
idx - The idx (in)
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRasterDataset

IRasterDataset getRasterDataset(int idx)
                                throws IOException,
                                       AutomationException
Reference to the ith raster dataset in the raster catalog.

Product Availability

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

Parameters:
idx - The idx (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IRasterDataset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFieldNameLocation

int getFieldNameLocation()
                         throws IOException,
                                AutomationException
Location of the field name of the raster catalog.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getFieldBoundsLocation

void getFieldBoundsLocation(int[] pLocXmin,
                            int[] pLocYmin,
                            int[] pLocXmax,
                            int[] pLocYMax)
                            throws IOException,
                                   AutomationException
Bounds of the field location of the raster catalog.

Product Availability

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

Parameters:
pLocXmin - The pLocXmin (out: use single element array)
pLocYmin - The pLocYmin (out: use single element array)
pLocXmax - The pLocXmax (out: use single element array)
pLocYMax - The pLocYMax (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setWhereClause

void setWhereClause(String whereClause)
                    throws IOException,
                           AutomationException
A SQL expression limiting the list of rasters currently viewed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getWhereClause

String getWhereClause()
                      throws IOException,
                             AutomationException
A SQL expression limiting the list of rasters currently viewed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getOID

int getOID(int idx)
           throws IOException,
                  AutomationException
OID of the ith raster in the raster catalog.

Product Availability

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

Parameters:
idx - The idx (in)
Returns:
The oID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.