com.esri.arcgis.networkanalyst
Class NAClass

java.lang.Object
  com.esri.arcgis.networkanalyst.NAClass

All Implemented Interfaces:

IClass, IFeatureClass, INAClass, IObjectClass, ITable, java.io.Serializable

public class NAClass

extends java.lang.Object

implements INAClass, ITable, IObjectClass, IFeatureClass

Holds features used as input and generated as output during network analysis.

Product Availability

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

Remarks

The NAClass is an in-memory feature class holding features used as input and generated as output during network analysis. In addition to the additional interface INAClass, it supports all of the other interfaces implemented by a regular feature class.

The workspace containing the NAClass is not directly exposed to the end user. The workspace and the lifetime of the NAClass is managed by the NAContext.

You can retrieve an NAClass through the NAClasses method on NAContext's INAContext interface.

See Also:

Serialized Form

Constructor Summary

NAClass(java.lang.Object obj)
Construct a NAClass 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.
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	deleteAllRows() Remove all items added to the class (for example, stops or incidents).
void	deleteField(IField field) Deletes a field from this object class.
void	deleteIndex(IIndex index) Deletes an index from this object class.
void	deleteSearchedRows(IQueryFilter queryFilter) Delete the Rows in the database selected by the specified query.
boolean	equals(java.lang.Object o) Compare this object with another
int	featureCount(IQueryFilter queryFilter) The number of features selected by the specified query.
int	findField(java.lang.String name) The index of the field with the specified name.
java.lang.String	getAliasName() The alias name of the object class.
IField	getAreaField() The geometry area field.
IFeatureClass	getAsIFeatureClass() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
INAClass	getAsINAClass() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IObjectClass	getAsIObjectClass() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ITable	getAsITable() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
INAClassDefinition	getClassDefinition() The network analyst class definition.
IUID	getCLSID() The GUID for the COM Class (CoClass) corresponding to instances of this object class.
IUID	getEXTCLSID() The GUID for the COM Class (CoClass) corresponding to the class extension for this object class.
java.lang.Object	getExtension() The extension for this object class.
IPropertySet	getExtensionProperties() The extension properties for this object class.
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(java.lang.Object fids, boolean recycling) Get a cursor of Rows given a set of object ids.
int	getFeatureType() The type of features in this feature class.
IFields	getFields() The fields collection for this object class.
IIndexes	getIndexes() The indexes collection for this object class.
IField	getLengthField() The geometry length field.
int	getObjectClassID() The unique ID for the object class.
java.lang.String	getOIDFieldName() The name of the field corresponding to the OID.
IEnumRelationshipClass	getRelationshipClasses(int role) The relationship classes in which this object class participates in for the specified role.
IRow	getRow(int oID) The row from the database with the specified object ID.
ICursor	getRows(java.lang.Object oids, boolean recycling) The cursor of rows based on a set of object ids.
java.lang.String	getShapeFieldName() The name of the default sShape field.
int	getShapeType() The type of the default Shape for the features in this feature class.
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	isHasOID() Indicates if the class has an object identity (OID) field.
boolean	isSaveRowsOnPersist() Indicates if rows are stored with the map document.
ICursor	ITable_search(IQueryFilter queryFilter, boolean recycling) An object cursor that can be used to fetch row objects selected by the specified query.
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	setSaveRowsOnPersist(boolean pFlag) Indicates if rows are stored with the map document.
ICursor	update(IQueryFilter queryFilter, boolean recycling) Returns a cursor that can be used to update Rows selected by the specified query.
void	updateSearchedRows(IQueryFilter queryFilter, IRowBuffer buffer) Update the Rows in the database selected by the specified query.

Methods inherited from class java.lang.Object

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

Constructor Detail

NAClass

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

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

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

Throws:

java.io.IOException - if there are interop problems

Method Detail

getAsINAClass

public INAClass getAsINAClass()

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

getAsITable

public ITable getAsITable()

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

getAsIObjectClass

public IObjectClass getAsIObjectClass()

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

getAsIFeatureClass

public IFeatureClass getAsIFeatureClass()

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

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

getClassDefinition

public INAClassDefinition getClassDefinition()
                                      throws java.io.IOException,
                                             AutomationException

Description copied from interface: INAClass

The network analyst class definition.

Remarks

Returns the ClassDefinition object associated with this NAClass.

Specified by:

getClassDefinition in interface INAClass

Returns:

A reference to a com.esri.arcgis.networkanalyst.INAClassDefinition

Throws:

AutomationException - If the ArcObject component throws an exception.

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

deleteAllRows

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

Description copied from interface: INAClass

Remove all items added to the class (for example, stops or incidents).

Remarks

DeleteAllRows quickly removes all of the rows from the NAClass. This is the quickest method to clear all of the NetworkLocationObjects from an NAClass.

Specified by:

deleteAllRows in interface INAClass

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setSaveRowsOnPersist

public void setSaveRowsOnPersist(boolean pFlag)
                          throws java.io.IOException,
                                 AutomationException

Description copied from interface: INAClass

Indicates if rows are stored with the map document.

Remarks

SaveRowsOnPersist specifies if the rows in the NAClass should be saved in the stream when IPersistStream::Save is called.

Specified by:

setSaveRowsOnPersist in interface INAClass

Parameters:

pFlag - The pFlag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSaveRowsOnPersist

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

Description copied from interface: INAClass

Indicates if rows are stored with the map document.

Remarks

SaveRowsOnPersist specifies if the rows in the NAClass should be saved in the stream when IPersistStream::Save is called.

Specified by:

isSaveRowsOnPersist in interface INAClass

Returns:

The pFlag

Throws:

AutomationException - If the ArcObject component throws an exception.

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

createRow

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

Description copied from interface: ITable

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

Supported Platforms

Windows, Solaris, Linux

Remarks

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

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

Specified by:

createRow in interface ITable

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRow

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

Description copied from interface: ITable

The row from the database with the specified object ID.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

Specified by:

getRow in interface ITable

Parameters:

oID - The oID (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRows

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

Description copied from interface: ITable

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

Supported Platforms

Windows, Solaris, Linux

Remarks

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

Specified by:

getRows in interface ITable

Parameters:

oids - A Variant (in)

recycling - The recycling (in)

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

createRowBuffer

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

Description copied from interface: ITable

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

Supported Platforms

Windows, Solaris, Linux

Remarks

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

Specified by:

createRowBuffer in interface ITable

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

updateSearchedRows

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

Description copied from interface: ITable

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

Supported Platforms

Windows, Solaris, Linux

Remarks

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

Specified by:

updateSearchedRows in interface ITable

Parameters:

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

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

deleteSearchedRows

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

Description copied from interface: ITable

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deleteSearchedRows in interface ITable

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

rowCount

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

Description copied from interface: ITable

The number of Rows selected by the specified query.

Supported Platforms

Windows, Solaris, Linux

Specified by:

rowCount in interface ITable

Parameters:

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

Returns:

The numRows

Throws:

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

AutomationException - If the ArcObject component throws an exception.

ITable_search

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

Description copied from interface: ITable

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

Specified by:

ITable_search in interface ITable

Parameters:

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

recycling - The recycling (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

update

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

Description copied from interface: ITable

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

Supported Platforms

Windows, Solaris, Linux

Remarks

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

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

Specified by:

update in interface ITable

Parameters:

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

recycling - The recycling (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

insert

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

Description copied from interface: ITable

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

Supported Platforms

Windows, Solaris, Linux

Remarks

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

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

Specified by:

insert in interface ITable

Parameters:

useBuffering - The useBuffering (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

select

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

Description copied from interface: ITable

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

Supported Platforms

Windows, Solaris, Linux

Remarks

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

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

Specified by:

select in interface ITable

Parameters:

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

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

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

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findField

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

Description copied from interface: IClass

The index of the field with the specified name.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

Specified by:

findField in interface IClass

Parameters:

name - The name (in)

Returns:

The fieldIndex

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getFields

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

Description copied from interface: IClass

The fields collection for this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFields in interface IClass

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getIndexes

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

Description copied from interface: IClass

The indexes collection for this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getIndexes in interface IClass

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addField

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

Description copied from interface: IClass

Adds a field to this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:

addField in interface IClass

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteField

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

Description copied from interface: IClass

Deletes a field from this object class.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

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

Specified by:

deleteField in interface IClass

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addIndex

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

Description copied from interface: IClass

Adds an index to this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:

addIndex in interface IClass

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteIndex

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

Description copied from interface: IClass

Deletes an index from this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:

deleteIndex in interface IClass

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHasOID

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

Description copied from interface: IClass

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isHasOID in interface IClass

Returns:

The hasOID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOIDFieldName

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

Description copied from interface: IClass

The name of the field corresponding to the OID.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getOIDFieldName in interface IClass

Returns:

The name

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getCLSID

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

Description copied from interface: IClass

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCLSID in interface IClass

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEXTCLSID

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

Description copied from interface: IClass

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getEXTCLSID in interface IClass

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getExtension

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

Description copied from interface: IClass

The extension for this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getExtension in interface IClass

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtensionProperties

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

Description copied from interface: IClass

The extension properties for this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getExtensionProperties in interface IClass

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getObjectClassID

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

Description copied from interface: IObjectClass

The unique ID for the object class.

Supported Platforms

Windows, Solaris, Linux

Description

Returns the unique ID of the object class.

Remarks

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

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

Specified by:

getObjectClassID in interface IObjectClass

Returns:

The objectClassID

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getRelationshipClasses

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

Description copied from interface: IObjectClass

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

Supported Platforms

Windows, Solaris, Linux

Description

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

Remarks

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

Specified by:

getRelationshipClasses in interface IObjectClass

Parameters:

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

See Also:

IEnumRelationshipClass, esriRelRole

getAliasName

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

Description copied from interface: IObjectClass

The alias name of the object class.

Supported Platforms

Windows, Solaris, Linux

Description

Returns the alias name for the object class.

Remarks

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

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

Specified by:

getAliasName in interface IObjectClass

Returns:

The name

Throws:

AutomationException - If the ArcObject component throws an exception.

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

See Also:

IModelInfo

getShapeType

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

Description copied from interface: IFeatureClass

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

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:

getShapeType in interface IFeatureClass

Returns:

A com.esri.arcgis.geometry.esriGeometryType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFeatureType

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

Description copied from interface: IFeatureClass

The type of features in this feature class.

Supported Platforms

Windows, Solaris, Linux

Remarks

This read-only property returns the feature type for the feature class. This feature type can be one of the following esriFeatureType. 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 enumeration.

Specified by:

getFeatureType in interface IFeatureClass

Returns:

A com.esri.arcgis.geodatabase.esriFeatureType constant

Throws:

AutomationException - If the ArcObject component throws an exception.

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

See Also:

esriFeatureType

getShapeFieldName

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

Description copied from interface: IFeatureClass

The name of the default sShape field.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

Specified by:

getShapeFieldName in interface IFeatureClass

Returns:

The name

Throws:

AutomationException - If the ArcObject component throws an exception.

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

See Also:

IGeometry, ILine, IPoint, IPolygon

getAreaField

public IField getAreaField()
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IFeatureClass

The geometry area field.

Supported Platforms

Windows, Solaris, Linux

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
  
  

Specified by:

getAreaField in interface IFeatureClass

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

See Also:

IField, IFields

getLengthField

public IField getLengthField()
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IFeatureClass

The geometry length field.

Supported Platforms

Windows, Solaris, Linux

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
  

Specified by:

getLengthField in interface IFeatureClass

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

See Also:

IField, IFields

getFeatureDataset

public IFeatureDataset getFeatureDataset()
                                  throws java.io.IOException,
                                         AutomationException

Description copied from interface: IFeatureClass

The feature dataset that contains the feature class.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:

getFeatureDataset in interface IFeatureClass

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

See Also:

IFeatureDataset, IDataset

createFeature

public IFeature createFeature()
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IFeatureClass

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

Supported Platforms

Windows, Solaris, Linux

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.

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

Specified by:

createFeature in interface IFeatureClass

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

See Also:

IFeature, IRowSubtypes, IWorkspaceEdit

getFeature

public IFeature getFeature(int iD)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IFeatureClass

Get the feature with the specified object ID.

Supported Platforms

Windows, Solaris, Linux

Remarks

GetFeature will return the IFeature interface for a feature in the feature class with a given Object ID (OID). This method is typically used to find a particular feature that you know the OID for. Use a cursor if you wish to loop through all features in the 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 FeatureClass (via the ITable interface on the feature class) except that the IFeatureClass methods return IFeature interfaces.

Specified by:

getFeature in interface IFeatureClass

Parameters:

iD - The iD (in)

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

See Also:

IObject, IFeature

getFeatures

public IFeatureCursor getFeatures(java.lang.Object fids,
                                  boolean recycling)
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: IFeatureClass

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

Supported Platforms

Windows, Solaris, Linux

Remarks

GetFeatures will return an IFeatureCursor which contains all the features in the feature class with the given Object IDs (OID). This method can be used to loop through a particular set of features that you know the OIDs for.

Calling the GetFeatures method in IFeatureClass has the same effect as calling the GetRows method in ITable except that the IFeatureClass method returns the IFeatureCursor interface on the returned cursor.

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:

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

AutomationException - If the ArcObject component throws an exception.

See Also:

IFeature, IFeatureCursor

getFeatureClassID

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

Description copied from interface: IFeatureClass

The unique ID for the Feature Class.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:

getFeatureClassID in interface IFeatureClass

Returns:

The fID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

See Also:

IObjectClass

createFeatureBuffer

public IFeatureBuffer createFeatureBuffer()
                                   throws java.io.IOException,
                                          AutomationException

Description copied from interface: IFeatureClass

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

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:

createFeatureBuffer in interface IFeatureClass

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

See Also:

IFeature, IFeatureCursor, IFeatureBuffer

featureCount

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

Description copied from interface: IFeatureClass

The number of features selected by the specified query.

Supported Platforms

Windows, Solaris, Linux

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.

In Java, rather than passing Nothing to get the total number of features, you should pass null.

Specified by:

featureCount in interface IFeatureClass

Parameters:

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

Returns:

The numFeatures

Throws:

AutomationException - If the ArcObject component throws an exception.

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

See Also:

IQueryFilter

search

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

Description copied from interface: IFeatureClass

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

Supported Platforms

Windows, Solaris, Linux

Remarks

Search will return an IFeatureCursor with all of the features that satisfy some attribute and/or spatial query as specified by an IQueryFilter object. If Nothing is given as the IQueryFilter, then the feature cursor will have 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. Feature objects 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. If the feature object to be retrieved by a call to search has already been instantiated and is being referenced by the calling application, then a reference to the existing feature object is returned.

Feature cursors returned from the Search method cannot be used to update the features in the cursor. The feature cursor returned from the Update method should be used to update those features.

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.

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:

AutomationException - If the ArcObject component throws an exception.

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

See Also:

IQueryFilter, IFeatureCursor

IFeatureClass_update

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

Description copied from interface: IFeatureClass

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

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:

AutomationException - If the ArcObject component throws an exception.

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

IFeatureClass_insert

public IFeatureCursor IFeatureClass_insert(boolean useBuffering)
                                    throws java.io.IOException,
                                           AutomationException

Description copied from interface: IFeatureClass

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

Specified by:

IFeatureClass_insert in interface IFeatureClass

Parameters:

useBuffering - The useBuffering (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.