FeatureClass (ArcObjects Java API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.geodatabase
Class FeatureClass

java.lang.Object
  com.esri.arcgis.geodatabase.FeatureClass

All Implemented Interfaces:: IClass, IClassSchemaEdit, IClassSchemaEdit2, IDataset, IDatasetAnalyze, IDatasetEdit, IDatasetEditInfo, IFeatureClass, IFeatureClassLoad, IFeatureClassManage, IFeatureClassWrite, IGeoDataset, IModelInfo, INetworkClass, IObjectClass, IObjectClassInfo, IObjectClassInfo2, ISchemaLock, ISubtypes, ITable, ITableCapabilities, ITopologyClass, IValidation, IValidation2, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class FeatureClass
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IDataset, IDatasetEdit, IDatasetEditInfo, IDatasetAnalyze, ISchemaLock, IClass, ITable, IObjectClass, IClassSchemaEdit, IClassSchemaEdit2, IModelInfo, ITopologyClass, ISubtypes, IValidation, IValidation2, IObjectClassInfo, IObjectClassInfo2, IFeatureClass, IGeoDataset, IFeatureClassWrite, IFeatureClassLoad, INetworkClass, ITableCapabilities, IFeatureClassManage
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IDataset, IDatasetEdit, IDatasetEditInfo, IDatasetAnalyze, ISchemaLock, IClass, ITable, IObjectClass, IClassSchemaEdit, IClassSchemaEdit2, IModelInfo, ITopologyClass, ISubtypes, IValidation, IValidation2, IObjectClassInfo, IObjectClassInfo2, IFeatureClass, IGeoDataset, IFeatureClassWrite, IFeatureClassLoad, INetworkClass, ITableCapabilities, IFeatureClassManage

Esri Feature Class object.

Remarks

A FeatureClass is an ObjectClass whose objects are features, that is, a feature class is a collection of spatial entities, modeled as objects with properties and behavior. All of the features in a feature class share the same attribute schema (they have the same set of named fields). The row objects handed out by a feature class support the IRow, IObject, and IFeature interfaces.

A feature class has a distinguished field of type Geometry, referred to as the shape field. The shape field stores the geometry (referred to as the shape property) for the features in the FeatureClass.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:: IObjectClass, Serialized Form

Constructor Summary
`FeatureClass(Object obj)` Construct a FeatureClass using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary
`void`	`addField(IField field)` Adds a field to this object class.
`void`	`addIndex(IIndex index)` Adds an index to this object class.
`void`	`addRule(IRule rule)` Adds the rule to the set of associated rules.
`void`	`addSubtype(int subtypeCode, String subtypeName)` Adds the subtype to the set of associated subtypes.
`void`	`alterAliasName(String name)` The alias name of the object class.
`void`	`alterClassExtensionCLSID(IUID classExtensionCLSID, IPropertySet classExtensionProperties)` Changes the class extension COM class associated with this database class.
`void`	`alterClassExtensionProperties(IPropertySet classExtensionProperties)` Changes the class extension properties associated with this object class.
`void`	`alterDefaultValue(String fieldName, Object value)` The default value of the object class field.
`void`	`alterDomain(String fieldName, IDomain domain)` The default domain of the object class field.
`void`	`alterFieldAliasName(String fieldName, String aliasName)` The alias name of the object class field.
`void`	`alterFieldModelName(String fieldName, String modelName)` The model name of the object class field.
`void`	`alterInstanceCLSID(IUID instanceCLSID)` Changes the instance COM class associated with this database class.
`void`	`alterModelName(String name)` The model name of the object class.
`void`	`alterRule(IRule rule)` Alter the existing validation rule.
`void`	`analyze(int tableComponents)` Analyze the data to update/generate DBMS statistics.
`boolean`	`canBypassEditSession()` Indicates if updates to objects can be safely made outside of an edit session.
`boolean`	`canBypassStoreMethod()` Indicates if updates to objects can bypass the Store method and OnChange notifications for efficiency.
`boolean`	`canCopy()` 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`	`changeSchemaLock(int schemaLock)` Changes a schema lock.
`IDataset`	`copy(String copyName, IWorkspace copyWorkspace)` Copies this dataset to a new dataset with the specified name.
`IFeature`	`createFeature()` Create a new feature, with a system assigned object ID and null property values.
`IFeatureBuffer`	`createFeatureBuffer()` Create a feature buffer that can be used with an insert cursor.
`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`	`deleteRule(IRule rule)` Deletes the rule from the set of associated rules.
`void`	`deleteSearchedRows(IQueryFilter queryFilter)` Delete the Rows in the database selected by the specified query.
`void`	`deleteSubtype(int subtypeCode)` Deletes the subtype from the set of associated subtypes.
`boolean`	`equals(Object o)` Compare this object with another
`int`	`featureCount(IQueryFilter queryFilter)` The number of features selected by the specified query.
`int`	`findField(String name)` The index of the field with the specified name.
`String`	`getAliasName()` The alias name of the object class.
`int`	`getAllowableComponents()` The allowable components to be analyzed.
`IField`	`getAreaField()` The geometry area field.
`String`	`getBrowseName()` The browse name of the dataset.
`String`	`getCategory()` The category of the dataset.
`IUID`	`getCLSID()` The GUID for the COM Class (CoClass) corresponding to instances of this object class.
`void`	`getCurrentSchemaLocks(IEnumSchemaLockInfo[] schemaLockInfo)` The list of current locks.
`int`	`getDefaultSubtypeCode()` The default subtype associated with the class.
`Object`	`getDefaultValue(int subtypeCode, String fieldName)` The default value for the associated attribute.
`IDomain`	`getDomain(int subtypeCode, String fieldName)` The domain given the subtype and field.
`IUID`	`getEXTCLSID()` The GUID for the COM Class (CoClass) corresponding to the class extension for this object class.
`Object`	`getExtension()` The extension for this object class.
`IPropertySet`	`getExtensionProperties()` The extension properties for this object class.
`IEnvelope`	`getExtent()` The extent of the GeoDataset.
`IFeature`	`getFeature(int iD)` Get the feature with the specified object ID.
`int`	`getFeatureClassID()` The unique ID for the Feature Class.
`IFeatureDataset`	`getFeatureDataset()` The feature dataset that contains the feature class.
`IFeatureCursor`	`getFeatures(Object fids, boolean recycling)` Deprecated. This method uses C style arrays which are not supported in the ArcGIS API for Java. It is replaced by `GeoDatabaseHelper.getFeatures(com.esri.arcgis.geodatabase.IFeatureClass, int[], boolean)`.
`int`	`getFeatureType()` The type of features in this feature class.
`IFields`	`getFields()` The fields collection for this object class.
`int`	`getFieldToWeightMapping(int fieldIndex)` The specified field to Weight mapping for the logical network.
`IName`	`getFullName()` The associated name object.
`IGeometricNetwork`	`getGeometricNetwork()` The geometric network in which this class participates.
`IIndexes`	`getIndexes()` The indexes collection for this object class.
`IField`	`getLengthField()` The geometry length field.
`String`	`getModelName()` The model name of the field.
`String`	`getName()` The name of the Dataset.
`int`	`getNetworkAncillaryRole()` The possible network ancillary roles of the contained Features.
`int`	`getObjectClassID()` The unique ID for the object class.
`String`	`getOIDFieldName()` The name of the field corresponding to the OID.
`IPropertySet`	`getPropertySet()` The set of properties for the dataset.
`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(Object oids, boolean recycling)` The cursor of rows based on a set of object ids.
`IEnumRule`	`getRules()` The rules associated with the class.
`IEnumRule`	`getRulesByField(String fieldName)` The rules associated with the attribute.
`IEnumRule`	`getRulesBySubtypeCode(int subtypeCode)` The rules associated with the subtype.
`String`	`getShapeFieldName()` The name of the default sShape field.
`int`	`getShapeType()` The type of the default Shape for the features in this feature class.
`ISpatialReference`	`getSpatialReference()` The spatial reference of the GeoDataset.
`IEnumDataset`	`getSubsets()` Datasets contained within this dataset.
`int`	`getSubtypeFieldIndex()` The subtype field index.
`String`	`getSubtypeFieldName()` The subtype field name.
`String`	`getSubtypeName(int subtypeCode)` The subtype name.
`IEnumSubtype`	`getSubtypes()` The subtypes associated with the class.
`ITopology`	`getTopology()` The Topology associated with the class.
`int`	`getType()` The type of the Dataset.
`double`	`getWeight()` The weight of the class in the topology.
`IWorkspace`	`getWorkspace()` The workspace containing this dataset.
`int`	`getXYRank()` The XY rank of the class in the topology.
`int`	`getZRank()` The Z rank of the class in the topology.
`int`	`hashCode()` the hashcode for this object
`IFeatureCursor`	`IFeatureClass_insert(boolean useBuffering)` Returns a cursor that can be used to insert new features.
`IFeatureCursor`	`IFeatureClass_update(IQueryFilter filter, boolean recycling)` Returns a cursor that can be used to update features selected by the specified query.
`ICursor`	`insert(boolean useBuffering)` Returns a cursor that can be used to insert new Rows.
`boolean`	`isBeingEdited()` True if the dataset is being edited.
`boolean`	`isCanEdit()` True if the dataset supports edit sessions with the ability to discard edits on save.
`boolean`	`isCanRedo()` True if the dataset supports edit sessions with the ability to redo undone operations.
`boolean`	`isCanSelect()` Indicates if the table supports selection.
`boolean`	`isCanUndo()` True if the dataset supports edit sessions with the ability to undo individual edit operations.
`boolean`	`isEventNotificationOnValidate()` Indicates if event notification is fired on validate.
`boolean`	`isHasOID()` Indicates if the class has an object identity (OID) field.
`boolean`	`isHasSubtype()` Indicates if the table has subtypes.
`boolean`	`isInTopology()` Indicates if the class is in a topology.
`boolean`	`isLoadOnlyMode()` Indicates if the featureclass is in load only mode.
`ICursor`	`ITable_search(IQueryFilter queryFilter, boolean recycling)` An object cursor that can be used to fetch row objects selected by the specified query.
`int`	`registerAsObjectClass(String suggestedOIDFieldName, String configKeyword)` Registers this class with the database, assigning it a class id and creating an object id column.
`void`	`removeFeature(IFeature feature)` Deletes a feature from the database, does not trigger OnDelete event.
`void`	`removeFeatures(ISet features)` Deletes a set of features from the database, does not trigger OnDelete events.
`void`	`rename(String name)` Renames this Dataset.
`int`	`rowCount(IQueryFilter queryFilter)` The number of Rows selected by the specified query.
`IFeatureCursor`	`search(IQueryFilter filter, boolean recycling)` Returns an object cursor that can be used to fetch feature objects 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(String name)` The browse name of the dataset.
`void`	`setDefaultSubtypeCode(int subtypeCode)` The default subtype associated with the class.
`void`	`setDefaultValue(int subtypeCode, String fieldName, Object value)` The default value for the associated attribute.
`void`	`setDomainByRef(int subtypeCode, String fieldName, IDomain domain)` The domain given the subtype and field.
`void`	`setLoadOnlyMode(boolean isInLoadMode)` Indicates if the featureclass is in load only mode.
`void`	`setModelName(String name)` The model name of the field.
`void`	`setSubtypeFieldName(String fieldName)` The subtype field name.
`ICursor`	`update(IQueryFilter queryFilter, boolean recycling)` Returns a cursor that can be used to update Rows selected by the specified query.
`void`	`updateExtent()` Updates the XY, M, Z extent.
`void`	`updateSearchedRows(IQueryFilter queryFilter, IRowBuffer buffer)` Update the Rows in the database selected by the specified query.
`ISelectionSet`	`validate(IQueryFilter selection, IWorkspace workspace)` Validates the selection.
`ISelectionSet`	`validateSelection(ISelectionSet selection, IWorkspace workspace)` Validates the selection.
`ISet`	`validateSet(ISet selection)` Validates the set.
`void`	`writeFeature(IFeature feature)` Stores a feature to the database, does not trigger OnStore event.
`void`	`writeFeatures(ISet features)` Stores a set of features to the database, does not trigger OnStore events.

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

FeatureClass

public FeatureClass(Object obj)
             throws IOException

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

   * 
FeatureClass o = (FeatureClass)obj; // will not work 

 
FeatureClass o = new FeatureClass(obj); // Use this constructor instead

* @param obj an object returned from ArcGIS Engine or Server

Throws:: IOException - if there are interop problems FeatureClass theFeatureClass = (FeatureClass) obj;

Method Detail

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

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 IDataset

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

getFullName

public IName getFullName()
                  throws IOException,
                         AutomationException

The associated name object.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getFullName in interface IDataset

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

getBrowseName

public String getBrowseName()
                     throws IOException,
                            AutomationException

The browse name of the dataset.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getBrowseName in interface IDataset

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

setBrowseName

public void setBrowseName(String name)
                   throws IOException,
                          AutomationException

The browse name of the dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setBrowseName in interface IDataset

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.

Remarks

The Type property returns the an esriDatasetType value indicating the dataset type, such as esriDTTable or esriDTFeatureClass.

Example:


// Assume we have a reference to an IfeatureClass (pFeatureClass)

      IDataset pDataset = null;


      pDataset = new IDatasetProxy(pFeatureClass);


      System.out.println(pDataset.getName() + " " + pDataset.getType());


      if(pFeatureClass != null){


        pDataset = pFeatureClass.getFeatureDataset();


        System.out.println(pDataset.getName() + " " + pDataset.getType());


      }


      pDataset = new IDatasetProxy(pDataset.getWorkspace());


     System.out.println(pDataset.getName() + " " + 
pDataset.getType());

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getType in interface IDataset

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.

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. In addition to this, returned strings are localized, meaning that code relying on a specific string being provided may fail when deployed with a different version of ArcGIS than it was developed with, or when deployed to a client using a different language than it was developed with.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getCategory in interface IDataset

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

getSubsets

public IEnumDataset getSubsets()
                        throws IOException,
                               AutomationException

Datasets contained within this dataset.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSubsets in interface IDataset

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

getWorkspace

public IWorkspace getWorkspace()
                        throws IOException,
                               AutomationException

The workspace containing this dataset.

Description

The Workspace property returns the containing workspace for this dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getWorkspace in interface IDataset

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

getPropertySet

public IPropertySet getPropertySet()
                            throws IOException,
                                   AutomationException

The set of properties for the dataset.

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.

Most datasets do not implement this property and will either raise an error or return a null value if it's called. There are a handful of exceptions that will return property sets; these include the datasets from file geodatabases (as mentioned above) and coverages.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getPropertySet in interface IDataset

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.

canCopy

public boolean canCopy()
                throws IOException,
                       AutomationException

True if this dataset can be copied.

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.

The CanCopy method is supported by:

CAD Drawings
Coverages
DBase Tables
Info Tables
Raster Datasets
SDC datasets
SDC Network Datasets
Shapefiles
Shapefile Network Datasets

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: canCopy in interface IDataset

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

copy

public IDataset copy(String copyName,
                     IWorkspace copyWorkspace)
              throws IOException,
                     AutomationException

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

Remarks

IDataset::Copy should only be used with datasets from file-based data sources, such as shapefiles and coverages.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: copy in interface IDataset

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

canDelete

public boolean canDelete()
                  throws IOException,
                         AutomationException

True if this dataset can be deleted.

Remarks

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: canDelete in interface IDataset

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

delete

public void delete()
            throws IOException,
                   AutomationException

Deletes this dataset.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: delete in interface IDataset

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

canRename

public boolean canRename()
                  throws IOException,
                         AutomationException

True if this dataset can be renamed.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: canRename in interface IDataset

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

rename

public void rename(String name)
            throws IOException,
                   AutomationException

Renames this Dataset.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: rename in interface IDataset

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

isBeingEdited

public boolean isBeingEdited()
                      throws IOException,
                             AutomationException

True if the dataset is being edited.

Remarks

Once an edit session has been started on a workspace, the IsBeingEdited method on the IDatasetEdit interface can be used to determine if a particular dataset is participating in the edit session.

The reasons why a dataset may not participate include the connected user has no privileges or permission to edit the dataset, the connected user is not licensed to edit this type of dataset, or the dataset is not versioned but a versioned edit session has been started (or vice versa).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isBeingEdited in interface IDatasetEdit

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

isCanEdit

public boolean isCanEdit()
                  throws IOException,
                         AutomationException

True if the dataset supports edit sessions with the ability to discard edits on save.

Remarks



This property is to be used within an active edit session, results cannot be guaranteed if called on a dataset outside of an edit session.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isCanEdit in interface IDatasetEditInfo

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

isCanUndo

public boolean isCanUndo()
                  throws IOException,
                         AutomationException

True if the dataset supports edit sessions with the ability to undo individual edit operations.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isCanUndo in interface IDatasetEditInfo

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

isCanRedo

public boolean isCanRedo()
                  throws IOException,
                         AutomationException

True if the dataset supports edit sessions with the ability to redo undone operations.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isCanRedo in interface IDatasetEditInfo

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

analyze

public void analyze(int tableComponents)
             throws IOException,
                    AutomationException

Analyze the data to update/generate DBMS statistics.

Remarks

When applied to a feature dataset, Analyze updates the statistics for all of the tables.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: analyze in interface IDatasetAnalyze

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

getAllowableComponents

public int getAllowableComponents()
                           throws IOException,
                                  AutomationException

The allowable components to be analyzed.

Remarks

The AllowableComponents property indicates which parts of the table or feature class can be analyzed. The returned value is based on the esriTableComponents enumeration. Members from this enumeration can be bitwise or�d together.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getAllowableComponents in interface IDatasetAnalyze

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

changeSchemaLock

public void changeSchemaLock(int schemaLock)
                      throws IOException,
                             AutomationException

Changes a schema lock.

Remarks

There are two kinds of schema locks: shared and exclusive. Shared schema locks are applied automatically by the geodatabase when accessing a dataset and are removed when all references to the dataset are removed. For this reason, it's not necessary to explicitly apply or remove shared schema locks. There is no limit to the number of shared schema locks a dataset or object can have at any given time.

In contrast to shared schema locks, exclusive schema locks are controlled by the developer or ArcGIS application, such as ArcMap or ArcCatalog. An exclusive lock is used to lock a geodatabase dataset or object from use by others to make the necessary changes to it. An exclusive lock is promoted from a shared lock and demoted back to a shared lock when no longer needed. The presence of additional shared schema locks on a dataset or object prevents an exclusive schema lock from being applied and precludes the ability to make changes to the underlying dataset and its schema while it is in use. Only one exclusive schema lock is allowed per dataset. As opposed to shared schema locks, exclusive schema locks are not applied or removed automatically; it is the responsibility of the developer to apply or remove exclusive schema locks.

Limit the scope of exclusive schema locks to the operation that requires the lock. Gather the necessary information to perform the action, obtain the exclusive lock, make the change, and release the lock. Some examples of operations for which an exclusive schema lock should be obtained include:

Modifications to attribute domains, such as adding or removing values from a coded value domain or changing the range for range domains

Adding or deleting a field from a feature class or object class
Associating a class extension with a feature class
Creating a topology, geometric network, network dataset, terrain, schematic dataset, representation, or cadastral fabric on a set of feature classes
Any use of the IClassSchemaEdit interface
Putting a feature class into and taking it out of load-only mode with the IFeatureClassLoad.LoadOnlyMode method
Managing (creating, deleting, or modifying) spatial and attribute indexes

Once the action requiring an exclusive schema lock is complete, the exclusive schema lock must be demoted to a shared lock. This includes when errors are raised during the schema modification, for example, consider the case where a field is being deleted from a feature class. To delete the field, an exclusive schema lock is obtained. However, on the call to DeleteField, an error is thrown; that is, the field being deleted is a required field, such as the ObjectID field. In the handling of the error, the exclusive schema lock must be demoted to a shared lock before proceeding.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: changeSchemaLock in interface ISchemaLock

Parameters:: schemaLock - A com.esri.arcgis.geodatabase.esriSchemaLock constant (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getCurrentSchemaLocks

public void getCurrentSchemaLocks(IEnumSchemaLockInfo[] schemaLockInfo)
                           throws IOException,
                                  AutomationException

The list of current locks.

Remarks

The ISchemaLockInfo interface is used in concert with ISchemaLock to provide information about a schema lock, for example, whether it is shared or exclusive and for ArcSDE geodatabases, the name of the user who has the lock. Note that there will always be at least one schema lock on the dataset. Also note that by checking the schema locks on a dataset a shared schema lock is applied to the data.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getCurrentSchemaLocks in interface ISchemaLock

Parameters:: schemaLockInfo - A reference to a com.esri.arcgis.geodatabase.IEnumSchemaLockInfo (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

findField

public int findField(String name)
              throws IOException,
                     AutomationException

The index of the field with the specified name.

Remarks

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

Developers working with SDE should be aware of qualified field names and their impact on calls to FindField. For more information, see the IFields2 interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: findField in interface IClass

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

getFields

public IFields getFields()
                  throws IOException,
                         AutomationException

The fields collection for this object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getFields in interface IClass

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

getIndexes

public IIndexes getIndexes()
                    throws IOException,
                           AutomationException

The indexes collection for this object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getIndexes in interface IClass

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

addField

public void addField(IField field)
              throws IOException,
                     AutomationException

Adds a field to this object class.

Remarks

Prior to adding a new field to a class, an exclusive schema lock should be obtained using the ISchemaLock interface.

Attempting to add a new field that does not allow null values will fail, if the class already has data in it. The only solution is to recreate the class with the non-nullable field, then copy the rows from the original class into the new class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: addField in interface IClass

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

deleteField

public void deleteField(IField field)
                 throws IOException,
                        AutomationException

Deletes a field from this object class.

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

Prior to deleting a field from a class, an exclusive schema lock should be obtained using the ISchemaLock interface.

Example:

// Assume we have a reference to a FeatureClass (pFC)

      IFields pFields;

      IField pField;



      pFields = pFC.getFields();

      pField = pFields.getField(pFields.findField("MyField"));



      pFC.deleteField(pField);

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: deleteField in interface IClass

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

addIndex

public void addIndex(IIndex index)
              throws IOException,
                     AutomationException

Adds an index to this object class.

Remarks

Prior to adding a new index to a class, an exclusive schema lock should be obtained using the ISchemaLock interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: addIndex in interface IClass

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

deleteIndex

public void deleteIndex(IIndex index)
                 throws IOException,
                        AutomationException

Deletes an index from this object class.

Remarks

Prior to deleting an index from a class, an exclusive schema lock should be obtained using the ISchemaLock interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: deleteIndex in interface IClass

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

isHasOID

public boolean isHasOID()
                 throws IOException,
                        AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isHasOID in interface IClass

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

getOIDFieldName

public String getOIDFieldName()
                       throws IOException,
                              AutomationException

The name of the field corresponding to the OID.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getOIDFieldName in interface IClass

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

getCLSID

public IUID getCLSID()
              throws IOException,
                     AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getCLSID in interface IClass

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

getEXTCLSID

public IUID getEXTCLSID()
                 throws IOException,
                        AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getEXTCLSID in interface IClass

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

getExtension

public Object getExtension()
                    throws IOException,
                           AutomationException

The extension for this object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getExtension in interface IClass

Returns:: A reference to another Object (IUnknown)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getExtensionProperties

public IPropertySet getExtensionProperties()
                                    throws IOException,
                                           AutomationException

The extension properties for this object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getExtensionProperties in interface IClass

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.

createRow

public IRow createRow()
               throws IOException,
                      AutomationException

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

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: createRow in interface ITable

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

getRow

public IRow getRow(int oID)
            throws IOException,
                   AutomationException

The row from the database with the specified object ID.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getRow in interface ITable

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

getRows

public ICursor getRows(Object oids,
                       boolean recycling)
                throws IOException,
                       AutomationException

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

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.

The oids parameter should be passed an integer array. For example:

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

// Get a recycling cursor for the OID array.

int[] oids = new int[] { 10844, 10853, 10871 };

ICursor cursor = table.getRows(oids, true);

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

createRowBuffer

public IRowBuffer createRowBuffer()
                           throws IOException,
                                  AutomationException

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

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: createRowBuffer in interface ITable

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

updateSearchedRows

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

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

Description

This method will edit the rows matching the query filter's constraints. The values in each row will be replaced with the corresponding field's value in the provided row buffer. The fields being edited should be specified in the query filter's SubFields property. If the row buffer contains null values, and the SubFields property is not properly set, the row's values will be overwritten with the row buffer's null values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

deleteSearchedRows

public void deleteSearchedRows(IQueryFilter queryFilter)
                        throws IOException,
                               AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: deleteSearchedRows in interface ITable

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

rowCount

public int rowCount(IQueryFilter queryFilter)
             throws IOException,
                    AutomationException

The number of Rows selected by the specified query.

Product Availability

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

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:: 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 IOException,
                             AutomationException

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

Product Availability

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

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

update

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

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

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 complex objects and features.

When using cursors within an edit session, they should always be scoped to edit operations. In other words, a cursor should be created after an edit operation has begun and should not be used once that edit operation has been stopped or aborted.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

insert

public ICursor insert(boolean useBuffering)
               throws IOException,
                      AutomationException

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

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 complex objects use the CreateRow and Store methods to achieve polymorphism, and there is no difference in performance in these cases.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: insert in interface ITable

Parameters:: useBuffering - The useBuffering (in)
Returns:: A reference to a com.esri.arcgis.geodatabase.ICursor
Throws:: 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 IOException,
                            AutomationException

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

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).

The selType parameter determines the type of selection set that will be created: an ID set, a snapshot, or a hybrid. See the ISelectionSet interface for a comparison of the three types.

When calling Select the selectionContainer parameter is no longer required. A null value should be passed as this parameter.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: select in interface IFeatureClass
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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IQueryFilter

getObjectClassID

public int getObjectClassID()
                     throws IOException,
                            AutomationException

The unique ID for the object class.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getObjectClassID in interface IObjectClass

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

getRelationshipClasses

public IEnumRelationshipClass getRelationshipClasses(int role)
                                              throws IOException,
                                                     AutomationException

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

Product Availability

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

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getAliasName

public String getAliasName()
                    throws IOException,
                           AutomationException

The alias name of the object class.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getAliasName in interface IObjectClass

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

registerAsObjectClass

public int registerAsObjectClass(String suggestedOIDFieldName,
                                 String configKeyword)
                          throws IOException,
                                 AutomationException

Registers this class with the database, assigning it a class id and creating an object id column.

Description

The RegisterAsObjectClass method will register a table or feature class (ArcSDE layer) in the database with the Geodatabase. The act of registering the data as an object class will create records for the object class in the Geodatabase system tables and assign the object class a unique ID. Once a table or SDE layer is registered as an object class, it can participate in rules, topological relationships and relationships.

When registering a table or ArcSDE layer as an object class, an ObjectID field must be added to it. This field will contain the object IDs which uniquely identify each feature in the class. The object IDs for existing data will automatically be generated. Once a table or ArcSDE layer has been registered as an object class in the Geodatabase, it cannot be unregistered.

RegisterAsObjectClass takes two arguments: the name of the object ID field, and the ArcSDE configuration keyword to use for storage of the new data that is inserted into the object ID field. RegisterAsObjectClass returns a long which is the object class ID assigned to the newly registered class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: registerAsObjectClass in interface IClassSchemaEdit

Parameters:: suggestedOIDFieldName - The suggestedOIDFieldName (in); configKeyword - The configKeyword (in)
Returns:: The objectClassID
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IObjectClass

alterInstanceCLSID

public void alterInstanceCLSID(IUID instanceCLSID)
                        throws IOException,
                               AutomationException

Changes the instance COM class associated with this database class.

Description

The AlterInstanceCLSID is used to change the behavior class for an object class in the Geodatabase. For example, you may have a class that stores simple feature objects and you want to change it to implement a custom object that you have developed. You use the AlterInstanceCLSID to do so.

Remarks

AlterInstanceCLSID will try to instantiate the object for the CLSID that you provide. If it fails to instantiate it, the method will fail. Therefore, you must have the DLL which has the implementation of your custom object registered on your system before you call AlterInstanceCLSID.

Before you QI for AlterInstanceCLSID, you will have had to open the object class. So, if this fails because you no longer have the DLL registered on your system, then you must use the IFeatureWorkspaceSchemaEdit interface to alter the instance CLSID.

No additional checking is done beyond instantiating the instance object. If the object class does not have the fields required for supporting the custom object then your class may not function with its new instance CLSID.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: alterInstanceCLSID in interface IClassSchemaEdit

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

alterClassExtensionCLSID

public void alterClassExtensionCLSID(IUID classExtensionCLSID,
                                     IPropertySet classExtensionProperties)
                              throws IOException,
                                     AutomationException

Changes the class extension COM class associated with this database class.

Description

The AlterClassExtensionCLSID method is used to change the class extension for an object class in the Geodatabase. For example, you may have a class to which you want to associate a class extension that you have developed. You use the AlterClassExtensionCLSID to do so.

Remarks

AlterClassExtensionCLSID will try to instantiate the object for the class extension that you provide. If it fails to instantiate it, the method will fail. Therefore, you must have the DLL which has the implementation of your class extension registered on your system before you call AlterClassExtensionCLSID.

Before you QI for AlterClassExtensionCLSID, you will have had to open the object class. So, if this fails because you no longer have the DLL registered on your system for a class extension that is already associated with the class, then you must use the IFeatureWorkspaceSchemaEdit interface to alter the class extension CLSID.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: alterClassExtensionCLSID in interface IClassSchemaEdit

Parameters:: classExtensionCLSID - A reference to a com.esri.arcgis.system.IUID (in); classExtensionProperties - 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.

alterAliasName

public void alterAliasName(String name)
                    throws IOException,
                           AutomationException

The alias name of the object class.

Description

Alters 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 AlterAliasName method sets the alias name for the object class. The alias name can be returned using the IObjectClass interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: alterAliasName in interface IClassSchemaEdit

Parameters:: name - The name (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IObjectClass

alterFieldAliasName

public void alterFieldAliasName(String fieldName,
                                String aliasName)
                         throws IOException,
                                AutomationException

The alias name of the object class field.

Description

Alters the alias name for a field in the object class.

Remarks

Fields in object classes in a Geodatabase can have between one and three names. The name of the field, which is the same as the name of the field in 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 fields independent of the true name or alias name.

The AlterFieldAliasName method sets the alias name for a field in the object class. The alias name can be returned using the IField interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: alterFieldAliasName in interface IClassSchemaEdit

Parameters:: fieldName - The fieldName (in); aliasName - The aliasName (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IField

alterModelName

public void alterModelName(String name)
                    throws IOException,
                           AutomationException

The model name of the object class.

Description

Alters the model name for the object class.

Remarks

The AlterModelName method sets the model name for the object class. The model name can be returned using the IModelInfo interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: alterModelName in interface IClassSchemaEdit

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

alterFieldModelName

public void alterFieldModelName(String fieldName,
                                String modelName)
                         throws IOException,
                                AutomationException

The model name of the object class field.

Description

Alters the model name for a field in the object class.

Remarks

The AlterFieldModelName method sets the model name for a field in the object class. The model name can be returned using the IModelInfo interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: alterFieldModelName in interface IClassSchemaEdit

Parameters:: fieldName - The fieldName (in); modelName - The modelName (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IField

alterDomain

public void alterDomain(String fieldName,
                        IDomain domain)
                 throws IOException,
                        AutomationException

The default domain of the object class field.

Remarks

Domains are used in the Geodatabase to validate the contents of fields in an object class. For example, you can use a domain to specify a valid range of values, or a valid set of values for a particular field in an object class. You can assign domains to a field in an object class at either the class level, or the subtype level. The AlterDomain method on IClassSchemaEdit allows you to set a domain for a field at the class level.

AlterDomain takes as arguments the name of the field you want to associate a domain with as a string, and the domain you are associating as an IDomain. You can get an enumeration of domains in a workspace by calling the Domains or DomainsByFieldType methods on the IWorkspaceDomains interface.

Once a domain is associated with a field in your object class, the values in that field will be validated against that domain when a row in the object class is validated with the IValidate interface, or the Validate Selection command in the Editor.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: alterDomain in interface IClassSchemaEdit

Parameters:: fieldName - The fieldName (in); domain - A reference to a com.esri.arcgis.geodatabase.IDomain (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IField

alterDefaultValue

public void alterDefaultValue(String fieldName,
                              Object value)
                       throws IOException,
                              AutomationException

The default value of the object class field.

Remarks

You can assign a default value to a field in an object class at either the class level, or the subtype level. The AlterDefaultValue method on IClassSchemaEdit allows you to set a default value for a field at the class level.

AlterDefaultValue takes as arguments the name of the field you want to associate a default value with as a string, and the default value you are associating as a variant. AlterDefaultValue will fail if the default value cannot be stored in the field.

Once a default value is associated with a field in your object class, you can use the InitDefaultValues method on IRowSubtypes to populate the fields in a object in your object class with its default value. This method is most often called after you have created a new feature or object in the object class, and before storing it.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: alterDefaultValue in interface IClassSchemaEdit

Parameters:: fieldName - The fieldName (in); value - A Variant (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IField

alterClassExtensionProperties

public void alterClassExtensionProperties(IPropertySet classExtensionProperties)
                                   throws IOException,
                                          AutomationException

Changes the class extension properties associated with this object class.

Description

The AlterClassExtensionProperties method is used to change the class extension properties for an object class in the Geodatabase that already has a class extension associated with it.

Remarks

AlterClassExtensionProperties takes as an argument the new properties for the class extension as an IPropertySet.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: alterClassExtensionProperties in interface IClassSchemaEdit2

Parameters:: classExtensionProperties - 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.
See Also:: IPropertySet

getModelName

public String getModelName()
                    throws IOException,
                           AutomationException

The model name of the field.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getModelName in interface IModelInfo

Returns:: The name
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IObjectClass, IField

setModelName

public void setModelName(String name)
                  throws IOException,
                         AutomationException

The model name of the field.

Remarks

Sets the model name for the field or object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setModelName in interface IModelInfo

Parameters:: name - The name (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IObjectClass, IField

getTopology

public ITopology getTopology()
                      throws IOException,
                             AutomationException

The Topology associated with the class.

Remarks

Returns the Topology this FeatureClass is associated with. A FeatureClass can be associated with only 1 Topology.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getTopology in interface ITopologyClass

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

isInTopology

public boolean isInTopology()
                     throws IOException,
                            AutomationException

Indicates if the class is in a topology.

Remarks

Returns True if the FeatureClass participates in a topology and False if the FeatureClass does not participate in a Topology.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isInTopology in interface ITopologyClass

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

getWeight

public double getWeight()
                 throws IOException,
                        AutomationException

The weight of the class in the topology.

Remarks

The Weight of the feature class is a long between 1 and 10. This property is not currently implemented.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getWeight in interface ITopologyClass

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

getXYRank

public int getXYRank()
              throws IOException,
                     AutomationException

The XY rank of the class in the topology.

Remarks

The XYRank of a feature class in the topology is a long between 1 and 50. It represents the relative accuracy of the features in the feature class with respect to their surrounding features.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getXYRank in interface ITopologyClass

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

getZRank

public int getZRank()
             throws IOException,
                    AutomationException

The Z rank of the class in the topology.

Remarks

The ZRank of a feature class in the topology is a long between 1 and 50. It represents the relative accuracy of the features in the feature class with respect to their surrounding features. If a feature class is not Z aware it will return a ZRank of zero.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getZRank in interface ITopologyClass

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

isEventNotificationOnValidate

public boolean isEventNotificationOnValidate()
                                      throws IOException,
                                             AutomationException

Indicates if event notification is fired on validate.

Remarks

EventNotificationOnValidate returns a Boolean value indicating if the ITopologyClassEvents::OnValidate event is broadcast when the Topology of the participating feature class is validated. The EventNotificationOnValidate property is only set when the feature class is added to the Topology and can only be set if the Topology is created programmatically. Feature classes participating in topologies created with the use of the Topology Wizard in ArcCatalog, return False for EventNotificationOnValidate.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isEventNotificationOnValidate in interface ITopologyClass

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

isHasSubtype

public boolean isHasSubtype()
                     throws IOException,
                            AutomationException

Indicates if the table has subtypes.

Description

HasSubtype property returns a boolean value whether the given object class has subypes or not.

Remarks

This property returns a boolean value indicating if the object class has subtypes defined. If there are no subtypes defined, it returns FALSE , if there are subypes defined it returns TRUE.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isHasSubtype in interface ISubtypes

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

getDefaultSubtypeCode

public int getDefaultSubtypeCode()
                          throws IOException,
                                 AutomationException

The default subtype associated with the class.

Description

DefaultSubtypeCode property sets and returns the default subtype code for the given object class.

Remarks

This property sets or returns the value of the default subtype code for the associated class.

Example:


String aPath = "shape path";

String aName = "shape name";

IWorkspaceFactory shapefileFactory = new ShapefileWorkspaceFactory();

IFeatureWorkspace featureWorkspace = 

new IFeatureWorkspaceProxy(shapefileFactory.openFromFile(aPath,0));

IFeatureClass featureClass = 

new IFeatureClassProxy(featureWorkspace.openFeatureClass(aName));

ISubtypes pSubtypes = new ISubtypesProxy(featureClass);

long lDefCode = pSubtypes.getDefaultSubtypeCode();

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getDefaultSubtypeCode in interface ISubtypes

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

setDefaultSubtypeCode

public void setDefaultSubtypeCode(int subtypeCode)
                           throws IOException,
                                  AutomationException

The default subtype associated with the class.

Description

DefaultSubtypeCode property sets the default subtype code for the given object class.

Example:


String aPath = "shape path";

String aName = "shape name";

IWorkspaceFactory shapefileFactory = new ShapefileWorkspaceFactory();

IFeatureWorkspace featureWorkspace = 

new IFeatureWorkspaceProxy(shapefileFactory.openFromFile(aPath,0));

IFeatureClass featureClass = 

new IFeatureClassProxy(featureWorkspace.openFeatureClass(aName));

ISubtypes pSubtypes = new ISubtypesProxy(featureClass);

long lDefCode = pSubtypes.getDefaultSubtypeCode();

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setDefaultSubtypeCode in interface ISubtypes

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

getDefaultValue

public Object getDefaultValue(int subtypeCode,
                              String fieldName)
                       throws IOException,
                              AutomationException

The default value for the associated attribute.

Product Availability

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

Specified by:: getDefaultValue in interface ISubtypes

Parameters:: subtypeCode - The subtypeCode (in); fieldName - The fieldName (in)
Returns:: A Variant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setDefaultValue

public void setDefaultValue(int subtypeCode,
                            String fieldName,
                            Object value)
                     throws IOException,
                            AutomationException

The default value for the associated attribute.

Product Availability

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

Specified by:: setDefaultValue in interface ISubtypes

Parameters:: subtypeCode - The subtypeCode (in); fieldName - The fieldName (in); value - A Variant (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDomain

public IDomain getDomain(int subtypeCode,
                         String fieldName)
                  throws IOException,
                         AutomationException

The domain given the subtype and field.

Product Availability

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

Specified by:: getDomain in interface ISubtypes

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

setDomainByRef

public void setDomainByRef(int subtypeCode,
                           String fieldName,
                           IDomain domain)
                    throws IOException,
                           AutomationException

The domain given the subtype and field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setDomainByRef in interface ISubtypes

Parameters:: subtypeCode - The subtypeCode (in); fieldName - The fieldName (in); domain - A reference to a com.esri.arcgis.geodatabase.IDomain (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSubtypeFieldName

public String getSubtypeFieldName()
                           throws IOException,
                                  AutomationException

The subtype field name.

Remarks

The SubtypeFieldName property is used to either set or return string value for the field that contains the subtypes for this object class. To assign the subtype field, set SubtypeFieldName equal to the name of the field:

Example:

String aPath = "shape path";

String aName = "shape name";

IWorkspaceFactory shapefileFactory = new ShapefileWorkspaceFactory();

IFeatureWorkspace featureWorkspace = 

new IFeatureWorkspaceProxy(shapefileFactory.openFromFile(aPath,0));          

IFeatureClass featureClass = 

new FeatureClassProxy(featureWorkspace.openFeatureClass(aName));

ISubtypes pSubtypes = new ISubtypesProxy(featureClass);

pSubtypes.setSubtypeFieldName("TYPECODE"); 



//The  Subtype field can be  reset by assigning an  empty string to SubtypeFieldName:; 

pSubtypes.setSubtypeFieldName("");

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSubtypeFieldName in interface ISubtypes

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

setSubtypeFieldName

public void setSubtypeFieldName(String fieldName)
                         throws IOException,
                                AutomationException

The subtype field name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setSubtypeFieldName in interface ISubtypes

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

getSubtypeFieldIndex

public int getSubtypeFieldIndex()
                         throws IOException,
                                AutomationException

The subtype field index.

Description

SubtypeFieldIndex property returns the index of the subtype field.

Remarks

This property returns the index of the field in the object class which stores the subtype codes. The field index is returned as a Long.

Example:

String aPath = "shape path";

String aName = "shape name";

IWorkspaceFactory shapefileFactory = new ShapefileWorkspaceFactory();

IFeatureWorkspace featureWorkspace = 

new IFeatureWorkspaceProxy(shapefileFactory.openFromFile(aPath,0));

IFeatureClass featureClass = 

new IFeatureClassProxy(featureWorkspace.openFeatureClass(aName));

ISubtypes pSubtypes = new ISubtypesProxy(featureClass);

int subFldIndex = pSubtypes.getSubtypeFieldIndex();

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSubtypeFieldIndex in interface ISubtypes

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

getSubtypeName

public String getSubtypeName(int subtypeCode)
                      throws IOException,
                             AutomationException

The subtype name.

Product Availability

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

Specified by:: getSubtypeName in interface ISubtypes

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

getSubtypes

public IEnumSubtype getSubtypes()
                         throws IOException,
                                AutomationException

The subtypes associated with the class.

Description

Subtypes returns a IEnumSubtype populated with all of the subtypes for the given object class.

Remarks

Every ObjectClass has a default subtype code. If the user has not explicitly specified a default subtype or a subtype field, then DefaultSubtypeCode will return a subtype code of zero. Additionally, you can query the HasSubtype property; a value of False indicates an absence of a default subtype code, True indicates the presence of a default subtype code.

If the client instead asks for the enumeration of subtypes associated with an ObjectClass and no subtype has been previously added to the ObjectClass, then the enumerator will contain a single entry with a code of zero. The subtype field index value will be �1 if a default subtype has not been previously specified. Subtypes may only be short or long integers (esriFieldTypeSmallInteger or esriFieldTypeInteger). When setting the default subtype code, if one already exists, then it will be deleted. A subtype field must have been specified prior to setting the subtype code value.

Every type of field, except for esriFieldTypeShape, may have a default value. When setting the default value (which my be assigned on a subtype basis), it will be checked against the field�s associated Domain (if one exists) for validity.

This property returns all of the subtypes for the associated object class. Subtypes returns an IEnumSubtype enumeration which you can loop through to get all of the subtypes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSubtypes in interface ISubtypes

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

addSubtype

public void addSubtype(int subtypeCode,
                       String subtypeName)
                throws IOException,
                       AutomationException

Adds the subtype to the set of associated subtypes.

Description

AddSubtype adds the subtype to the set of subtypes for the given object class with the subtype code and subtype name given.

Remarks

AddSubtype will create a new subtype for the associated object class. This method requires a subtype code as a Long and a subtype name as a String. Before adding subtypes, use the ISubtypes::SubtypeFieldName property to set the subtypes field.

Once created, you can use the ISubtypes::DefaultValue property to set default values for this subtypes fields, and the ISubtypes::Domain property to assign domains to fields for the subtype.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: addSubtype in interface ISubtypes

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

deleteSubtype

public void deleteSubtype(int subtypeCode)
                   throws IOException,
                          AutomationException

Deletes the subtype from the set of associated subtypes.

Description

DeleteSubtype takes the subtype code parameter to remove the subtype from the set of subtypes of the given object class.

Remarks

DeleteSubtype will delete a subtype for the associated object class. Calling DeleteSubtype will also remove any reference to that subtype in the geodatabase.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: deleteSubtype in interface ISubtypes

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

getRules

public IEnumRule getRules()
                   throws IOException,
                          AutomationException

The rules associated with the class.

Description

Rules is a property that returns a IEnumRule object that contains all of the rules associated with the object class.

Remarks

Property Rules returns a IEnumRule enumerator hydrated with all of the rules associated with the object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getRules in interface IValidation

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

getRulesByField

public IEnumRule getRulesByField(String fieldName)
                          throws IOException,
                                 AutomationException

The rules associated with the attribute.

Product Availability

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

Specified by:: getRulesByField in interface IValidation

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

getRulesBySubtypeCode

public IEnumRule getRulesBySubtypeCode(int subtypeCode)
                                throws IOException,
                                       AutomationException

The rules associated with the subtype.

Product Availability

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

Specified by:: getRulesBySubtypeCode in interface IValidation

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

addRule

public void addRule(IRule rule)
             throws IOException,
                    AutomationException

Adds the rule to the set of associated rules.

Description

This method is deprecated. Use a rule-specific method to add rules (i.e. IClassSchemaEdit.AlterDomain for attribute rules, IGeometricNetwork.AddRule for connectivity rules, IRelationshipClass.AddRelationshipRule for relationship rules).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: addRule in interface IValidation

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

deleteRule

public void deleteRule(IRule rule)
                throws IOException,
                       AutomationException

Deletes the rule from the set of associated rules.

Description

This method is deprecated. Use a rule-specific method to delete rules (i.e. IClassSchemaEdit.AlterDomain for attribute rules, IGeometricNetwork.DeleteRule for connectivity rules, IRelationshipClass.DeleteRelationshipRule for relationship rules).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: deleteRule in interface IValidation

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

validate

public ISelectionSet validate(IQueryFilter selection,
                              IWorkspace workspace)
                       throws IOException,
                              AutomationException

Validates the selection.

Description

This method creates a selection set that contains the underlying class' invalid objects.

A query filter can be provided to validate a portion of the class' objects, but passing a null value will evaluate all of the class' objects.

The Workspace parameter indicates where the selection set is to be created. In most cases, a null value can be used, indicating that the class' workspace be used. If necessary, a scratch workspace may also be used.

Remarks

Validate on a row occurs in five steps:

Validate the subtype
Validate the attribute rules
Validate the network connectivity rules (if network feature)
Validate the relationship rules
Perform custom validation (using optional class extension)

The validate process stops once a row is found invalid. For example, if a network feature violates an attribute rule, the validation process stops and the feature's network connectivity rules are not evaluated until the attribute rule violation is corrected.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: validate in interface IValidation

Parameters:: selection - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in); workspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
Returns:: A reference to a com.esri.arcgis.geodatabase.ISelectionSet
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

validateSelection

public ISelectionSet validateSelection(ISelectionSet selection,
                                       IWorkspace workspace)
                                throws IOException,
                                       AutomationException

Validates the selection.

Description

This method creates a selection set that contains the underlying class' invalid objects.

A selection set must be passed to the first parameter, indicating that a subset of the class' objects should be evaluated. Unlike the query filter parameter of the Validate method, this parameter requires a valid selection set, and passing a null value will cause the method to fail.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: validateSelection in interface IValidation

Parameters:: selection - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in); workspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
Returns:: A reference to a com.esri.arcgis.geodatabase.ISelectionSet
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

validateSet

public ISet validateSet(ISet selection)
                 throws IOException,
                        AutomationException

Validates the set.

Description

ValidateSet function takes the ISet parameter and validates that set based on the rules associated with the object class. It returns a ISet object containing all of the invalid features that it found in that set.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: validateSet in interface IValidation

Parameters:: selection - A reference to a com.esri.arcgis.system.ISet (in)
Returns:: A reference to a com.esri.arcgis.system.ISet
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

alterRule

public void alterRule(IRule rule)
               throws IOException,
                      AutomationException

Alter the existing validation rule.

Remarks

The AlterRule method is used to change the characteristics of an existing rule. This is currently implemented to change a subset of properties for connectivity rules only. These properties are:

minimum and maximum cardinalities
default junction for junction connectivity rules
default junction classID for edge connectivity rules
default junction subtype code for edge connectivity rules

To alter other properties of a connectivity rule, the rule must be deleted and recreated with the appropriate changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: alterRule in interface IValidation2

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

canBypassStoreMethod

public boolean canBypassStoreMethod()
                             throws IOException,
                                    AutomationException

Indicates if updates to objects can bypass the Store method and OnChange notifications for efficiency.

Remarks

CanBypassStoreMethod is a convenience method that returns True if the instances of this object class have no custom behavior associated with creating or updating objects and if the object class does not participate in composite relationship classes or in relationship classes that require object notification. A return value of True implies that insert cursors handed out by the geodatabase will internally bypass the CreateRow and Store mechanisms when creating objects. A return value of False indicates that insert cursors will not bypass custom Store or OnChanged behavior implemented by the custom row object for this class.

By default, this method returns False for custom object classes. The developer of a custom object class can change this behavior by implementing this interface on the class extension associated with the class and returning True for the method.

In addition, a developer can implement this interface on the class extension of a simple class and set this property to False . Doing this will ensure that when features in the class are inserted, updated or deleted by editor tools that use insert and update cursors, such as Planarize, Create Features and the Object Loader do not bypass Store or OnChanged behavior. By default, this property for a simple class is logically True, meaning these tools will not broacast Geodatabase events which in turn are not rebroadcast as editor events (for which a custom editor application may be listening). Set this to False for those classes for which you always want to have these events broadcast. Alternatively, this can be set globally for the entire edit session using the IWorkspaceEditControl interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: canBypassStoreMethod in interface IObjectClassInfo
Specified by:: canBypassStoreMethod in interface IObjectClassInfo2

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

canBypassEditSession

public boolean canBypassEditSession()
                             throws IOException,
                                    AutomationException

Indicates if updates to objects can be safely made outside of an edit session.

Remarks

CanBypassEditSession is a convenience method that returns True if the instances of this object class may be created or updated outside of a Geodatabase edit session (an edit session is started by using the StartEditing method on the IWorkspaceEdit or the StartMultiuserEditing method on the IMultiuserWorkspaceEdit interface).

If True , then applications may update the data in this object class using any of the data updating interfaces and methods described here without starting an edit session. In this case applications are responsible for starting host database transactions as appropriate and for discarding cached object states across transaction boundaries when running on an ArcSDE database.

If False, then applications should always make modifications to the data in this object class within an edit session for correct multi-user behavior and for correct management of database state internally cached by the Geodatabase for the objects in this object class.

This method returns False for network feature classes. By default, this method returns True for non-network custom object classes. The developer of a non-network custom object class can change this behavior by implementing this interface on the class extension associated with the class and returning true for the method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: canBypassEditSession in interface IObjectClassInfo2

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

getShapeType

public int getShapeType()
                 throws IOException,
                        AutomationException

The type of the default Shape for the features in this feature class.

Description

ShapeType returns the basic type of geometry of a shape. For the purposes of using the ShapeType property in deciding how to render/symbolize a layer, only esriGeometryPolyline, esriGeometryPolygon, esriGeometryPoint, esriGeometryMulitpoint, and esriGeometryMultipatch need to be checked. All the other types will report as being one of these five types. The reason is that esriGeometryBezier3Curve or esriGeometryPath, etc. can be segments or parts of another shape.

Remarks

This read-only property returns the shape type for the feature class. This shape type can be one of the following esriGeometryType.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getShapeType in interface IFeatureClass

Returns:: A com.esri.arcgis.geometry.esriGeometryType constant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IFeatureClass.getShapeType(), esriGeometryType

getFeatureType

public int getFeatureType()
                   throws IOException,
                          AutomationException

The type of features in this feature class.

Remarks

This read-only property returns the feature type for the feature class as an esriFeatureType value. This property can be used to determine if a feature class is of a particular type, in order for the feature class to added to a network or topology, or possibly to skip over the feature class in an enumerator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getFeatureType in interface IFeatureClass

Returns:: A com.esri.arcgis.geodatabase.esriFeatureType constant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: esriFeatureType

getShapeFieldName

public String getShapeFieldName()
                         throws IOException,
                                AutomationException

The name of the default sShape field.

Remarks

This read-only property returns the name of the geometry field for the feature class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getShapeFieldName in interface IFeatureClass

Returns:: The name
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IPoint, IPolygon, IGeometry, ILine

getAreaField

public IField getAreaField()
                    throws IOException,
                           AutomationException

The geometry area field.

Remarks

This read-only property returns the name of the field which records the area of each feature. Only feature classes that have a ShapeType of esriGeometryPolygon have an Area field.

A null pointer will be returned if:

the feature class does not have a shape type of esriGeometryPolygon
the underlying database does not maintain an area field
the feature class is a shapefile or CAD data

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getAreaField in interface IFeatureClass

Returns:: A reference to a com.esri.arcgis.geodatabase.IField
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IField, IFields

getLengthField

public IField getLengthField()
                      throws IOException,
                             AutomationException

The geometry length field.

Remarks

This read-only property returns the name of the field which records the length of each feature. Only feature classes that have a ShapeType of esriGeometryPolygon or esriGeometryPolyLine have a Length field. For Line features, this field records the length of the polyline. For polygon features, this field records the perimeter of the polygon.

A null pointer will be returned if:

the feature class does not have a shape type of esriGeometryPolygon or esriGeometryPolyLine
the underlying database does not maintain an area field
the feature class is a shapefile or CAD data

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getLengthField in interface IFeatureClass

Returns:: A reference to a com.esri.arcgis.geodatabase.IField
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IField, IFields

getFeatureDataset

public IFeatureDataset getFeatureDataset()
                                  throws IOException,
                                         AutomationException

The feature dataset that contains the feature class.

Remarks

This read-only property returns the IFeatureDataset interface on the feature dataset that this feature class is a memeber of. If the feature class is a stand alone feature class (it does not have a feature dataset), then this function will return a null pointer. A coverage feature class will return the IFeatureDataset interface to the coverage itself. Shapefiles will always return a null pointer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getFeatureDataset in interface IFeatureClass

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

createFeature

public IFeature createFeature()
                       throws IOException,
                              AutomationException

Create a new feature, with a system assigned object ID and null property values.

Remarks

CreateFeature will create a new feature for the feature class. The new feature is by default assigned a unique object ID (OID). 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. Use the IFeature::Store method to actually store this new feature in the database. When working with a versioned feature class, CreateFeature should only be called within an edit session. You can start an edit session by calling IWorkspaceEdit::StartEditing. 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.

After calling CreateFeature, the default subtype value is not automatically set nor are default values initialized. For features without a subtype that have defined default values, calling IRowSubtypes::InitDefaultValues will initialize the default values. Use IRowSubtypes::SubtypeCode to set the subtype value for features with subtypes before calling IRowSubtypes::InitDefaultValues to initialize the default values for the particular subtype.

Calling the CreateFeature method on a feature class (via the IFeatureClass interface on the feature class) has the same effect as calling the CreateRow method on the FeatureClass (via the ITable interface on the feature class) except that the IFeatureClass methods return IFeature interfaces on the returned row object.

If multiple features with common attributes are being sequentially created, the CreateFeatureBuffer method, IFeatureCursor.InsertFeature method and IFeatureBuffer interface should be used for better performance.

The basic process to create a new feature is:

1) Create the feature
2) Create the geometry for the feature
3) Store the geometry in the feature
4) Store the feature

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: createFeature in interface IFeatureClass

Returns:: A reference to a com.esri.arcgis.geodatabase.IFeature
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IFeature, IFeatureCursor

getFeature

public IFeature getFeature(int iD)
                    throws IOException,
                           AutomationException

Get the feature with the specified object ID.

Remarks

GetFeature will return a feature from the feature class with the parameter-specified Object ID (OID). This method is typically used to find a particular feature with a known Object ID. A cursor should be used to iterate through all features in a feature class.

Calling the GetFeature method on a feature class (via the IFeatureClass interface on the feature class) has the same effect as calling the GetRow method on the feature class (via the ITable interface) except that the return value is an IFeature reference, rather than IRow.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getFeature in interface IFeatureClass

Parameters:: iD - The iD (in)
Returns:: A reference to a com.esri.arcgis.geodatabase.IFeature
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IFeature, IFeatureCursor

getFeatures

public IFeatureCursor getFeatures(Object fids,
                                  boolean recycling)
                           throws IOException,
                                  AutomationException

Deprecated. This method uses C style arrays which are not supported in the ArcGIS API for Java. It is replaced by GeoDatabaseHelper.getFeatures(com.esri.arcgis.geodatabase.IFeatureClass, int[], boolean).

Get a cursor of Rows given a set of object ids.

Remarks

GetFeatures will return an IFeatureCursor which contains the features from the feature class with the parameter-specified Object IDs (OID). This method can be used to loop through a particular set of features with known Object IDs.

Calling the GetFeatures method from the IFeatureClass interface has the same effect as calling the GetRows method from the ITable interface except that the return value is an IFeatureCursor reference, rather than an ICursor reference.

The fids parameter should be provided with an integer array. If the array contains an invalid Object ID, no error will occur, and no feature will be retrieved for the value.

This method should not be called from .NET or Java applications. Instead, call IGeoDatabaseBridge.GetFeatures.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getFeatures in interface IFeatureClass

Parameters:: fids - A Variant (in); recycling - The recycling (in)
Returns:: A reference to a com.esri.arcgis.geodatabase.IFeatureCursor
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IFeature, IFeatureCursor

getFeatureClassID

public int getFeatureClassID()
                      throws IOException,
                             AutomationException

The unique ID for the Feature Class.

Remarks

This read-only property will return the unique identifier for this feature class. All feature classes inside Geodatabases have a unique ID. Coverage and Shapefile feature classes do not, so IFeatureClass::FeatureClassID will always return -1 for Coverage and Shapefile feature classes. Since IFeatureClass inherits from IObjectClass, you can also get the feature class ID from IObjectClass:: ObjectClassID.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getFeatureClassID in interface IFeatureClass

Returns:: The fID
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IObjectClass

createFeatureBuffer

public IFeatureBuffer createFeatureBuffer()
                                   throws IOException,
                                          AutomationException

Create a feature buffer that can be used with an insert cursor.

Remarks

The CreateFeatureBuffer method creates a feature buffer and returns the IFeatureBuffer interface. This can be used to create new features in the feature class with an insert cursor. Like creating a feature with IFeatureClass::CreateFeature, the field values for the new feature must be initialized to some value before it can be stored in the database. 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.

Calling the CreateFeatureBuffer method in IFeatureClass has the same effect as calling the CreateRowBuffer interface in ITable except that the IFeatureClass methods return an IFeatureBuffer interface on the created row buffer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: createFeatureBuffer in interface IFeatureClass

Returns:: A reference to a com.esri.arcgis.geodatabase.IFeatureBuffer
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IFeature, IFeatureCursor

featureCount

public int featureCount(IQueryFilter queryFilter)
                 throws IOException,
                        AutomationException

The number of features selected by the specified query.

Remarks

FeatureCount returns the number of features that satisfy some attribute and/or spatial query as specified by an IQueryFilter object. If Nothing is supplied for the IQueryFilter, then FeatureCount returns the total number of features in the feature class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: featureCount in interface IFeatureClass

Parameters:: queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
Returns:: The numFeatures
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: In Java, rather than passing Nothing to get the total number of features, you should pass null.

search

public IFeatureCursor search(IQueryFilter filter,
                             boolean recycling)
                      throws IOException,
                             AutomationException

Returns an object cursor that can be used to fetch feature objects selected by the specified query.

Remarks

Search will return an IFeatureCursor with all of the features that satisfy the attribute and/or spatial constraints as specified by an IQueryFilter reference. If a null value is passed to the filter parameter, the feature cursor will return all of the features from the feature class.

The recycling parameter controls row object allocation behavior. Recycling cursors rehydrate a single feature object on each fetch and can be used to optimize read-only access, for example, when drawing. It is illegal to maintain a reference on a feature object returned by a recycling cursor across multiple calls to NextFeature on the cursor. Features returned by a recycling cursor should not be modified. Non-recycling cursors return a separate feature object on each fetch. The features returned by a non-recycling cursor may be modified and stored with polymorphic behavior.

The Geodatabase guarantees "unique instance semantics" on non-recycling feature objects fetched during an edit session. In other words, if the feature retrieved by a search cursor has already been instantiated and is being referenced by the calling application, then a reference to the existing feature object is returned.

Non-recycling feature cursors returned from the Search method *MUST* be used when copying features from the cursor into an insert cursor of another class. This is because a recycling cursor reuses the same geometry and under some circumstances all of the features inserted into the insert cursor may have the same geometry. Using a non-recycling cursor ensures that each geometry is unique.

Existing rows can be edited with either a search cursor or an update cursor. When using a search cursor, NextRow is called, returning a reference to a row. The row is edited, and IRow.Store is called. When using an update cursor, NextRow is called, the row is edited, and ICursor.UpdateRow is called with the row as a parameter. It is important to remember, when using an update cursor, do not call the Store method.

In the same way, rows can be deleted using a search cursor or an update cursor, with IRow.Delete used instead of IRow.Store, and ICursor.DeleteRow used instead of ICursor.UpdateRow.

The recommended approach depends on whether or not the edits are being made in an edit session, if the cursor is being used by ArcMap or by an Engine application, and if the features being edited are simple or complex. The table below shows which approach to use in different situations:

	ArcMap	Engine - Simple	Engine - Complex
Inside edit sessions	Search Cursor	Search Cursor	Search Cursor
Outside edit sessions	Search Cursor	Update Cursor	Search Cursor

A search cursor is always recommended in ArcMap, because the query may be satisfied by the contents of the map cache, making a DBMS query unnecessary.

When working with simple features and edit sessions in an Engine application, it's recommended that a search cursor be used to take advantage of batched updates in edit operations. With complex features, on the other hand, update calls are overridden by the features' custom behavior, meaning that the feature's store method will be called even if an update cursor is used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: search in interface IFeatureClass

Parameters:: filter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in); recycling - The recycling (in)
Returns:: A reference to a com.esri.arcgis.geodatabase.IFeatureCursor
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IQueryFilter

IFeatureClass_update

public IFeatureCursor IFeatureClass_update(IQueryFilter filter,
                                           boolean recycling)
                                    throws IOException,
                                           AutomationException

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

Product Availability

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

Specified by:: IFeatureClass_update in interface IFeatureClass

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

IFeatureClass_insert

public IFeatureCursor IFeatureClass_insert(boolean useBuffering)
                                    throws IOException,
                                           AutomationException

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

Product Availability

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

Specified by:: IFeatureClass_insert in interface IFeatureClass

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

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws IOException,
                                             AutomationException

The spatial reference of the GeoDataset.

Remarks

This property is read only. For layers, when the first layer is added to ArcMap, its spatial reference is read by this property, and the map is set to this spatial reference.

Instances of the esriCarto.GroupLayer class will return null for this property, as a group layer can contain multiple datasets with different spatial references.

Modifications to a spatial reference returned by this property will not be persisted. To modify the spatial reference of a dataset, the IGeoDatasetSchemaEdit and IGeoDatasetSchemaEdit2 interfaces should be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSpatialReference in interface IGeoDataset

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

getExtent

public IEnvelope getExtent()
                    throws IOException,
                           AutomationException

The extent of the GeoDataset.

Remarks

The IGeoDataset::Extent property returns an envelope representing the maximum extent of data which has been stored in the dataset.

Consider the following scenario. A new feature class has features added to it. The IGeoDataset::Extent is then requested and an envelope is returned. The extents of the envelope returned are represented by the red box in the image below.

The red box represents the IGeoDataset extent

If a portion of the features were then deleted and the extent is again requested an envelope with the exact same extents as during the first request would be returned (see image below). This is because the deletion of features does not shrink the extent. However all additions of features outside the red box would increase the envelope returned to encompass the newly added features.

The red box represents the IGeoDataset extent after some of the features have been deleted

If you would like to update the IGeoDataset::Extent property to reflect the current features in your dataset please see IFeatureClassManage::UpdateExtent (also see IFeatureClassLoad). In the image below the extent has been updated and a new envelope is being returned.

The red box represents the IGeoDataset extent after it has been updated

ESRI's GroupLayer implements this property differently from most other layer coclasses. When you instantiate a new GroupLayer, this property will return a valid envelope with zero height and width. With most other newly instantiated layers (for example FeatureLayer, RasterLayer, TinLayer), this property initally returns Nothing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getExtent in interface IGeoDataset

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

writeFeature

public void writeFeature(IFeature feature)
                  throws IOException,
                         AutomationException

Stores a feature to the database, does not trigger OnStore event.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: writeFeature in interface IFeatureClassWrite

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

writeFeatures

public void writeFeatures(ISet features)
                   throws IOException,
                          AutomationException

Stores a set of features to the database, does not trigger OnStore events.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: writeFeatures in interface IFeatureClassWrite

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

removeFeature

public void removeFeature(IFeature feature)
                   throws IOException,
                          AutomationException

Deletes a feature from the database, does not trigger OnDelete event.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: removeFeature in interface IFeatureClassWrite

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

removeFeatures

public void removeFeatures(ISet features)
                    throws IOException,
                           AutomationException

Deletes a set of features from the database, does not trigger OnDelete events.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: removeFeatures in interface IFeatureClassWrite

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

isLoadOnlyMode

public boolean isLoadOnlyMode()
                       throws IOException,
                              AutomationException

Indicates if the featureclass is in load only mode.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isLoadOnlyMode in interface IFeatureClassLoad

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

setLoadOnlyMode

public void setLoadOnlyMode(boolean isInLoadMode)
                     throws IOException,
                            AutomationException

Indicates if the featureclass is in load only mode.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setLoadOnlyMode in interface IFeatureClassLoad

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

getGeometricNetwork

public IGeometricNetwork getGeometricNetwork()
                                      throws IOException,
                                             AutomationException

The geometric network in which this class participates.

Remarks

The GeomtricNetwork property returns an IGeometricNetwork interface to the geometric network in which the network feature class participates.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getGeometricNetwork in interface INetworkClass

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

getFieldToWeightMapping

public int getFieldToWeightMapping(int fieldIndex)
                            throws IOException,
                                   AutomationException

The specified field to Weight mapping for the logical network.

Product Availability

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

Specified by:: getFieldToWeightMapping in interface INetworkClass

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

getNetworkAncillaryRole

public int getNetworkAncillaryRole()
                            throws IOException,
                                   AutomationException

The possible network ancillary roles of the contained Features.

Remarks

The NetworkAncillaryRole property will return the esriNetworkAncillaryRole enumeration which indicates if the junction class has a network ancillary role. Since junctions in a geometric network can act as a source, a sink or neither when calculating flow direction, this property will indicate whether or not the features in the class can be sources or sinks. If the class is a simple edge or complex edge network class, the ancillary role will always be returned as esriNCARNone since only junctions may have ancillary roles.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getNetworkAncillaryRole in interface INetworkClass

Returns:: A com.esri.arcgis.geodatabase.esriNetworkClassAncillaryRole constant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isCanSelect

public boolean isCanSelect()
                    throws IOException,
                           AutomationException

Indicates if the table supports selection.

Remarks

Use CanSelect to determine if you can open a selection set on the table. A situation where CanSelect will be False is a standalone database table without an OID column.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isCanSelect in interface ITableCapabilities

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

updateExtent

public void updateExtent()
                  throws IOException,
                         AutomationException

Updates the XY, M, Z extent.

Remarks

The UpdateExtent method recalculates the XY, Z and M extent for a feature class, based on the features contained within it. This extent is returned by the IGeodataset.Extent property. As new features are added to a feature class in a geodatabase, or a shapefile feature class, the extent is automatically expanded to accomodate them, however, when features are deleted, the extent does not shrink to eliminate areas where there are no longer features. This method will shrink the extent of the feature class to eliminate these areas.

The extent is a property of the feature class' schema, therefore, it requires an exclusive schema lock to execute, and is not an undoable operation. In the case of personal, File and ArcSDE geodatabase feature classes, the M and Z extent are not stored with the class. In the case of shapefiles, the M and Z extents are stored with the feature class.

When calling this method against an ArcSDE feature class, the extent is calculated based on the features that exist for that feature class in all versions. The extent will not shrink unless this method is called after the database has been compressed.

This method is not supported on coverage feature classes. A coverage's extent is maintained automatically during the editing process.

Note: The extents discussed here is not the same as the spatial reference domain. The domains (XY, Z, M) define the valid range of coordinate values that can be stored in a feature class. The extents reflect the actual range of coordinate values that exist within the feature class. The extents cannot be larger than the domains.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: updateExtent in interface IFeatureClassManage

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

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.geodatabase Class FeatureClass

Remarks

Product Availability

Supported Platforms

FeatureClass

equals

hashCode

getName

Product Availability

Supported Platforms

getFullName

Remarks

Product Availability

Supported Platforms

getBrowseName

Remarks

Product Availability

Supported Platforms

setBrowseName

Product Availability

Supported Platforms

getType

Remarks

Example:

Product Availability

Supported Platforms

getCategory

Remarks

Product Availability

Supported Platforms

getSubsets

Description

Remarks

Product Availability

Supported Platforms

getWorkspace

Description

Product Availability

Supported Platforms

getPropertySet

Description

Remarks

Product Availability

Supported Platforms

canCopy

Remarks

Product Availability

Supported Platforms

copy

Remarks

Product Availability

Supported Platforms

canDelete

Remarks

Product Availability

Supported Platforms

delete

Remarks

Product Availability

Supported Platforms

canRename

Remarks

Product Availability

Supported Platforms

rename

Remarks

Product Availability

Supported Platforms

isBeingEdited

Remarks

Product Availability

Supported Platforms

isCanEdit

Remarks

Product Availability

Supported Platforms

isCanUndo

Product Availability

Supported Platforms

isCanRedo

com.esri.arcgis.geodatabase
Class FeatureClass