com.esri.arcgis.networkanalyst.NAClass
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
public class NAClass
Holds features used as input and generated as output during network analysis.
The NAClass is an in-memory feature class holding features used as input and generated as output during network analysis. In addition to the INAClass interface, 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 NAContext.
You can retrieve an NAClass through the NAClasses property on NAContext's INAContext interface.
| Constructor Summary | |
|---|---|
NAClass(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(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. |
IField |
getAreaField()
The geometry area field. |
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. |
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(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. |
IIndexes |
getIndexes()
The indexes collection for this object class. |
IField |
getLengthField()
The geometry length field. |
int |
getObjectClassID()
The unique ID for the object class. |
String |
getOIDFieldName()
The name of the field corresponding to the OID. |
IRandomAccessCursor |
getRandomRows(String subFields,
boolean recycle)
Get a random access cursor on the table. |
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. |
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 |
| Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef |
|---|
getJintegraDispatch, release |
| Constructor Detail |
|---|
public NAClass(Object obj)
throws IOException
obj to NAClass. *
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
IOException - if there are interop problems
NAClass theNAClass = (NAClass) obj;| Method Detail |
|---|
public boolean equals(Object o)
equals in class Objectpublic int hashCode()
hashCode in class Object
public INAClassDefinition getClassDefinition()
throws IOException,
AutomationException
Returns the ClassDefinition object associated with this NAClass.
getClassDefinition in interface INAClassIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void deleteAllRows()
throws IOException,
AutomationException
DeleteAllRows quickly removes all of the rows from the NAClass. This is the quickest method to clear all of the NetworkLocationObjects from an NAClass.
deleteAllRows in interface INAClassIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setSaveRowsOnPersist(boolean pFlag)
throws IOException,
AutomationException
SaveRowsOnPersist specifies if the rows in the NAClass should be saved in the stream when IPersistStream::Save is called.
setSaveRowsOnPersist in interface INAClasspFlag - The pFlag (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isSaveRowsOnPersist()
throws IOException,
AutomationException
SaveRowsOnPersist specifies if the rows in the NAClass should be saved in the stream when IPersistStream::Save is called.
isSaveRowsOnPersist in interface INAClassIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IRow createRow()
throws IOException,
AutomationException
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.
createRow in interface ITableIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IRow getRow(int oID)
throws IOException,
AutomationException
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.
getRow in interface ITableoID - The oID (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ICursor getRows(Object oids,
boolean recycling)
throws IOException,
AutomationException
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:
// Get a recycling cursor for the OID array.
int[] oids = new int[] { 10844, 10853, 10871 };
ICursor cursor = table.getRows(oids, true);
getRows in interface ITableoids - A Variant (in)recycling - The recycling (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IRowBuffer createRowBuffer()
throws IOException,
AutomationException
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.
createRowBuffer in interface ITableIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void updateSearchedRows(IQueryFilter queryFilter,
IRowBuffer buffer)
throws IOException,
AutomationException
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.
updateSearchedRows in interface ITablequeryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)buffer - A reference to a com.esri.arcgis.geodatabase.IRowBuffer (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void deleteSearchedRows(IQueryFilter queryFilter)
throws IOException,
AutomationException
deleteSearchedRows in interface ITablequeryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int rowCount(IQueryFilter queryFilter)
throws IOException,
AutomationException
rowCount in interface ITablequeryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ICursor ITable_search(IQueryFilter queryFilter,
boolean recycling)
throws IOException,
AutomationException
ITable_search in interface ITablequeryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)recycling - The recycling (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ICursor update(IQueryFilter queryFilter,
boolean recycling)
throws IOException,
AutomationException
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.
update in interface ITablequeryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)recycling - The recycling (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ICursor insert(boolean useBuffering)
throws IOException,
AutomationException
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.
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.
insert in interface ITableuseBuffering - The useBuffering (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ISelectionSet select(IQueryFilter queryFilter,
int selType,
int selOption,
IWorkspace selectionContainer)
throws IOException,
AutomationException
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.
select in interface IFeatureClassselect in interface ITablequeryFilter - 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)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IQueryFilter
public int findField(String name)
throws IOException,
AutomationException
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.
findField in interface IClassname - The name (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IFields getFields()
throws IOException,
AutomationException
getFields in interface IClassIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IIndexes getIndexes()
throws IOException,
AutomationException
getIndexes in interface IClassIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void addField(IField field)
throws IOException,
AutomationException
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.
addField in interface IClassfield - A reference to a com.esri.arcgis.geodatabase.IField (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void deleteField(IField field)
throws IOException,
AutomationException
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:
Prior to deleting a field from a class, an exclusive schema lock should be obtained using the ISchemaLock interface.
// 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);
deleteField in interface IClassfield - A reference to a com.esri.arcgis.geodatabase.IField (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void addIndex(IIndex index)
throws IOException,
AutomationException
Prior to adding a new index to a class, an exclusive schema lock should be obtained using the ISchemaLock interface.
addIndex in interface IClassindex - A reference to a com.esri.arcgis.geodatabase.IIndex (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void deleteIndex(IIndex index)
throws IOException,
AutomationException
Prior to deleting an index from a class, an exclusive schema lock should be obtained using the ISchemaLock interface.
deleteIndex in interface IClassindex - A reference to a com.esri.arcgis.geodatabase.IIndex (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isHasOID()
throws IOException,
AutomationException
isHasOID in interface IClassIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getOIDFieldName()
throws IOException,
AutomationException
getOIDFieldName in interface IClassIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IUID getCLSID()
throws IOException,
AutomationException
getCLSID in interface IClassIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IUID getEXTCLSID()
throws IOException,
AutomationException
getEXTCLSID in interface IClassIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public Object getExtension()
throws IOException,
AutomationException
getExtension in interface IClassIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IPropertySet getExtensionProperties()
throws IOException,
AutomationException
getExtensionProperties in interface IClassIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getObjectClassID()
throws IOException,
AutomationException
Returns the unique ID of the object class.
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.
getObjectClassID in interface IObjectClassIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IEnumRelationshipClass getRelationshipClasses(int role)
throws IOException,
AutomationException
getRelationshipClasses in interface IObjectClassrole - A com.esri.arcgis.geodatabase.esriRelRole constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getAliasName()
throws IOException,
AutomationException
Returns the alias name for the object class.
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.
getAliasName in interface IObjectClassIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getShapeType()
throws IOException,
AutomationException
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.
getShapeType in interface IFeatureClassIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IFeatureClass.getShapeType(),
esriGeometryType
public int getFeatureType()
throws IOException,
AutomationException
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.
getFeatureType in interface IFeatureClassIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.esriFeatureType
public String getShapeFieldName()
throws IOException,
AutomationException
This read-only property returns the name of the geometry field for the feature class.
getShapeFieldName in interface IFeatureClassIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IPoint,
IPolygon,
IGeometry,
ILine
public IField getAreaField()
throws IOException,
AutomationException
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:
getAreaField in interface IFeatureClassIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IField,
IFields
public IField getLengthField()
throws IOException,
AutomationException
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:
getLengthField in interface IFeatureClassIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IField,
IFields
public IFeatureDataset getFeatureDataset()
throws IOException,
AutomationException
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.
getFeatureDataset in interface IFeatureClassIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IFeature createFeature()
throws IOException,
AutomationException
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
createFeature in interface IFeatureClassIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IFeature,
IFeatureCursor
public IFeature getFeature(int iD)
throws IOException,
AutomationException
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.
getFeature in interface IFeatureClassiD - The iD (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IFeature,
IFeatureCursor
public IFeatureCursor getFeatures(Object fids,
boolean recycling)
throws IOException,
AutomationException
GeoDatabaseHelper#getFeatures(com.esri.arcgis.geodatabase.IFeatureClass, int[], boolean).
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.
getFeatures in interface IFeatureClassfids - A Variant (in)recycling - The recycling (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IFeature,
IFeatureCursor
public int getFeatureClassID()
throws IOException,
AutomationException
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.
getFeatureClassID in interface IFeatureClassIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IObjectClass
public IFeatureBuffer createFeatureBuffer()
throws IOException,
AutomationException
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.
createFeatureBuffer in interface IFeatureClassIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IFeature,
IFeatureCursor
public int featureCount(IQueryFilter queryFilter)
throws IOException,
AutomationException
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.
featureCount in interface IFeatureClassqueryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.In Java, rather than passing Nothing to get the total number of features, you should pass null.
public IFeatureCursor search(IQueryFilter filter,
boolean recycling)
throws IOException,
AutomationException
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.
|
|
ArcMap |
Engine - Simple |
Engine - Complex |
|
Inside edit sessions |
Search Cursor |
Search Cursor |
Search Cursor |
|
Outside edit sessions |
Search Cursor |
Update Cursor |
Search Cursor |
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.
search in interface IFeatureClassfilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)recycling - The recycling (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IQueryFilter
public IFeatureCursor IFeatureClass_update(IQueryFilter filter,
boolean recycling)
throws IOException,
AutomationException
IFeatureClass_update in interface IFeatureClassfilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)recycling - The recycling (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IFeatureCursor IFeatureClass_insert(boolean useBuffering)
throws IOException,
AutomationException
IFeatureClass_insert in interface IFeatureClassuseBuffering - The useBuffering (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IRandomAccessCursor getRandomRows(String subFields,
boolean recycle)
throws IOException,
AutomationException
getRandomRows in interface IRandomAccessTablesubFields - The subFields (in)recycle - The recycle (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||