com.esri.arcgis.datasourcesGDB
Class FgdbTableName

java.lang.Object
  com.esri.arcgis.datasourcesGDB.FgdbTableName

All Implemented Interfaces:

ICompressionInfo, IDatasetName, IMetadata, IMetadataEdit, IModelInfo, IName, INativeTypeInfo, IObjectClassName, IPersist, IPersistStream, ISupportErrorInfo, ITableName, java.io.Serializable

public class FgdbTableName

extends java.lang.Object

implements IName, IDatasetName, ITableName, IObjectClassName, IModelInfo, ICompressionInfo, IPersist, IPersistStream, IMetadata, IMetadataEdit, INativeTypeInfo, ISupportErrorInfo

File GeoDatabase Table Name object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

FgdbTableName()
Constructs a FgdbTableName using ArcGIS Engine.

FgdbTableName(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
ICompressionInfo	getAsICompressionInfo() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IDatasetName	getAsIDatasetName() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IMetadata	getAsIMetadata() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IMetadataEdit	getAsIMetadataEdit() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IModelInfo	getAsIModelInfo() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IName	getAsIName() 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.
IObjectClassName	getAsIObjectClassName() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPersist	getAsIPersist() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPersistStream	getAsIPersistStream() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ISupportErrorInfo	getAsISupportErrorInfo() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ITableName	getAsITableName() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
java.lang.String	getCategory() The category of the dataset.
void	getClassID(GUID[] pClassID) Supported Platforms
static java.lang.String	getClsid()
IPropertySet	getMetadata() The PropertySet containing metadata.
java.lang.String	getModelName() The model name of the field.
java.lang.String	getName() The name of the dataset.
java.lang.String	getNameString() The name string of the object.
INativeType	getNativeType() The native type.
int	getObjectClassID() The object class ID.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) Supported Platforms
IEnumDatasetName	getSubsetNames() Subset names contained within this dataset name.
int	getType() The type of the dataset.
IWorkspaceName	getWorkspaceName() The WorkspaceName of the DatasetName.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) Supported Platforms
boolean	isCanEditMetadata() Indicates if metadata can be edited.
boolean	isCompressed() Indicates if the dataset is compressed.
void	isDirty() Supported Platforms
void	load(IStream pstm) Supported Platforms
java.lang.Object	open() Opens the object referred to by this name.
void	save(IStream pstm, int fClearDirty) Supported Platforms
void	setCategory(java.lang.String category) The category of the dataset.
void	setIsCompressed(boolean isCompressed) Indicates if the dataset is compressed.
void	setMetadata(IPropertySet ppPropertySet) The PropertySet containing metadata.
void	setModelName(java.lang.String name) The model name of the field.
void	setName(java.lang.String name) The name of the dataset.
void	setNameString(java.lang.String nameString) The name string of the object.
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

Constructor Detail

FgdbTableName

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

Constructs a FgdbTableName using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

FgdbTableName

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

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Construct a FgdbTableName using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to FgdbTableName.
FgdbTableName theFgdbTableName = (FgdbTableName) obj;

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getAsIName

public IName getAsIName()

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

getAsIDatasetName

public IDatasetName getAsIDatasetName()

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

getAsITableName

public ITableName getAsITableName()

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

getAsIObjectClassName

public IObjectClassName getAsIObjectClassName()

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

getAsIModelInfo

public IModelInfo getAsIModelInfo()

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

getAsICompressionInfo

public ICompressionInfo getAsICompressionInfo()

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

getAsIPersist

public IPersist getAsIPersist()

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

getAsIPersistStream

public IPersistStream getAsIPersistStream()

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

getAsIMetadata

public IMetadata getAsIMetadata()

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

getAsIMetadataEdit

public IMetadataEdit getAsIMetadataEdit()

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.

getAsISupportErrorInfo

public ISupportErrorInfo getAsISupportErrorInfo()

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

setNameString

public void setNameString(java.lang.String nameString)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IName

The name string of the object.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:

setNameString in interface IName

Parameters:

nameString - The nameString (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNameString

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

Description copied from interface: IName

The name string of the object.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:

getNameString in interface IName

Returns:

The nameString

Throws:

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

AutomationException - If the ArcObject component throws an exception.

open

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

Description copied from interface: IName

Opens the object referred to by this name.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:

open in interface IName

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

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

Description copied from interface: IDatasetName

The name of the dataset.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IDatasetName

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setName

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

Description copied from interface: IDatasetName

The name of the dataset.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setName in interface IDatasetName

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: IDatasetName

The type of the dataset.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getType in interface IDatasetName

Returns:

A com.esri.arcgis.geodatabase.esriDatasetType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCategory

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

Description copied from interface: IDatasetName

The category of the dataset.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCategory in interface IDatasetName

Returns:

The category

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setCategory

public void setCategory(java.lang.String category)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IDatasetName

The category of the dataset.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCategory in interface IDatasetName

Parameters:

category - The category (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getWorkspaceName

public IWorkspaceName getWorkspaceName()
                                throws java.io.IOException,
                                       AutomationException

Description copied from interface: IDatasetName

The WorkspaceName of the DatasetName.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getWorkspaceName in interface IDatasetName

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setWorkspaceNameByRef

public void setWorkspaceNameByRef(IWorkspaceName workspaceName)
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: IDatasetName

The WorkspaceName of the DatasetName.

Specified by:

setWorkspaceNameByRef in interface IDatasetName

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getSubsetNames

public IEnumDatasetName getSubsetNames()
                                throws java.io.IOException,
                                       AutomationException

Description copied from interface: IDatasetName

Subset names contained within this dataset name.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSubsetNames in interface IDatasetName

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getObjectClassID

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

Description copied from interface: IObjectClassName

The object class ID.

Supported Platforms

Windows, Solaris, Linux

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 IObjectClassName

Returns:

The iD

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getModelName

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

Description copied from interface: IModelInfo

The model name of the field.

Supported Platforms

Windows, Solaris, Linux

Remarks

Returns the model name currently associated with the field or object class.

Specified by:

getModelName in interface IModelInfo

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

See Also:

IField, IObjectClass, IClassSchemaEdit

setModelName

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

Description copied from interface: IModelInfo

The model name of the field.

Supported Platforms

Windows, Solaris, Linux

Remarks

Sets the model name for the field or object class.

Specified by:

setModelName in interface IModelInfo

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

See Also:

IField, IFieldEdit, IObjectClass, IClassSchemaEdit

setIsCompressed

public void setIsCompressed(boolean isCompressed)
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: ICompressionInfo

Indicates if the dataset is compressed.

Specified by:

setIsCompressed in interface ICompressionInfo

Parameters:

isCompressed - The isCompressed (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isCompressed

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

Description copied from interface: ICompressionInfo

Indicates if the dataset is compressed.

Specified by:

isCompressed in interface ICompressionInfo

Returns:

The isCompressed

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IPersist

Supported Platforms

Windows, Solaris, Linux

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isDirty

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getMetadata

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

Description copied from interface: IMetadata

The PropertySet containing metadata.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:

getMetadata in interface IMetadata

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.

setMetadata

public void setMetadata(IPropertySet ppPropertySet)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IMetadata

The PropertySet containing metadata.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMetadata in interface IMetadata

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

synchronize

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

Description copied from interface: IMetadata

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

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:

synchronize in interface IMetadata

Parameters:

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

interval - The interval (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCanEditMetadata

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

Description copied from interface: IMetadataEdit

Indicates if metadata can be edited.

Supported Platforms

Windows, Solaris, Linux

Remarks

This property is available to those objects that support metadata.

Specified by:

isCanEditMetadata in interface IMetadataEdit

Returns:

The pCanEdit

Throws:

AutomationException - If the ArcObject component throws an exception.

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

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.

interfaceSupportsErrorInfo

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

Description copied from interface: ISupportErrorInfo

Supported Platforms

Windows, Solaris, Linux

Description

Indicates whether the interface supports IErrorInfo.

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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