com.esri.arcgis.datasourcesfile
Class CoverageName

java.lang.Object
  com.esri.arcgis.datasourcesfile.CoverageName

All Implemented Interfaces:

ICoverageName, IDatasetContainerName, IDatasetName, IDatasetNameFileStat, IFeatureDatasetName, IFeatureDatasetName2, IMetadata, IMetadataEdit, INativeTypeInfo, com.esri.arcgis.interop.RemoteObjRef, IName, Serializable

public class CoverageName
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IName, ICoverageName, IDatasetName, IDatasetNameFileStat, IFeatureDatasetName, IMetadata, IMetadataEdit, INativeTypeInfo, IFeatureDatasetName2, IDatasetContainerName

Maintains ArcInfo Coverage information.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

CoverageName()
Constructs a CoverageName using ArcGIS Engine.

CoverageName(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
CoverageName theCoverageName = (CoverageName) obj;

Method Summary

boolean	equals(Object o) Compare this object with another
String	getCategory() The category of the dataset.
static String	getClsid() getClsid.
int	getCoverageType() Type of the Coverage.
IEnumDatasetName	getDatasetNames(int type) An enumerator over the specified dataset names in this FeatureDataset.
IEnumDatasetName	getFeatureClassNames() An enumerator over the feature class names in this FeatureDataset.
IEnumDatasetName	getGeometricNetworkNames() An enumerator over the geometric network names in this FeatureDataset.
IPropertySet	getMetadata() The PropertySet containing metadata.
String	getName() The name of the dataset.
String	getNameString() The name string of the object.
INativeType	getNativeType() The native type.
IEnumDatasetName	getRelationshipClassNames() An enumerator over the relationship class names in this FeatureDataset.
int	getStatMode() The access mode.
int	getStatSize() The size.
int	getStatTime(int dateMode) The date modified/created/accessed.
IEnumDatasetName	getSubsetNames() Subset names contained within this dataset name.
IEnumDatasetName	getTableNames() An enumerator over the table (non spatial object class) names in this FeatureDataset.
IEnumDatasetName	getTopologyNames() An enumerator over the topology names in this FeatureDataset.
int	getType() The type of the dataset.
IWorkspaceName	getWorkspaceName() The WorkspaceName of the DatasetName.
int	hashCode() the hashcode for this object
boolean	isCanEditMetadata() Indicates if metadata can be edited.
Object	open() Opens the object referred to by this name.
void	setCategory(String category) The category of the dataset.
void	setCoverageType(int coverageType) Type of the Coverage.
void	setMetadata(IPropertySet ppPropertySet) The PropertySet containing metadata.
void	setName(String name) The name of the dataset.
void	setNameString(String nameString) The name string of the object.
void	setStatMode(int pAccessMode) The access mode.
void	setStatSize(int pSize) The size.
void	setStatTime(int dateMode, int pTime) The date modified/created/accessed.
void	setWorkspaceNameByRef(IWorkspaceName workspaceName) The WorkspaceName of the DatasetName.
void	synchronize(int action, int interval) Updates metadata with the current properties; may create metadata if it doesn't already exist.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

CoverageName

public CoverageName()
             throws IOException,
                    UnknownHostException

Constructs a CoverageName using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

CoverageName

public CoverageName(Object obj)
             throws IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

setNameString

public void setNameString(String nameString)
                   throws IOException,
                          AutomationException

The name string of the object.

Remarks

The NameString property is reserved for future use. When implemented, it will return a string representation of the locational component of the name object that may be persisted by applications.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setNameString in interface IName

Parameters:

nameString - The nameString (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNameString

public String getNameString()
                     throws IOException,
                            AutomationException

The name string of the object.

Remarks

The NameString property is reserved for future use. When implemented, it will return a string representation of the locational component of the name object that may be persisted by applications.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getNameString in interface IName

Returns:

The nameString

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

open

public Object open()
            throws IOException,
                   AutomationException

Opens the object referred to by this name.

Remarks

The Open method lets you instantiate the actual object given the name object.

Note: Opening a feature class that participates in a topology or geometric network will also open all other feature classes participating in the topology or geometric network in memory.

Example:

IName   pName = pFeatureClassName; 
pFeatureClass = new IFeatureClassProxy(pName.open());

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

open in interface IName

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCoverageType

public int getCoverageType()
                    throws IOException,
                           AutomationException

Type of the Coverage.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCoverageType in interface ICoverageName

Returns:

A com.esri.arcgis.datasourcesfile.esriCoverageType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCoverageType

public void setCoverageType(int coverageType)
                     throws IOException,
                            AutomationException

Type of the Coverage.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCoverageType in interface ICoverageName

Parameters:

coverageType - A com.esri.arcgis.datasourcesfile.esriCoverageType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

The name of the dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IDatasetName

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String name)
             throws IOException,
                    AutomationException

The name of the dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setName in interface IDatasetName

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getType

public int getType()
            throws IOException,
                   AutomationException

The type of the dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getType in interface IDatasetName

Returns:

A com.esri.arcgis.geodatabase.esriDatasetType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCategory

public String getCategory()
                   throws IOException,
                          AutomationException

The category of the dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCategory in interface IDatasetName

Returns:

The category

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCategory

public void setCategory(String category)
                 throws IOException,
                        AutomationException

The category of the dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCategory in interface IDatasetName

Parameters:

category - The category (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWorkspaceName

public IWorkspaceName getWorkspaceName()
                                throws IOException,
                                       AutomationException

The WorkspaceName of the DatasetName.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getWorkspaceName in interface IDatasetName

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWorkspaceNameByRef

public void setWorkspaceNameByRef(IWorkspaceName workspaceName)
                           throws IOException,
                                  AutomationException

The WorkspaceName of the DatasetName.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setWorkspaceNameByRef in interface IDatasetName

Parameters:

workspaceName - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSubsetNames

public IEnumDatasetName getSubsetNames()
                                throws IOException,
                                       AutomationException

Subset names contained within this dataset name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSubsetNames in interface IDatasetName

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStatTime

public void setStatTime(int dateMode,
                        int pTime)
                 throws IOException,
                        AutomationException

The date modified/created/accessed.

Product Availability

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

Specified by:

setStatTime in interface IDatasetNameFileStat

Parameters:

dateMode - A com.esri.arcgis.geodatabase.esriDatasetFileStatTimeMode constant (in)

pTime - The pTime (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStatTime

public int getStatTime(int dateMode)
                throws IOException,
                       AutomationException

The date modified/created/accessed.

Product Availability

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

Specified by:

getStatTime in interface IDatasetNameFileStat

Parameters:

dateMode - A com.esri.arcgis.geodatabase.esriDatasetFileStatTimeMode constant (in)

Returns:

The pTime

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStatSize

public void setStatSize(int pSize)
                 throws IOException,
                        AutomationException

The size.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setStatSize in interface IDatasetNameFileStat

Parameters:

pSize - The pSize (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStatSize

public int getStatSize()
                throws IOException,
                       AutomationException

The size.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getStatSize in interface IDatasetNameFileStat

Returns:

The pSize

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStatMode

public void setStatMode(int pAccessMode)
                 throws IOException,
                        AutomationException

The access mode.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setStatMode in interface IDatasetNameFileStat

Parameters:

pAccessMode - A com.esri.arcgis.geodatabase.esriDatasetFileStatAccessMode constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStatMode

public int getStatMode()
                throws IOException,
                       AutomationException

The access mode.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getStatMode in interface IDatasetNameFileStat

Returns:

A com.esri.arcgis.geodatabase.esriDatasetFileStatAccessMode constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFeatureClassNames

public IEnumDatasetName getFeatureClassNames()
                                      throws IOException,
                                             AutomationException

An enumerator over the feature class names in this FeatureDataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFeatureClassNames in interface IFeatureDatasetName

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGeometricNetworkNames

public IEnumDatasetName getGeometricNetworkNames()
                                          throws IOException,
                                                 AutomationException

An enumerator over the geometric network names in this FeatureDataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getGeometricNetworkNames in interface IFeatureDatasetName

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTableNames

public IEnumDatasetName getTableNames()
                               throws IOException,
                                      AutomationException

An enumerator over the table (non spatial object class) names in this FeatureDataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTableNames in interface IFeatureDatasetName

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRelationshipClassNames

public IEnumDatasetName getRelationshipClassNames()
                                           throws IOException,
                                                  AutomationException

An enumerator over the relationship class names in this FeatureDataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getRelationshipClassNames in interface IFeatureDatasetName

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMetadata

public IPropertySet getMetadata()
                         throws IOException,
                                AutomationException

The PropertySet containing metadata.

Remarks

The variable to hold the data must be of IPropertySet data type.

The metadata property is frequently used to save, or update, changes to metadata documents that have taken place through methods available on the IPropertySet, IXmlPropertySet, and/or IXmlPropertySet2 interfaces.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMetadata in interface IMetadata

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMetadata

public void setMetadata(IPropertySet ppPropertySet)
                 throws IOException,
                        AutomationException

The PropertySet containing metadata.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMetadata in interface IMetadata

Parameters:

ppPropertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

synchronize

public void synchronize(int action,
                        int interval)
                 throws IOException,
                        AutomationException

Updates metadata with the current properties; may create metadata if it doesn't already exist.

Description

The Synchronize method is used to extract metadata properties from an object and write those properties to the metadata .xml. Depending on the value of the esriMetaSyncAction, the Synchronize method may generate a new set of metadata if it doesn't already exist.

Remarks

The following actions will result in synchronization given each of the listed conditions:

Action	Metadata status	Esri/Sync element	Interval parameter
esriMSAAccessed	Doesn't matter	Must not be FALSE	Must be less than actual interval
esriMSAAlways	Doesn't matter	Doesn't matter	Doesn't matter
esriMSACreated	Must not exist	Must not be FALSE	Must be less than actual interval
esriMSANotCreated	Must exist	Must not be FALSE	Must be less than actual interval
esriMSAOverwrite	Doesn't matter	Doesn't matter	Doesn't matter

The difference between esriMSAAlways and esriMSAOverwrite lies in which elements are synchronized. esriMSAAlways will honor the removal or value change of an element's Sync attribute (to disable synchronization), whereas using esriMSAOverwrite is equivalent to setting the IXmlPropertySet2.OverwriteSyncAttribute to true for the metadata's property set, meaning that even elements without a Sync attribute of TRUE will be synchronized.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

synchronize in interface IMetadata

Parameters:

action - A com.esri.arcgis.geodatabase.esriMetadataSyncAction constant (in)

interval - The interval (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCanEditMetadata

public boolean isCanEditMetadata()
                          throws IOException,
                                 AutomationException

Indicates if metadata can be edited.

Remarks

This property is available to those objects that support metadata.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isCanEditMetadata in interface IMetadataEdit

Returns:

The pCanEdit

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNativeType

public INativeType getNativeType()
                          throws IOException,
                                 AutomationException

The native type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getNativeType in interface INativeTypeInfo

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTopologyNames

public IEnumDatasetName getTopologyNames()
                                  throws IOException,
                                         AutomationException

An enumerator over the topology names in this FeatureDataset.

Remarks

This method returns an enumeration of all the TopologyNames in the FeatureDataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTopologyNames in interface IFeatureDatasetName2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDatasetNames

public IEnumDatasetName getDatasetNames(int type)
                                 throws IOException,
                                        AutomationException

An enumerator over the specified dataset names in this FeatureDataset.

Product Availability

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

Specified by:

getDatasetNames in interface IDatasetContainerName

Parameters:

type - A com.esri.arcgis.geodatabase.esriDatasetType constant (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.