com.esri.arcgis.datasourcesnetCDF
Class NetCDFRasterBand

java.lang.Object
  com.esri.arcgis.datasourcesnetCDF.NetCDFRasterBand

All Implemented Interfaces:

IClass, IDataset, IGeoDataset, INativeTypeInfo, INetCDFRasterBand, IObjectClass, IRasterBand, IRasterDataset, IRasterProps, IRasterTable, IRawPixels, ITable, java.io.Serializable

public class NetCDFRasterBand

extends java.lang.Object

implements IRasterBand, INativeTypeInfo, IRasterProps, IDataset, ITable, IObjectClass, IGeoDataset, IRasterDataset, IRasterTable, IRawPixels, INetCDFRasterBand

A representation of a single band of a NetCDF raster dataset on disk.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

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

Method Summary

java.lang.Object	acquireCache() Gets reference to edit cache.
void	addField(IField field) Adds a field to this object class.
void	addIndex(IIndex index) Adds an index to this object class.
boolean	canCopy() Returns true if this dataset can be copied.
boolean	canDelete() True if this dataset can be deleted.
boolean	canRename() True if this dataset can be renamed.
void	computeStatsAndHist() Calculates statistics and histogram if not previously stored.
IDataset	copy(java.lang.String copyName, IWorkspace copyWorkspace) Copies this raster band to a new dataset with the specified name.
IRaster	createDefaultRaster() Creates a raster object with the default properties for this dataset.
IPixelBlock	createPixelBlock(IPnt size) Allocates a PixelBlock of size requested and type of this band.
IRow	createRow() Creates a row in the database with a system assigned object ID and null property values.
IRowBuffer	createRowBuffer() Creates a row buffer that can be used with an insert cursor.
void	delete() Deletes this dataset.
void	deleteField(IField field) Deletes a field from this object class.
void	deleteIndex(IIndex index) Deletes an index from this object class.
void	deleteSearchedRows(IQueryFilter queryFilter) Delete the Rows in the database selected by the specified query.
boolean	equals(java.lang.Object o) Compare this object with another
int	findField(java.lang.String name) The index of the field with the specified name.
java.lang.String	getAliasName() The alias name of the object class.
IDataset	getAsIDataset() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IGeoDataset	getAsIGeoDataset() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
INativeTypeInfo	getAsINativeTypeInfo() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
INetCDFRasterBand	getAsINetCDFRasterBand() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IObjectClass	getAsIObjectClass() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IRasterBand	getAsIRasterBand() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IRasterDataset	getAsIRasterDataset() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IRasterProps	getAsIRasterProps() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IRasterTable	getAsIRasterTable() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IRawPixels	getAsIRawPixels() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ITable	getAsITable() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ITable	getAttributeTable() The attribute table of this raster band.
java.lang.String	getBandname() The name of this raster band.
java.lang.String	getBrowseName() The browse name of the dataset.
java.lang.String	getCategory() The category of the dataset.
IUID	getCLSID() The GUID for the COM Class (CoClass) corresponding to instances of this object class.
IRasterColormap	getColormap() The colormap of this raster band.
java.lang.String	getCompleteName() The full path of the RasterDataset.
java.lang.String	getCompressionType() The compression technique applied to this RasterDataset.
IContrastTable	getContrastTable() The contrast look-up table of this band.
IUID	getEXTCLSID() The GUID for the COM Class (CoClass) corresponding to the class extension for this object class.
java.lang.Object	getExtension() The extension for this object class.
IPropertySet	getExtensionProperties() The extension properties for this object class.
IEnvelope	getExtent() The extent of the Raster.
IFields	getFields() The fields collection for this object class.
java.lang.String	getFormat() The format of this RasterRataset.
IName	getFullName() The associated name object.
int	getHeight() Height in pixels.
IRasterHistogram	getHistogram() The histogram of this raster band.
IIndexes	getIndexes() The indexes collection for this object class.
java.lang.String	getName() The name of the Dataset.
INativeType	getNativeType() The native type.
java.lang.Object	getNoDataValue() Data value used to indicate invalid or excluded data.
int	getNumCacheRefs() Number of outstanding cache references
int	getObjectClassID() The unique ID for the object class.
java.lang.String	getOIDFieldName() The name of the field corresponding to the OID.
int	getPixelType() Data type of the pixels.
int	getPrimaryField() The primary field of the table.
IPropertySet	getPropertySet() The set of properties for the dataset.
IRasterDataset	getRasterDataset() The RasterDataset associated with this raster band.
IEnumRelationshipClass	getRelationshipClasses(int role) The relationship classes in which this object class participates in for the specified role.
IRow	getRow(int oID) The row from the database with the specified object ID.
ICursor	getRows(java.lang.Object oids, boolean recycling) The cursor of rows based on a set of object ids.
java.lang.String	getSensorType() The sensor type used for this RasterDataset.
ISpatialReference	getSpatialReference() SpatialReference of the Raster.
IRasterStatistics	getStatistics() The statistics of this raster band.
IEnumDataset	getSubsets() Datasets contained within this dataset.
int	getTableType() The class names of the table.
int	getType() The type of the Dataset.
int	getWidth() Width in pixels.
IWorkspace	getWorkspace() The workspace containing this dataset.
void	hasColormap(boolean[] b) Indicates if this band has a colormap.
int	hashCode() the hashcode for this object
void	hasStatistics(boolean[] b) Indicates if this band has statistics.
void	hasTable(boolean[] b) Indicates if this band has an attribute table.
ICursor	insert(boolean useBuffering) Returns a cursor that can be used to insert new Rows.
boolean	isDirectlyOpened() Indicates if the band was opened directly.
boolean	isHasOID() Indicates if the class has an object identity (OID) field.
boolean	isInteger() Indicates if the data is integer.
ICursor	ITable_search(IQueryFilter queryFilter, boolean recycling) An object cursor that can be used to fetch row objects selected by the specified query.
IPnt	meanCellSize() Returns the approximate cell size of the raster.
void	precalculateStats(java.lang.Object index_list) Calculates statistics and histograms for specified bands.
void	read(IPnt tlc, IPixelBlock pxls) Read a block of pixels starting from tlc (top left corner).
void	rename(java.lang.String name) Renames this Dataset.
int	returnCache(java.lang.Object cache) Restores edit cache to previous state.
int	rowCount(IQueryFilter queryFilter) The number of Rows selected by the specified query.
ISelectionSet	select(IQueryFilter queryFilter, int selType, int selOption, IWorkspace selectionContainer) A selection that contains the object ids selected by the specified query.
void	setBrowseName(java.lang.String name) The browse name of the dataset.
void	setContrastTable(IContrastTable cont) The contrast look-up table of this band.
void	setExtent(IEnvelope ppExtent) The extent of the Raster.
void	setHeight(int pVal) Height in pixels.
void	setNoDataValue(java.lang.Object pVal) Data value used to indicate invalid or excluded data.
void	setPixelType(int pVal) Data type of the pixels.
void	setPrimaryField(int fieldIndex) The primary field of the table.
void	setSpatialReference(ISpatialReference ppSpref) SpatialReference of the Raster.
void	setWidth(int pVal) Width in pixels.
ICursor	update(IQueryFilter queryFilter, boolean recycling) Returns a cursor that can be used to update Rows selected by the specified query.
void	updateSearchedRows(IQueryFilter queryFilter, IRowBuffer buffer) Update the Rows in the database selected by the specified query.
void	write(IPnt tlc, IPixelBlock pxls) Write a block of pixels starting from tlc (top left corner).

Methods inherited from class java.lang.Object

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

Constructor Detail

NetCDFRasterBand

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

Construct a NetCDFRasterBand using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to NetCDFRasterBand.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
NetCDFRasterBand o = (NetCDFRasterBand)obj; // will not work

NetCDFRasterBand o = new NetCDFRasterBand(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server NetCDFRasterBand theNetCDFRasterBand = (NetCDFRasterBand) obj;

Throws:

java.io.IOException - if there are interop problems

Method Detail

getAsIRasterBand

public IRasterBand getAsIRasterBand()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsINativeTypeInfo

public INativeTypeInfo getAsINativeTypeInfo()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIRasterProps

public IRasterProps getAsIRasterProps()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIDataset

public IDataset getAsIDataset()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsITable

public ITable getAsITable()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIObjectClass

public IObjectClass getAsIObjectClass()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIGeoDataset

public IGeoDataset getAsIGeoDataset()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIRasterDataset

public IRasterDataset getAsIRasterDataset()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIRasterTable

public IRasterTable getAsIRasterTable()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIRawPixels

public IRawPixels getAsIRawPixels()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsINetCDFRasterBand

public INetCDFRasterBand getAsINetCDFRasterBand()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

hasTable

public void hasTable(boolean[] b)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IRasterBand

Indicates if this band has an attribute table.

Supported Platforms

Windows, Solaris, Linux

Specified by:

hasTable in interface IRasterBand

Parameters:

b - The b (out: use single element array)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

hasStatistics

public void hasStatistics(boolean[] b)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IRasterBand

Indicates if this band has statistics.

Supported Platforms

Windows, Solaris, Linux

Specified by:

hasStatistics in interface IRasterBand

Parameters:

b - The b (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

hasColormap

public void hasColormap(boolean[] b)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IRasterBand

Indicates if this band has a colormap.

Supported Platforms

Windows, Solaris, Linux

Specified by:

hasColormap in interface IRasterBand

Parameters:

b - The b (out: use single element array)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getStatistics

public IRasterStatistics getStatistics()
                                throws java.io.IOException,
                                       AutomationException

Description copied from interface: IRasterBand

The statistics of this raster band.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getStatistics in interface IRasterBand

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

computeStatsAndHist

public void computeStatsAndHist()
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IRasterBand

Calculates statistics and histogram if not previously stored.

Supported Platforms

Windows, Solaris, Linux

Specified by:

computeStatsAndHist in interface IRasterBand

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHistogram

public IRasterHistogram getHistogram()
                              throws java.io.IOException,
                                     AutomationException

Description copied from interface: IRasterBand

The histogram of this raster band.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getHistogram in interface IRasterBand

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getColormap

public IRasterColormap getColormap()
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IRasterBand

The colormap of this raster band.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getColormap in interface IRasterBand

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getAttributeTable

public ITable getAttributeTable()
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IRasterBand

The attribute table of this raster band.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getAttributeTable in interface IRasterBand

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRasterDataset

public IRasterDataset getRasterDataset()
                                throws java.io.IOException,
                                       AutomationException

Description copied from interface: IRasterBand

The RasterDataset associated with this raster band.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getRasterDataset in interface IRasterBand

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getContrastTable

public IContrastTable getContrastTable()
                                throws java.io.IOException,
                                       AutomationException

Description copied from interface: IRasterBand

The contrast look-up table of this band.

Supported Platforms

Windows, Solaris, Linux

Remarks

This method should not be used by application developers.

Specified by:

getContrastTable in interface IRasterBand

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setContrastTable

public void setContrastTable(IContrastTable cont)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IRasterBand

The contrast look-up table of this band.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setContrastTable in interface IRasterBand

Parameters:

cont - A reference to a com.esri.arcgis.datasourcesraster.IContrastTable (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canCopy

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

Description copied from interface: IRasterBand

Returns true if this dataset can be copied.

Supported Platforms

Windows, Solaris, Linux

Specified by:

canCopy in interface IRasterBand

Returns:

The canCopy

Throws:

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

AutomationException - If the ArcObject component throws an exception.

copy

public IDataset copy(java.lang.String copyName,
                     IWorkspace copyWorkspace)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IRasterBand

Copies this raster band to a new dataset with the specified name.

Supported Platforms

Windows, Solaris, Linux

Specified by:

copy in interface IRasterBand

Parameters:

copyName - The copyName (in)

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBandname

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

Description copied from interface: IRasterBand

The name of this raster band.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBandname in interface IRasterBand

Returns:

The bandname

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirectlyOpened

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

Description copied from interface: IRasterBand

Indicates if the band was opened directly.

Supported Platforms

Windows, Solaris, Linux

Remarks

This method should not be used by application developers.

Specified by:

isDirectlyOpened in interface IRasterBand

Returns:

The bDirectlyOpened

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNativeType

public INativeType getNativeType()
                          throws java.io.IOException,
                                 AutomationException

Description copied from interface: INativeTypeInfo

The native type.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getNativeType in interface INativeTypeInfo

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getWidth

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

Description copied from interface: IRasterProps

Width in pixels.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getWidth in interface IRasterProps

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setWidth

public void setWidth(int pVal)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IRasterProps

Width in pixels.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setWidth in interface IRasterProps

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHeight

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

Description copied from interface: IRasterProps

Height in pixels.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getHeight in interface IRasterProps

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHeight

public void setHeight(int pVal)
               throws java.io.IOException,
                      AutomationException

Description copied from interface: IRasterProps

Height in pixels.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setHeight in interface IRasterProps

Parameters:

pVal - The pVal (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getPixelType

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

Description copied from interface: IRasterProps

Data type of the pixels.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPixelType in interface IRasterProps

Returns:

A com.esri.arcgis.geodatabase.rstPixelType constant

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setPixelType

public void setPixelType(int pVal)
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IRasterProps

Data type of the pixels.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPixelType in interface IRasterProps

Parameters:

pVal - A com.esri.arcgis.geodatabase.rstPixelType constant (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getNoDataValue

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

Description copied from interface: IRasterProps

Data value used to indicate invalid or excluded data.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getNoDataValue in interface IRasterProps

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNoDataValue

public void setNoDataValue(java.lang.Object pVal)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IRasterProps

Data value used to indicate invalid or excluded data.

Supported Platforms

Windows, Solaris, Linux

Remarks

Specifying a single NoData value for a multiband raster, the NoData value will apply to each raster band in the raster. To set different NoData value for each band, pass an array, each element in the array sets the NoData value for the corresponding band, to this property.

Specified by:

setNoDataValue in interface IRasterProps

Parameters:

pVal - A Variant (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

meanCellSize

public IPnt meanCellSize()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IRasterProps

Returns the approximate cell size of the raster.

Supported Platforms

Windows, Solaris, Linux

Specified by:

meanCellSize in interface IRasterProps

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isInteger

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

Description copied from interface: IRasterProps

Indicates if the data is integer.

Specified by:

isInteger in interface IRasterProps

Returns:

The pVal

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws java.io.IOException,
                                             AutomationException

Description copied from interface: IRasterProps

SpatialReference of the Raster.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSpatialReference in interface IRasterProps

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSpatialReference

public void setSpatialReference(ISpatialReference ppSpref)
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IRasterProps

SpatialReference of the Raster.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSpatialReference in interface IRasterProps

Parameters:

ppSpref - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtent

public IEnvelope getExtent()
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IRasterProps

The extent of the Raster.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getExtent in interface IRasterProps

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setExtent

public void setExtent(IEnvelope ppExtent)
               throws java.io.IOException,
                      AutomationException

Description copied from interface: IRasterProps

The extent of the Raster.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setExtent in interface IRasterProps

Parameters:

ppExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getName

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

Description copied from interface: IDataset

The name of the Dataset.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IDataset

Returns:

The name

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getFullName

public IName getFullName()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IDataset

The associated name object.

Supported Platforms

Windows, Solaris, Linux

Remarks

The FullName property returns a Name object for the dataset. The Name object can be persisted and provides a way to get back to the dataset in a future session of the application, via the Open method on the Name object.

Specified by:

getFullName in interface IDataset

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getBrowseName

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

Description copied from interface: IDataset

The browse name of the dataset.

Supported Platforms

Windows, Solaris, Linux

Remarks

BrowseName returns file names without their extension. For example, States.shp would appear as States.

Specified by:

getBrowseName in interface IDataset

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBrowseName

public void setBrowseName(java.lang.String name)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IDataset

The browse name of the dataset.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBrowseName in interface IDataset

Parameters:

name - The name (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getType

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

Description copied from interface: IDataset

The type of the Dataset.

Supported Platforms

Windows, Solaris, Linux

Remarks

The Type property returns the enumerated type for the dataset, such as esriDTTable or esriDTFeatureDataset.

Specified by:

getType in interface IDataset

Returns:

A com.esri.arcgis.geodatabase.esriDatasetType constant

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getCategory

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

Description copied from interface: IDataset

The category of the dataset.

Supported Platforms

Windows, Solaris, Linux

Remarks

IDataset::Category returns a description of the category of the dataset. The description returned from the Category property is the same value that is displayed in the Type column within the Contents tab in ArcCatalog. The value will contain a description of the dataset such as "Topology" prefixed with a description of the type of workspace containing the dataset such as "File Geodatabase".

The description returned from IDataset::Category may change between releases of ArcGIS.

Specified by:

getCategory in interface IDataset

Returns:

The category

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getSubsets

public IEnumDataset getSubsets()
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IDataset

Datasets contained within this dataset.

Supported Platforms

Windows, Solaris, Linux

Description

The Subsets property returns other Dataset objects contained in this dataset.

Remarks

IDataset::Subsets is not supported for Graph objects such as a Geometric Network. To return the feature classes contained in a Geometric Network, use the IFeatureClassContainer interface.

Specified by:

getSubsets in interface IDataset

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getWorkspace

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

Description copied from interface: IDataset

The workspace containing this dataset.

Supported Platforms

Windows, Solaris, Linux

Description

The Workspace property returns the containing workspace for this dataset.

Specified by:

getWorkspace in interface IDataset

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.

getPropertySet

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

Description copied from interface: IDataset

The set of properties for the dataset.

Supported Platforms

Windows, Solaris, Linux

Description

The PropertySet property is used to return any additional intrinsic properties (but not metadata properties) that may apply to the dataset. One use of this property is to distinguish between the types of File Geodatabase datafile formats. If called on a Feature Class or Table in a File Geodatabase the Datafile Format property can either be esriFGDBStandardDatafile or esriFGDBCompressedDatafile.

Remarks

Examples of intrinsic properties for which explicit methods exist include the SpatialReference and the Extent methods available on the IGeoDataset interface. In most cases this PropertySet will be empty.

IDataset::PropertySet is not supported for Graph objects such as a Geometric Network.

Specified by:

getPropertySet in interface IDataset

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

canDelete

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

Description copied from interface: IDataset

True if this dataset can be deleted.

Supported Platforms

Windows, Solaris, Linux

Remarks

The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods. For example, you may not delete a network feature class nor can you use the Copy method on a Geodatabase feature class. To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.

Specified by:

canDelete in interface IDataset

Returns:

The canDelete

Throws:

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

AutomationException - If the ArcObject component throws an exception.

delete

public void delete()
            throws java.io.IOException,
                   AutomationException

Description copied from interface: IDataset

Deletes this dataset.

Supported Platforms

Windows, Solaris, Linux

Remarks

Certain feature classes, such as network and topology feature classes, cannot be deleted until their containing objects are deleted.

Specified by:

delete in interface IDataset

Throws:

AutomationException - If the ArcObject component throws an exception.

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

canRename

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

Description copied from interface: IDataset

True if this dataset can be renamed.

Supported Platforms

Windows, Solaris, Linux

Remarks

The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods. For example, you may not delete or rename a network feature class nor can you use the Copy method on a Geodatabase feature class. To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.

Specified by:

canRename in interface IDataset

Returns:

The canRename

Throws:

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

AutomationException - If the ArcObject component throws an exception.

rename

public void rename(java.lang.String name)
            throws java.io.IOException,
                   AutomationException

Description copied from interface: IDataset

Renames this Dataset.

Supported Platforms

Windows, Solaris, Linux

Remarks

IDataset::Rename does not support the renaming of Graph objects such as a Geometric Network. In addition, certain feature classes, such as network feature classes, cannot be renamed.

Specified by:

rename in interface IDataset

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createRow

public IRow createRow()
               throws java.io.IOException,
                      AutomationException

Description copied from interface: ITable

Creates a row in the database with a system assigned object ID and null property values.

Supported Platforms

Windows, Solaris, Linux

Remarks

The CreateRow method creates a new row in the underlying database with a system assigned object id value. A row object representing the created row is returned to the caller. The row object returned has the system assigned object ID as the value of the OIDField. All other fields are initialized to null values if they can be made null and to built-in default values appropriate to the type of the field if they cannot be made null.

The caller is responsible for setting the desired field values into the row and calling the Store method on the row. If the table represents an object class with subtypes, then it is the caller’s responsibility to set the default subtype code into the row and call the InitDefaultValues method on the row before storing, if that is the desired result. For tables without object behavior, insert cursors offer a more efficient way for inserting new rows.

Specified by:

createRow in interface ITable

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRow

public IRow getRow(int oID)
            throws java.io.IOException,
                   AutomationException

Description copied from interface: ITable

The row from the database with the specified object ID.

Supported Platforms

Windows, Solaris, Linux

Remarks

The GetRow method returns an existing row object, given its object ID value. The caller can query the returned row object for additional object specific interfaces. The retrieved row may be modified; calling Store on the row object after changing it will trigger messages to related objects and will mark the row for committing to the database.

Specified by:

getRow in interface ITable

Parameters:

oID - The oID (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRows

public ICursor getRows(java.lang.Object oids,
                       boolean recycling)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: ITable

The cursor of rows based on a set of object ids.

Supported Platforms

Windows, Solaris, Linux

Remarks

The GetRows method returns a cursor that may be used to retrieve a set of rows specified by the input array of object id values. See the description of the Search method to understand the meaning of the recycling parameter. It is far more efficient to retrieve a set of rows using the GetRows method than it is to retrieve each individual row using the GetRow method. The retrieved rows may be modified; Store should be called on the row objects after changing them.

Specified by:

getRows in interface ITable

Parameters:

oids - A Variant (in)

recycling - The recycling (in)

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

createRowBuffer

public IRowBuffer createRowBuffer()
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: ITable

Creates a row buffer that can be used with an insert cursor.

Supported Platforms

Windows, Solaris, Linux

Remarks

The CreateRowBuffer method creates a new row buffer object in memory and returns it to the caller. No row is created in the database. The returned row buffer does not have an object ID value. The caller can set values into the row buffer and use it as an argument to the InsertRow method on an insert cursor; the latter is obtained by calling the Insert method on the Table.

Specified by:

createRowBuffer in interface ITable

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

updateSearchedRows

public void updateSearchedRows(IQueryFilter queryFilter,
                               IRowBuffer buffer)
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: ITable

Update the Rows in the database selected by the specified query.

Supported Platforms

Windows, Solaris, Linux

Remarks

All edits to features that participate in a Topology or Geometric Network must be performed within an edit session and bracketed within an edit operation.

Specified by:

updateSearchedRows in interface ITable

Parameters:

queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

buffer - A reference to a com.esri.arcgis.geodatabase.IRowBuffer (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

deleteSearchedRows

public void deleteSearchedRows(IQueryFilter queryFilter)
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: ITable

Delete the Rows in the database selected by the specified query.

Supported Platforms

Windows, Solaris, Linux

Specified by:

deleteSearchedRows in interface ITable

Parameters:

queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

rowCount

public int rowCount(IQueryFilter queryFilter)
             throws java.io.IOException,
                    AutomationException

Description copied from interface: ITable

The number of Rows selected by the specified query.

Supported Platforms

Windows, Solaris, Linux

Specified by:

rowCount in interface ITable

Parameters:

queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

Returns:

The numRows

Throws:

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

AutomationException - If the ArcObject component throws an exception.

ITable_search

public ICursor ITable_search(IQueryFilter queryFilter,
                             boolean recycling)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: ITable

An object cursor that can be used to fetch row objects selected by the specified query.

Specified by:

ITable_search in interface ITable

Parameters:

queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

recycling - The recycling (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

update

public ICursor update(IQueryFilter queryFilter,
                      boolean recycling)
               throws java.io.IOException,
                      AutomationException

Description copied from interface: ITable

Returns a cursor that can be used to update Rows selected by the specified query.

Supported Platforms

Windows, Solaris, Linux

Remarks

The Update method returns an ‘update’ cursor that can be used to update or delete rows. It offers somewhat faster performance than multiple calls to Store or Delete on row objects fetched using a non-recycling search cursor for tables storing simple rows and simple features. There is no difference in performance for custom features.

All edits to features that participate in a Topology or Geometric Network must be bracketed within an edit operation.

Specified by:

update in interface ITable

Parameters:

queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

recycling - The recycling (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

insert

public ICursor insert(boolean useBuffering)
               throws java.io.IOException,
                      AutomationException

Description copied from interface: ITable

Returns a cursor that can be used to insert new Rows.

Supported Platforms

Windows, Solaris, Linux

Remarks

The Insert method returns an ‘insert’ cursor that can be used to bulk insert rows. It offers significantly faster performance than multiple calls to CreateRow and Store for tables storing simple rows and simple features (that is, for tables whose CLSID is esriGeoDatabase.Row, esriGeoDatabase.Object, or esriGeoDatabase.Feature).

Insert cursors on tables containing custom rows and objects use the CreateRow and Store methods to achieve polymorphism, and there is no difference in performance in these cases.

Specified by:

insert in interface ITable

Parameters:

useBuffering - The useBuffering (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

select

public ISelectionSet select(IQueryFilter queryFilter,
                            int selType,
                            int selOption,
                            IWorkspace selectionContainer)
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: ITable

A selection that contains the object ids selected by the specified query.

Supported Platforms

Windows, Solaris, Linux

Remarks

The Select method returns a selection set that holds either row ids or row objects from the Table depending on the selection option. Multiple selection sets can be created on the same table. It is up to a client application or object to keep a reference on created selections and use them as appropriate. For example, a FeatureLayer creates and uses selections on a FeatureClass (a type of Table).

When calling Select the selectionContainer parameter is no longer required. Null (C#, VB.Net) or Nothing (VB6) should be supplied it its place.

Specified by:

select in interface ITable

Parameters:

queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

selType - A com.esri.arcgis.geodatabase.esriSelectionType constant (in)

selOption - A com.esri.arcgis.geodatabase.esriSelectionOption constant (in)

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findField

public int findField(java.lang.String name)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IClass

The index of the field with the specified name.

Supported Platforms

Windows, Solaris, Linux

Remarks

If FindField returns -1, the Field could not be found in the Fields collection.

Specified by:

findField in interface IClass

Parameters:

name - The name (in)

Returns:

The fieldIndex

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getFields

public IFields getFields()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IClass

The fields collection for this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFields in interface IClass

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getIndexes

public IIndexes getIndexes()
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IClass

The indexes collection for this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getIndexes in interface IClass

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addField

public void addField(IField field)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IClass

Adds a field to this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:

addField in interface IClass

Parameters:

field - A reference to a com.esri.arcgis.geodatabase.IField (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteField

public void deleteField(IField field)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IClass

Deletes a field from this object class.

Supported Platforms

Windows, Solaris, Linux

Remarks

DeleteField removes the specified field from a table, object class or feature class. Fields that are required by the Geodatabase and cannot be removed include:

• OBJECTID field
• SHAPE and shape dependent fields such as SHAPE_Length
• Enabled, AncillaryRole and Weight field for network feature classes
• Subtype fields. In order to delete a subtype field, it must first be removed as the subtype field, see the help on ISubtypes::SubtypeFieldName

Specified by:

deleteField in interface IClass

Parameters:

field - A reference to a com.esri.arcgis.geodatabase.IField (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addIndex

public void addIndex(IIndex index)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IClass

Adds an index to this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:

addIndex in interface IClass

Parameters:

index - A reference to a com.esri.arcgis.geodatabase.IIndex (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteIndex

public void deleteIndex(IIndex index)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IClass

Deletes an index from this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:

deleteIndex in interface IClass

Parameters:

index - A reference to a com.esri.arcgis.geodatabase.IIndex (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHasOID

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

Description copied from interface: IClass

Indicates if the class has an object identity (OID) field.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isHasOID in interface IClass

Returns:

The hasOID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOIDFieldName

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

Description copied from interface: IClass

The name of the field corresponding to the OID.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getOIDFieldName in interface IClass

Returns:

The name

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getCLSID

public IUID getCLSID()
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IClass

The GUID for the COM Class (CoClass) corresponding to instances of this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCLSID in interface IClass

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEXTCLSID

public IUID getEXTCLSID()
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IClass

The GUID for the COM Class (CoClass) corresponding to the class extension for this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getEXTCLSID in interface IClass

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getExtension

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

Description copied from interface: IClass

The extension for this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getExtension in interface IClass

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtensionProperties

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

Description copied from interface: IClass

The extension properties for this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getExtensionProperties in interface IClass

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getObjectClassID

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

Description copied from interface: IObjectClass

The unique ID for the object class.

Supported Platforms

Windows, Solaris, Linux

Description

Returns the unique ID of the object class.

Remarks

Each feature class or table registered with the geodatabase is an object class. Object classes have a unique ID which distinguishes them from other object classes in the geodatabase. The ObjectClassID property returns this ID as a long. The object class ID is assigned by the system when the class is created, or registered with the geodatabase, it cannot be modified.

Those feature classes and tables that are in the database, but not registered with the geodatabase will always have an object class ID of -1.

Specified by:

getObjectClassID in interface IObjectClass

Returns:

The objectClassID

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getRelationshipClasses

public IEnumRelationshipClass getRelationshipClasses(int role)
                                              throws java.io.IOException,
                                                     AutomationException

Description copied from interface: IObjectClass

The relationship classes in which this object class participates in for the specified role.

Supported Platforms

Windows, Solaris, Linux

Description

Returns an enumeration of the relationship classes in which the object class participates.

Remarks

Object classes in a geodatabase may participate in any number of relationships classes. The RelationshipClasses property allows you to get a list of those relationship classes that the object class participates in by what role it plays (origin, destination, or either) defined by the esriRelRole enumeration used when you call this property. This property returns a IEnumRelationshipClass interface which you can use to loop through those relationship classes that are returned.

Specified by:

getRelationshipClasses in interface IObjectClass

Parameters:

role - A com.esri.arcgis.geodatabase.esriRelRole constant (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

See Also:

IEnumRelationshipClass, esriRelRole

getAliasName

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

Description copied from interface: IObjectClass

The alias name of the object class.

Supported Platforms

Windows, Solaris, Linux

Description

Returns the alias name for the object class.

Remarks

Object classes in a geodatabase can have between one and three names. The name of the object class, which is the same as the name of the table in the DBMS in which the objects in the object class are stored, the alias name which the user can set for display purposes in end user applications. The third name is the model name which is a tool for developers of custom objects to use to guarantee the names of objects independent of the true name or alias name.

The AliasName property returns the alias name for the object class. If the object class has no alias name, then AliasName will return the name of the object class (fully qualified if on ArcSDE). The alias name can be modified using the IClassSchemEdit interface.

Specified by:

getAliasName in interface IObjectClass

Returns:

The name

Throws:

AutomationException - If the ArcObject component throws an exception.

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

See Also:

IModelInfo

getFormat

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

Description copied from interface: IRasterDataset

The format of this RasterRataset.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFormat in interface IRasterDataset

Returns:

The format

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getSensorType

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

Description copied from interface: IRasterDataset

The sensor type used for this RasterDataset.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSensorType in interface IRasterDataset

Returns:

The sensorType

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getCompressionType

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

Description copied from interface: IRasterDataset

The compression technique applied to this RasterDataset.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCompressionType in interface IRasterDataset

Returns:

The comp

Throws:

AutomationException - If the ArcObject component throws an exception.

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

createDefaultRaster

public IRaster createDefaultRaster()
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IRasterDataset

Creates a raster object with the default properties for this dataset.

Supported Platforms

Windows, Solaris, Linux

Remarks

The CreateDefaultRaster method creates a Raster that has a square cell size and contains only three raster bands if the dataset has more than three bands. The three bands are the default bands used in raster RGB renderer and are determined by the settings for default raster behavior made on the RasterDefaultsEnv object in esriCarto library.

Specified by:

createDefaultRaster in interface IRasterDataset

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

precalculateStats

public void precalculateStats(java.lang.Object index_list)
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IRasterDataset

Calculates statistics and histograms for specified bands.

Supported Platforms

Windows, Solaris, Linux

Specified by:

precalculateStats in interface IRasterDataset

Parameters:

index_list - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCompleteName

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

Description copied from interface: IRasterDataset

The full path of the RasterDataset.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCompleteName in interface IRasterDataset

Returns:

The completeName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTableType

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

Description copied from interface: IRasterTable

The class names of the table.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTableType in interface IRasterTable

Returns:

A com.esri.arcgis.datasourcesraster.esriRasterTableTypeEnum constant

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getPrimaryField

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

Description copied from interface: IRasterTable

The primary field of the table.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPrimaryField in interface IRasterTable

Returns:

The fieldIndex

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setPrimaryField

public void setPrimaryField(int fieldIndex)
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IRasterTable

The primary field of the table.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPrimaryField in interface IRasterTable

Parameters:

fieldIndex - The fieldIndex (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createPixelBlock

public IPixelBlock createPixelBlock(IPnt size)
                             throws java.io.IOException,
                                    AutomationException

Description copied from interface: IRawPixels

Allocates a PixelBlock of size requested and type of this band.

Supported Platforms

Windows, Solaris, Linux

Remarks

CreatePixelBlock method only initializes the properties of a pixel block, such as dimension, pixel type etc. Read method of this interface should be used to read pixels into the pixel block.

Specified by:

createPixelBlock in interface IRawPixels

Parameters:

size - A reference to a com.esri.arcgis.geodatabase.IPnt (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

read

public void read(IPnt tlc,
                 IPixelBlock pxls)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IRawPixels

Read a block of pixels starting from tlc (top left corner).

Supported Platforms

Windows, Solaris, Linux

Specified by:

read in interface IRawPixels

Parameters:

tlc - A reference to a com.esri.arcgis.geodatabase.IPnt (in)

pxls - A reference to a com.esri.arcgis.geodatabase.IPixelBlock (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

write

public void write(IPnt tlc,
                  IPixelBlock pxls)
           throws java.io.IOException,
                  AutomationException

Description copied from interface: IRawPixels

Write a block of pixels starting from tlc (top left corner).

Supported Platforms

Windows, Solaris, Linux

Specified by:

write in interface IRawPixels

Parameters:

tlc - A reference to a com.esri.arcgis.geodatabase.IPnt (in)

pxls - A reference to a com.esri.arcgis.geodatabase.IPixelBlock (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

acquireCache

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

Description copied from interface: IRawPixels

Gets reference to edit cache.

Supported Platforms

Windows, Solaris, Linux

Specified by:

acquireCache in interface IRawPixels

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

returnCache

public int returnCache(java.lang.Object cache)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IRawPixels

Restores edit cache to previous state.

Supported Platforms

Windows, Solaris, Linux

Specified by:

returnCache in interface IRawPixels

Parameters:

cache - A reference to another Object (IUnknown) (in)

Returns:

The num_refs

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getNumCacheRefs

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

Description copied from interface: IRawPixels

Number of outstanding cache references

Supported Platforms

Windows, Solaris, Linux

Specified by:

getNumCacheRefs in interface IRawPixels

Returns:

The num_refs

Throws:

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

AutomationException - If the ArcObject component throws an exception.