com.esri.arcgis.trackinganalyst
Class TemporalFeatureClass

java.lang.Object
  extended by com.esri.arcgis.trackinganalyst.TemporalFeatureClass
All Implemented Interfaces:
IDirectData, ITemporalSearch, IClass, IDataset, IDatasetEdit, IFeatureClass, IGeoDataset, IObjectClass, ITable, ITableCapabilities, IExcludedEventIDs, ILockedFeatureSearch, ITemporalFeatureClass2, ITemporalFeatureClassStatistics, ITxEnumTrackId, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, ITemporalFeatureClass, ITemporalFeatureClass3, ITimeZone, Serializable

public class TemporalFeatureClass
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ITemporalFeatureClass, ITemporalFeatureClass2, ITemporalFeatureClass3, IDataset, IDatasetEdit, ITable, IClass, IObjectClass, IGeoDataset, IFeatureClass, IDirectData, ITemporalSearch, ITimeZone, ITableCapabilities, IExcludedEventIDs, ITemporalFeatureClassStatistics, ILockedFeatureSearch, ISupportErrorInfo, ITxEnumTrackId

Controls settings for the temporal feature class.

Description

The Temporal Feature Class is a Feature class that contains live or dynamic data. This class is responsible for maintaining this data in memory for rapid access by subscribers. This class will return queries that iterate through the data in temporal order, and has the capability to create and delete features. This class will utilize a custom in memory database.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

See Also:
Serialized Form

Constructor Summary
TemporalFeatureClass(Object obj)
          Construct a TemporalFeatureClass 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.
 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.
 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 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.
 IFIDSet getAllLockedFIDs()
          Indicates the FIDs for all locked features.
 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.
 String getConnectionName()
          Return Connection Name.
 String getCurrentZone()
          The current Time Zone.
 IStringArray getExcludedTrackingEventIDs()
          String array of EventIDs to be permanently purged and ignored.
 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.
 String getFirstTrackId()
          Retrives the first Track ID in the list.
 IName getFullName()
          The associated name object.
 IIndexes getIndexes()
          The indexes collection for this object class.
 ITime getLastUpdateTime(String trackId)
          Returns the time that a given track was last updated.
 IField getLengthField()
          The geometry length field.
 double getMessageRate()
          Indicates the TemporalFeatureClass message rate.
 String getName()
          The name of the Dataset.
 String getNextTrackId()
          Retrives the next Track ID in the list.
 int getObjectClassID()
          The unique ID for the object class.
 String getOIDFieldName()
          The name of the field corresponding to the OID.
 IActionProcessor getPostActionProcessor()
          Evaluates data messages once they are placed in the feature class' internal storage.
 IActionCollection getPostActions()
          Collection of actions that will be evaluated after data messages are placed in the temporal feature class' internal storage.
 IActionProcessor getPreActionProcessor()
          The action processor that will evaluate the data messages before they are stored.
 IActionCollection getPreActions()
          Collection of actions that will be evaluated before data messages are placed in feature class storage.
 IPropertySet getPropertySet()
          The set of properties for the dataset.
 double getPurgePercentage()
          Indicates percentage of the maximum number of records to delete when the Purge method is called.
 int getPurgeRule()
          Indicates rule to use when purging records when AutoPurge is true (e.g., purge oldest records).
 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.
 int getSampleSize()
          Indicates the sample size used to calculate message rate.
 String getServerName()
          Return Server Name.
 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.
 String getTemporalColumnName()
          Name of the column containing the time-date information.
 String getTemporalObjectColumnName()
          Name of the column containing the track information.
 Object getThreshold()
          Indicates the high-water mark, or maximum number of observations allowed before records are purged from memory.
 String getTimeZoneXML()
          The XML representation of a TimeZone.
 Object getTotalFeatureCount()
          Indicates the total number of features logged.
 int getTrackCount()
          Indicates the TemporalFeatureClass track count.
 ISelectionSet getTrackFeatures(String trackId)
          Returns a selection set of features in a given track.
 String[] getTrackIds()
          Retrives the Track ID list.
 int getType()
          The type of the Dataset.
 IWorkspace getWorkspace()
          The workspace containing this dataset.
 Object getZoneList()
          List of time zones.
 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.
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 boolean isAdjustForDaylightSavings()
          Indicates whether or not to Adjust For Daylight Savings.
 boolean isAutoPurge()
          Controls whether or not to automatically purge records once a user-defined threshold is met.
 boolean isBeingEdited()
          True if the dataset is being edited.
 boolean isCanSelect()
          Indicates if the table supports selection.
 boolean isContainsTemporalObjects()
          Indicates whether or not a temporal object table is used to collect or provide static information about temporal observations.
 boolean isHasOID()
          Indicates if the class has an object identity (OID) field.
 ICursor ITable_search(IQueryFilter queryFilter, boolean recycling)
          An object cursor that can be used to fetch row objects selected by the specified query.
 ICursor lastKnownFeatures(Object varStartingTime, Object varEndingTime)
          Searches for last known features in the dataset.
 IFeatureIDSet lastKnownOIDs(Object varStartingTime, Object varEndingTime)
          Searches for the last known OIDs in the dataset.
 void postMessage(IDataMessage piMsg)
          All temporal messages enter the temporal feature class environment via this method.
 void pruneTable()
          Apply the purge rule to the temporal table.
 void queryTemporalExtent(Object[] pvarStartTime, Object[] pvarEndTime)
          Queries the feature class using the full temporal extent.
 void queryTrackTimeExtent(String trackId, ITime[] startTime, ITime[] endTime)
          Returns the start and end times of a given track.
 void readProperties(IStream piStream)
          Load an object's properties from a stream.
 void registerListener(IListener piListener)
          Registers a Listener Object with the feature class.
 void rename(String name)
          Renames this Dataset.
 void resetFeatureCount()
          Resets total feature count.
 void resetMessageRate()
          Resets message rate.
 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.
 ICursor searchAndLock(IQueryFilter piQueryFilter, boolean recycling)
          Searches records that satisfy the query filter and lockes them.
 ISelectionSet select(IQueryFilter queryFilter, int selType, int selOption, IWorkspace selectionContainer)
          A selection that contains the object ids selected by the specified query.
 ISelectionSet selectAndLock(IQueryFilter piQueryFilter, int selType, int selOption, IWorkspace piSelectionContainer)
          Selectes records that satisfy the query filter, selection type and selection option, and lockes them.
 void setAdjustForDaylightSavings(boolean pVal)
          Indicates whether or not to Adjust For Daylight Savings.
 void setAutoPurge(boolean pVal)
          Controls whether or not to automatically purge records once a user-defined threshold is met.
 void setBrowseName(String name)
          The browse name of the dataset.
 void setCurrentZone(String pbstrCurrentZone)
          The current Time Zone.
 void setExcludedTrackingEventIDs(IStringArray pVal)
          String array of EventIDs to be permanently purged and ignored.
 void setPostActionProcessorByRef(IActionProcessor ppiProcessor)
          Evaluates data messages once they are placed in the feature class' internal storage.
 void setPostActionsByRef(IActionCollection ppiActions)
          Collection of actions that will be evaluated after data messages are placed in the temporal feature class' internal storage.
 void setPreActionProcessorByRef(IActionProcessor ppiProcessor)
          The action processor that will evaluate the data messages before they are stored.
 void setPreActionsByRef(IActionCollection ppiActions)
          Collection of actions that will be evaluated before data messages are placed in feature class storage.
 void setPurgePercentage(double pVal)
          Indicates percentage of the maximum number of records to delete when the Purge method is called.
 void setPurgeRule(int pVal)
          Indicates rule to use when purging records when AutoPurge is true (e.g., purge oldest records).
 void setSampleSize(int plSampleSize)
          Indicates the sample size used to calculate message rate.
 void setTemporalColumnName(String pVal)
          Name of the column containing the time-date information.
 void setTemporalObjectColumnName(String rhs1)
          Name of the column containing the track information.
 void setThreshold(Object pVal)
          Indicates the high-water mark, or maximum number of observations allowed before records are purged from memory.
 void setTimeZoneXML(String pbstrXML)
          The XML representation of a TimeZone.
 void unlockAllFeatures()
          Unlocks all features that are locked.
 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.
 void writeProperties(IStream piStream)
          Write the object's properties to a stream.
 
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

TemporalFeatureClass

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

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

Throws:
IOException - if there are interop problems TemporalFeatureClass theTemporalFeatureClass = (TemporalFeatureClass) 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

queryTemporalExtent

public void queryTemporalExtent(Object[] pvarStartTime,
                                Object[] pvarEndTime)
                         throws IOException,
                                AutomationException
Queries the feature class using the full temporal extent.

Description

This function returns the full temporal extent of data stored in the feature class. The returned objects are VT_DATE type (e.g., “mm/dd/yyyy hh:mm:ss AM/PM”).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
queryTemporalExtent in interface ITemporalSearch
Specified by:
queryTemporalExtent in interface ITemporalFeatureClass
Parameters:
pvarStartTime - A Variant (in/out: use single element array)
pvarEndTime - A Variant (in/out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTemporalColumnName

public String getTemporalColumnName()
                             throws IOException,
                                    AutomationException
Name of the column containing the time-date information.

Description

This property is the name of the column that contains the temporal data. This data can be a timestamp or a time period.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getTemporalColumnName in interface ITemporalFeatureClass
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTemporalColumnName

public void setTemporalColumnName(String pVal)
                           throws IOException,
                                  AutomationException
Name of the column containing the time-date information.

Description

This property is the name of the column that contains the temporal data. This data can be a timestamp or a time period.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setTemporalColumnName in interface ITemporalFeatureClass
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isContainsTemporalObjects

public boolean isContainsTemporalObjects()
                                  throws IOException,
                                         AutomationException
Indicates whether or not a temporal object table is used to collect or provide static information about temporal observations.

Description

This property indicates whether or not a temporal object table is used to collect or provide static information about temporal observations. This simply means that for a given temporal observation there is a set of static attributes that do not change from observation to observation.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
isContainsTemporalObjects in interface ITemporalFeatureClass
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTemporalObjectColumnName

public String getTemporalObjectColumnName()
                                   throws IOException,
                                          AutomationException
Name of the column containing the track information.

Description

This property returns the column name that provides the temporal data. This property is set during the feature classes creation and is read-only.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getTemporalObjectColumnName in interface ITemporalFeatureClass
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPostActionProcessor

public IActionProcessor getPostActionProcessor()
                                        throws IOException,
                                               AutomationException
Evaluates data messages once they are placed in the feature class' internal storage.

Description

The post action processor is the action processor that will evaluate data messages once they are placed in the feature class's internal storage. These data messages are queued to the actions processor's work queue, and a separate thread is used to perform this processing.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getPostActionProcessor in interface ITemporalFeatureClass
Returns:
A reference to a com.esri.arcgis.carto.IActionProcessor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPostActionProcessorByRef

public void setPostActionProcessorByRef(IActionProcessor ppiProcessor)
                                 throws IOException,
                                        AutomationException
Evaluates data messages once they are placed in the feature class' internal storage.

Description

The post action processor is the action processor that will evaluate data messages once they are placed in the feature class's internal storage. These data messages are queued to the actions processor's work queue, and a separate thread is used to perform this processing.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setPostActionProcessorByRef in interface ITemporalFeatureClass
Parameters:
ppiProcessor - A reference to a com.esri.arcgis.carto.IActionProcessor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPostActions

public IActionCollection getPostActions()
                                 throws IOException,
                                        AutomationException
Collection of actions that will be evaluated after data messages are placed in the temporal feature class' internal storage.

Description

This property is a collection of actions that will be evaluated after data messages are placed in the temporal feature class's internal storage.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getPostActions in interface ITemporalFeatureClass
Returns:
A reference to a com.esri.arcgis.carto.IActionCollection
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPostActionsByRef

public void setPostActionsByRef(IActionCollection ppiActions)
                         throws IOException,
                                AutomationException
Collection of actions that will be evaluated after data messages are placed in the temporal feature class' internal storage.

Description

This property is a collection of actions that will be evaluated after data messages are place in the temporal feature class's internal storage.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setPostActionsByRef in interface ITemporalFeatureClass
Parameters:
ppiActions - A reference to a com.esri.arcgis.carto.IActionCollection (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

registerListener

public void registerListener(IListener piListener)
                      throws IOException,
                             AutomationException
Registers a Listener Object with the feature class.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
registerListener in interface ITemporalFeatureClass
Parameters:
piListener - A reference to a com.esri.arcgis.geodatabaseextensions.IListener (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAutoPurge

public boolean isAutoPurge()
                    throws IOException,
                           AutomationException
Controls whether or not to automatically purge records once a user-defined threshold is met.

Description

This property controls whether or not to automatically purge observations that meet a specified criteria--the user-defined Purge Rule--when the high-water mark has been exceeded.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
isAutoPurge in interface ITemporalFeatureClass
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAutoPurge

public void setAutoPurge(boolean pVal)
                  throws IOException,
                         AutomationException
Controls whether or not to automatically purge records once a user-defined threshold is met.

Description

This property controls whether or not to automatically purge observations that meet a specified criteria--the user-defined Purge Rule--when the high-water mark has been exceeded.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setAutoPurge in interface ITemporalFeatureClass
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getThreshold

public Object getThreshold()
                    throws IOException,
                           AutomationException
Indicates the high-water mark, or maximum number of observations allowed before records are purged from memory.

Description

This property indicates the high-water mark or the number of observations that should not be exceeded. When the auto purge property is enabled or true, this level is the maximum number of records that can exist in the table. The auto purge process occurs or is triggered, and it will prune the table according to the Purge Rule. If Auto Purge is not true or enabled then record inserts will fail and no further data will be allowed into the table.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getThreshold in interface ITemporalFeatureClass
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setThreshold

public void setThreshold(Object pVal)
                  throws IOException,
                         AutomationException
Indicates the high-water mark, or maximum number of observations allowed before records are purged from memory.

Description

This property indicates the high-water mark or the number of observations that should not be exceeded. When the auto purge property is enabled or true, this level is the maximum number of records that can exist in the table. The auto purge process occurs or is triggered, and it will prune the table according to the Purge Rule. If Auto Purge is not true or enabled then record inserts will fail and no further data will be allowed into the table.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setThreshold in interface ITemporalFeatureClass
Parameters:
pVal - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPurgePercentage

public double getPurgePercentage()
                          throws IOException,
                                 AutomationException
Indicates percentage of the maximum number of records to delete when the Purge method is called.

Description

This property indicates the percentage of the maximum allowed number of records to delete when the Purge method is called. This maximum allowed limit is also the same as the Threshold property.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getPurgePercentage in interface ITemporalFeatureClass
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPurgePercentage

public void setPurgePercentage(double pVal)
                        throws IOException,
                               AutomationException
Indicates percentage of the maximum number of records to delete when the Purge method is called.

Description

This property indicates the percentage of the maximum allowed number of records to delete when the Purge method is called. This maximum allowed limit is also the same as the Threshold property.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setPurgePercentage in interface ITemporalFeatureClass
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPurgeRule

public int getPurgeRule()
                 throws IOException,
                        AutomationException
Indicates rule to use when purging records when AutoPurge is true (e.g., purge oldest records).

Description

This property identifies the purge rule to apply when the Purge method is called via user, or the auto purge criteria. See the purge rule enumeration constants for details about each rule.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getPurgeRule in interface ITemporalFeatureClass
Returns:
A com.esri.arcgis.geodatabaseextensions.enumPurgeRule constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPurgeRule

public void setPurgeRule(int pVal)
                  throws IOException,
                         AutomationException
Indicates rule to use when purging records when AutoPurge is true (e.g., purge oldest records).

Description

This property identifies the purge rule to apply when the Purge method is called via user ,or the auto purge criteria.

See the purge rule enumeration constants for details about each rule.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setPurgeRule in interface ITemporalFeatureClass
Parameters:
pVal - A com.esri.arcgis.geodatabaseextensions.enumPurgeRule constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

pruneTable

public void pruneTable()
                throws IOException,
                       AutomationException
Apply the purge rule to the temporal table.

Description

This function applies the purge rule to the temporal table to purge observations that meet a specified criteria--the user-defined Purge Rule--when the high-water mark has been exceeded.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
pruneTable in interface ITemporalFeatureClass
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getServerName

public String getServerName()
                     throws IOException,
                            AutomationException
Return Server Name.

Product Availability

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

Specified by:
getServerName in interface ITemporalFeatureClass2
Specified by:
getServerName in interface ITemporalFeatureClass3
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getConnectionName

public String getConnectionName()
                         throws IOException,
                                AutomationException
Return Connection Name.

Product Availability

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

Specified by:
getConnectionName in interface ITemporalFeatureClass2
Specified by:
getConnectionName in interface ITemporalFeatureClass3
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTemporalObjectColumnName

public void setTemporalObjectColumnName(String rhs1)
                                 throws IOException,
                                        AutomationException
Name of the column containing the track information.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setTemporalObjectColumnName in interface ITemporalFeatureClass3
Parameters:
rhs1 - The rhs1 (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException
The name of the Dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getName in interface 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:

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

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.

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.

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.

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

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:

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.

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.

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.

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:

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:

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.

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

writeProperties

public void writeProperties(IStream piStream)
                     throws IOException,
                            AutomationException
Write the object's properties to a stream.

Product Availability

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

Specified by:
writeProperties in interface IDirectData
Parameters:
piStream - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

readProperties

public void readProperties(IStream piStream)
                    throws IOException,
                           AutomationException
Load an object's properties from a stream.

Product Availability

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

Specified by:
readProperties in interface IDirectData
Parameters:
piStream - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

postMessage

public void postMessage(IDataMessage piMsg)
                 throws IOException,
                        AutomationException
All temporal messages enter the temporal feature class environment via this method. It performs validity checks, exclusions, data store purges, pre- and post- actions, and database insertion.

Product Availability

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

Specified by:
postMessage in interface IDirectData
Parameters:
piMsg - A reference to a com.esri.arcgis.geodatabaseextensions.IDataMessage (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPreActionProcessor

public IActionProcessor getPreActionProcessor()
                                       throws IOException,
                                              AutomationException
The action processor that will evaluate the data messages before they are stored. This permits filtering or ignoring messages that the action indicates.

Product Availability

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

Specified by:
getPreActionProcessor in interface IDirectData
Returns:
A reference to a com.esri.arcgis.carto.IActionProcessor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPreActionProcessorByRef

public void setPreActionProcessorByRef(IActionProcessor ppiProcessor)
                                throws IOException,
                                       AutomationException
The action processor that will evaluate the data messages before they are stored. This permits filtering or ignoring messages that the action indicates.

Product Availability

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

Specified by:
setPreActionProcessorByRef in interface IDirectData
Parameters:
ppiProcessor - A reference to a com.esri.arcgis.carto.IActionProcessor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPreActions

public IActionCollection getPreActions()
                                throws IOException,
                                       AutomationException
Collection of actions that will be evaluated before data messages are placed in feature class storage.

Product Availability

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

Specified by:
getPreActions in interface IDirectData
Returns:
A reference to a com.esri.arcgis.carto.IActionCollection
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPreActionsByRef

public void setPreActionsByRef(IActionCollection ppiActions)
                        throws IOException,
                               AutomationException
Collection of actions that will be evaluated before data messages are placed in feature class storage.

Product Availability

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

Specified by:
setPreActionsByRef in interface IDirectData
Parameters:
ppiActions - A reference to a com.esri.arcgis.carto.IActionCollection (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

lastKnownOIDs

public IFeatureIDSet lastKnownOIDs(Object varStartingTime,
                                   Object varEndingTime)
                            throws IOException,
                                   AutomationException
Searches for the last known OIDs in the dataset.

Product Availability

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

Specified by:
lastKnownOIDs in interface ITemporalSearch
Parameters:
varStartingTime - A Variant (in)
varEndingTime - A Variant (in)
Returns:
A reference to a com.esri.arcgis.carto.IFeatureIDSet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

lastKnownFeatures

public ICursor lastKnownFeatures(Object varStartingTime,
                                 Object varEndingTime)
                          throws IOException,
                                 AutomationException
Searches for last known features in the dataset.

Product Availability

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

Specified by:
lastKnownFeatures in interface ITemporalSearch
Parameters:
varStartingTime - A Variant (in)
varEndingTime - A Variant (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.

getCurrentZone

public String getCurrentZone()
                      throws IOException,
                             AutomationException
The current Time Zone.

Description

This property indicates the current time zone the temporal feature class’ temporal field is using.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getCurrentZone in interface ITimeZone
Returns:
The pbstrCurrentZone
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCurrentZone

public void setCurrentZone(String pbstrCurrentZone)
                    throws IOException,
                           AutomationException
The current Time Zone.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setCurrentZone in interface ITimeZone
Parameters:
pbstrCurrentZone - The pbstrCurrentZone (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getZoneList

public Object getZoneList()
                   throws IOException,
                          AutomationException
List of time zones.

Description

This property indicates a list of time zones that are pulled from the computer’s registry.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getZoneList in interface ITimeZone
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAdjustForDaylightSavings

public boolean isAdjustForDaylightSavings()
                                   throws IOException,
                                          AutomationException
Indicates whether or not to Adjust For Daylight Savings.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
isAdjustForDaylightSavings in interface ITimeZone
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAdjustForDaylightSavings

public void setAdjustForDaylightSavings(boolean pVal)
                                 throws IOException,
                                        AutomationException
Indicates whether or not to Adjust For Daylight Savings.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setAdjustForDaylightSavings in interface ITimeZone
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTimeZoneXML

public String getTimeZoneXML()
                      throws IOException,
                             AutomationException
The XML representation of a TimeZone.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getTimeZoneXML in interface ITimeZone
Returns:
The pbstrXML
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTimeZoneXML

public void setTimeZoneXML(String pbstrXML)
                    throws IOException,
                           AutomationException
The XML representation of a TimeZone.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setTimeZoneXML in interface ITimeZone
Parameters:
pbstrXML - The pbstrXML (in)
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.

getExcludedTrackingEventIDs

public IStringArray getExcludedTrackingEventIDs()
                                         throws IOException,
                                                AutomationException
String array of EventIDs to be permanently purged and ignored.

Product Availability

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

Specified by:
getExcludedTrackingEventIDs in interface IExcludedEventIDs
Returns:
A reference to a com.esri.arcgis.system.IStringArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExcludedTrackingEventIDs

public void setExcludedTrackingEventIDs(IStringArray pVal)
                                 throws IOException,
                                        AutomationException
String array of EventIDs to be permanently purged and ignored.

Product Availability

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

Specified by:
setExcludedTrackingEventIDs in interface IExcludedEventIDs
Parameters:
pVal - A reference to a com.esri.arcgis.system.IStringArray (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTrackCount

public int getTrackCount()
                  throws IOException,
                         AutomationException
Indicates the TemporalFeatureClass track count.

Product Availability

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

Specified by:
getTrackCount in interface ITemporalFeatureClassStatistics
Returns:
The plTrackCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMessageRate

public double getMessageRate()
                      throws IOException,
                             AutomationException
Indicates the TemporalFeatureClass message rate.

Product Availability

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

Specified by:
getMessageRate in interface ITemporalFeatureClassStatistics
Returns:
The pdMessageRate
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSampleSize

public int getSampleSize()
                  throws IOException,
                         AutomationException
Indicates the sample size used to calculate message rate.

Product Availability

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

Specified by:
getSampleSize in interface ITemporalFeatureClassStatistics
Returns:
The plSampleSize
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSampleSize

public void setSampleSize(int plSampleSize)
                   throws IOException,
                          AutomationException
Indicates the sample size used to calculate message rate.

Product Availability

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

Specified by:
setSampleSize in interface ITemporalFeatureClassStatistics
Parameters:
plSampleSize - The plSampleSize (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTotalFeatureCount

public Object getTotalFeatureCount()
                            throws IOException,
                                   AutomationException
Indicates the total number of features logged.

Product Availability

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

Specified by:
getTotalFeatureCount in interface ITemporalFeatureClassStatistics
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

resetFeatureCount

public void resetFeatureCount()
                       throws IOException,
                              AutomationException
Resets total feature count.

Product Availability

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

Specified by:
resetFeatureCount in interface ITemporalFeatureClassStatistics
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

resetMessageRate

public void resetMessageRate()
                      throws IOException,
                             AutomationException
Resets message rate.

Product Availability

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

Specified by:
resetMessageRate in interface ITemporalFeatureClassStatistics
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAllLockedFIDs

public IFIDSet getAllLockedFIDs()
                         throws IOException,
                                AutomationException
Indicates the FIDs for all locked features.

Product Availability

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

Specified by:
getAllLockedFIDs in interface ILockedFeatureSearch
Returns:
A reference to a com.esri.arcgis.geodatabase.IFIDSet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

searchAndLock

public ICursor searchAndLock(IQueryFilter piQueryFilter,
                             boolean recycling)
                      throws IOException,
                             AutomationException
Searches records that satisfy the query filter and lockes them.

Product Availability

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

Specified by:
searchAndLock in interface ILockedFeatureSearch
Parameters:
piQueryFilter - 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.

selectAndLock

public ISelectionSet selectAndLock(IQueryFilter piQueryFilter,
                                   int selType,
                                   int selOption,
                                   IWorkspace piSelectionContainer)
                            throws IOException,
                                   AutomationException
Selectes records that satisfy the query filter, selection type and selection option, and lockes them.

Product Availability

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

Specified by:
selectAndLock in interface ILockedFeatureSearch
Parameters:
piQueryFilter - 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)
piSelectionContainer - 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.

unlockAllFeatures

public void unlockAllFeatures()
                       throws IOException,
                              AutomationException
Unlocks all features that are locked.

Product Availability

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

Specified by:
unlockAllFeatures in interface ILockedFeatureSearch
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException
interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
interfaceSupportsErrorInfo in interface ISupportErrorInfo
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFirstTrackId

public String getFirstTrackId()
                       throws IOException,
                              AutomationException
Retrives the first Track ID in the list.

Product Availability

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

Specified by:
getFirstTrackId in interface ITxEnumTrackId
Returns:
The trackId
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNextTrackId

public String getNextTrackId()
                      throws IOException,
                             AutomationException
Retrives the next Track ID in the list.

Product Availability

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

Specified by:
getNextTrackId in interface ITxEnumTrackId
Returns:
The trackId
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTrackIds

public String[] getTrackIds()
                     throws IOException,
                            AutomationException
Retrives the Track ID list.

Product Availability

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

Specified by:
getTrackIds in interface ITxEnumTrackId
Returns:
The trackIds
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTrackFeatures

public ISelectionSet getTrackFeatures(String trackId)
                               throws IOException,
                                      AutomationException
Returns a selection set of features in a given track.

Product Availability

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

Specified by:
getTrackFeatures in interface ITxEnumTrackId
Parameters:
trackId - The trackId (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.

getLastUpdateTime

public ITime getLastUpdateTime(String trackId)
                        throws IOException,
                               AutomationException
Returns the time that a given track was last updated.

Product Availability

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

Specified by:
getLastUpdateTime in interface ITxEnumTrackId
Parameters:
trackId - The trackId (in)
Returns:
A reference to a com.esri.arcgis.system.ITime
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryTrackTimeExtent

public void queryTrackTimeExtent(String trackId,
                                 ITime[] startTime,
                                 ITime[] endTime)
                          throws IOException,
                                 AutomationException
Returns the start and end times of a given track.

Product Availability

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

Specified by:
queryTrackTimeExtent in interface ITxEnumTrackId
Parameters:
trackId - The trackId (in)
startTime - A reference to a com.esri.arcgis.system.ITime (out: use single element array)
endTime - A reference to a com.esri.arcgis.system.ITime (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.