com.esri.arcgis.trackinganalyst
Class TemporalFeatureClass

java.lang.Object
  extended bycom.esri.arcgis.trackinganalyst.TemporalFeatureClass
All Implemented Interfaces:
IClass, IDataset, IDatasetEdit, IDirectData, IExcludedEventIDs, IFeatureClass, IGeoDataset, IObjectClass, ITable, ITableCapabilities, ITemporalFeatureClass, ITemporalFeatureClass2, ITemporalSearch, ITimeZone, java.io.Serializable

public class TemporalFeatureClass
extends java.lang.Object
implements IDataset, IDatasetEdit, ITable, IClass, IObjectClass, IGeoDataset, IFeatureClass, ITemporalFeatureClass, IDirectData, ITemporalSearch, ITimeZone, ITableCapabilities, ITemporalFeatureClass2, IExcludedEventIDs

Controls settings for the temporal feature class.

Product Availability

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

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.  This class will utilize a custom in memory database.

See Also:
Serialized Form

Constructor Summary
TemporalFeatureClass(java.lang.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(java.lang.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(java.lang.Object o)
          Compare this object with another
 int featureCount(IQueryFilter queryFilter)
          The number of features selected by the specified query.
 int findField(java.lang.String name)
          The index of the field with the specified name.
 java.lang.String getAliasName()
          The alias name of the object class.
 IField getAreaField()
          The geometry area field.
 IClass getAsIClass()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IDataset getAsIDataset()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IDatasetEdit getAsIDatasetEdit()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IDirectData getAsIDirectData()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IExcludedEventIDs getAsIExcludedEventIDs()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IFeatureClass getAsIFeatureClass()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IGeoDataset getAsIGeoDataset()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IObjectClass getAsIObjectClass()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 ITable getAsITable()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 ITableCapabilities getAsITableCapabilities()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 ITemporalFeatureClass getAsITemporalFeatureClass()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 ITemporalFeatureClass2 getAsITemporalFeatureClass2()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 ITemporalSearch getAsITemporalSearch()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 ITimeZone getAsITimeZone()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 java.lang.String getBrowseName()
          The browse name of the dataset.
 java.lang.String getCategory()
          The category of the dataset.
 IUID getCLSID()
          The GUID for the COM Class (CoClass) corresponding to instances of this object class.
 java.lang.String getConnectionName()
          Return Connection Name.
 java.lang.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.
 java.lang.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(java.lang.Object fids, boolean recycling)
          Get a cursor of Rows given a set of object ids.
 int getFeatureType()
          The type of features in this feature class.
 IFields getFields()
          The fields collection for this object class.
 IName getFullName()
          The associated name object.
 IIndexes getIndexes()
          The indexes collection for this object class.
 IField getLengthField()
          The geometry length field.
 java.lang.String getName()
          The name of the Dataset.
 int getObjectClassID()
          The unique ID for the object class.
 java.lang.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()
          Property PreActionProcessor.
 IActionCollection getPreActions()
          Property PreActions.
 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(java.lang.Object oids, boolean recycling)
          The cursor of rows based on a set of object ids.
 java.lang.String getServerName()
          Return Server Name.
 java.lang.String getShapeFieldName()
          The name of the default sShape field.
 int getShapeType()
          The type of the default Shape for the features in this feature class.
 ISpatialReference getSpatialReference()
          The spatial reference of the GeoDataset.
 IEnumDataset getSubsets()
          Datasets contained within this dataset.
 java.lang.String getTemporalColumnName()
          Name of the column containing the time-date information.
 java.lang.String getTemporalObjectColumnName()
          Name of the column containing the temporal information.
 java.lang.Object getThreshold()
          Indicates the high-water mark, or maximum number of observations allowed before records are purged from memory.
 java.lang.String getTimeZoneXML()
          The XML representation of a TimeZone.
 int getType()
          The type of the Dataset.
 IWorkspace getWorkspace()
          The workspace containing this dataset.
 java.lang.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.
 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(java.lang.Object varStartingTime, java.lang.Object varEndingTime)
          Searches for last known features in the dataset.
 IFeatureIDSet lastKnownOIDs(java.lang.Object varStartingTime, java.lang.Object varEndingTime)
          Searches for the last known OIDs in the dataset.
 void postMessage(IDataMessage piMsg)
          Method PostMessage.
 void pruneTable()
          Method PruneTable.
 void queryTemporalExtent(java.lang.Object[] pvarStartTime, java.lang.Object[] pvarEndTime)
          Queries the feature class using the full temporal extent.
 void readProperties(IStream piStream)
          Method ReadProperties.
 void registerListener(IListener piListener)
          Registers a Listener Object with the feature class.
 void rename(java.lang.String name)
          Renames this Dataset.
 int rowCount(IQueryFilter queryFilter)
          The number of Rows selected by the specified query.
 IFeatureCursor search(IQueryFilter filter, boolean recycling)
          Returns an object cursor that can be used to fetch feature objects selected by the specified query.
 ISelectionSet select(IQueryFilter queryFilter, int selType, int selOption, IWorkspace selectionContainer)
          A selection that contains the object ids selected by the specified query.
 void 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(java.lang.String name)
          The browse name of the dataset.
 void setCurrentZone(java.lang.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)
          Property PreActionProcessor.
 void setPreActionsByRef(IActionCollection ppiActions)
          Property PreActions.
 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 setTemporalColumnName(java.lang.String pVal)
          Name of the column containing the time-date information.
 void setThreshold(java.lang.Object pVal)
          Indicates the high-water mark, or maximum number of observations allowed before records are purged from memory.
 void setTimeZoneXML(java.lang.String pbstrXML)
          The XML representation of a TimeZone.
 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)
          Method WriteProperties.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TemporalFeatureClass

public TemporalFeatureClass(java.lang.Object obj)
                     throws java.io.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 TemporalFeatureClass theTemporalFeatureClass = (TemporalFeatureClass) obj;

Throws:
java.io.IOException - if there are interop problems
Method Detail

getAsIDataset

public IDataset getAsIDataset()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIDatasetEdit

public IDatasetEdit getAsIDatasetEdit()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsITable

public ITable getAsITable()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIClass

public IClass getAsIClass()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIObjectClass

public IObjectClass getAsIObjectClass()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIGeoDataset

public IGeoDataset getAsIGeoDataset()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIFeatureClass

public IFeatureClass getAsIFeatureClass()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsITemporalFeatureClass

public ITemporalFeatureClass getAsITemporalFeatureClass()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIDirectData

public IDirectData getAsIDirectData()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsITemporalSearch

public ITemporalSearch getAsITemporalSearch()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsITimeZone

public ITimeZone getAsITimeZone()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsITableCapabilities

public ITableCapabilities getAsITableCapabilities()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsITemporalFeatureClass2

public ITemporalFeatureClass2 getAsITemporalFeatureClass2()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIExcludedEventIDs

public IExcludedEventIDs getAsIExcludedEventIDs()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


equals

public boolean equals(java.lang.Object o)
Compare this object with another


hashCode

public int hashCode()
the hashcode for this object


getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
Description copied from interface: IDataset
The name of the Dataset.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getName in interface IDataset
Returns:
The name
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getFullName

public IName getFullName()
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IDataset
The associated name object.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
getFullName in interface IDataset
Returns:
A reference to a com.esri.arcgis.system.IName
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getBrowseName

public java.lang.String getBrowseName()
                               throws java.io.IOException,
                                      AutomationException
Description copied from interface: IDataset
The browse name of the dataset.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

Specified by:
getBrowseName in interface IDataset
Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBrowseName

public void setBrowseName(java.lang.String name)
                   throws java.io.IOException,
                          AutomationException
Description copied from interface: IDataset
The browse name of the dataset.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setBrowseName in interface IDataset
Parameters:
name - The name (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getType

public int getType()
            throws java.io.IOException,
                   AutomationException
Description copied from interface: IDataset
The type of the Dataset.

Supported Platforms

Windows, Solaris, Linux

Remarks

The Type property returns the enumerated type for the dataset, such as esriDTTable or esriDTFeatureDataset.

Specified by:
getType in interface IDataset
Returns:
A com.esri.arcgis.geodatabase.esriDatasetType constant
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getCategory

public java.lang.String getCategory()
                             throws java.io.IOException,
                                    AutomationException
Description copied from interface: IDataset
The category of the dataset.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
getCategory in interface IDataset
Returns:
The category
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getSubsets

public IEnumDataset getSubsets()
                        throws java.io.IOException,
                               AutomationException
Description copied from interface: IDataset
Datasets contained within this dataset.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
getSubsets in interface IDataset
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumDataset
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getWorkspace

public IWorkspace getWorkspace()
                        throws java.io.IOException,
                               AutomationException
Description copied from interface: IDataset
The workspace containing this dataset.

Supported Platforms

Windows, Solaris, Linux

Description

The Workspace property returns the containing workspace for this dataset.

Specified by:
getWorkspace in interface IDataset
Returns:
A reference to a com.esri.arcgis.geodatabase.IWorkspace
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPropertySet

public IPropertySet getPropertySet()
                            throws java.io.IOException,
                                   AutomationException
Description copied from interface: IDataset
The set of properties for the dataset.

Supported Platforms

Windows, Solaris, Linux

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.

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.

Specified by:
getPropertySet in interface IDataset
Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

canCopy

public boolean canCopy()
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IDataset
True if this dataset can be copied.

Supported Platforms

Windows, Solaris, Linux

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:

Specified by:
canCopy in interface IDataset
Returns:
The canCopy
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

copy

public IDataset copy(java.lang.String copyName,
                     IWorkspace copyWorkspace)
              throws java.io.IOException,
                     AutomationException
Description copied from interface: IDataset
Copies this dataset to a new dataset with the specified name.

Supported Platforms

Windows, Solaris, Linux

Remarks

IDataset::Copy does not support the copying of Graph objects such as a Geometric Network.

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:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
See Also:
GeoDBDataTransfer

canDelete

public boolean canDelete()
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IDataset
True if this dataset can be deleted.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
canDelete in interface IDataset
Returns:
The canDelete
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

delete

public void delete()
            throws java.io.IOException,
                   AutomationException
Description copied from interface: IDataset
Deletes this dataset.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

Specified by:
delete in interface IDataset
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

canRename

public boolean canRename()
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IDataset
True if this dataset can be renamed.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
canRename in interface IDataset
Returns:
The canRename
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

rename

public void rename(java.lang.String name)
            throws java.io.IOException,
                   AutomationException
Description copied from interface: IDataset
Renames this Dataset.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
rename in interface IDataset
Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isBeingEdited

public boolean isBeingEdited()
                      throws java.io.IOException,
                             AutomationException
Description copied from interface: IDatasetEdit
True if the dataset is being edited.

Specified by:
isBeingEdited in interface IDatasetEdit
Returns:
The pIsBeingEdited
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createRow

public IRow createRow()
               throws java.io.IOException,
                      AutomationException
Description copied from interface: ITable
Creates a row in the database with a system assigned object ID and null property values.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

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

Specified by:
createRow in interface ITable
Returns:
A reference to a com.esri.arcgis.geodatabase.IRow
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRow

public IRow getRow(int oID)
            throws java.io.IOException,
                   AutomationException
Description copied from interface: ITable
The row from the database with the specified object ID.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

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

getRows

public ICursor getRows(java.lang.Object oids,
                       boolean recycling)
                throws java.io.IOException,
                       AutomationException
Description copied from interface: ITable
The cursor of rows based on a set of object ids.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

Specified by:
getRows in interface ITable
Parameters:
oids - A Variant (in)
recycling - The recycling (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ICursor
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

createRowBuffer

public IRowBuffer createRowBuffer()
                           throws java.io.IOException,
                                  AutomationException
Description copied from interface: ITable
Creates a row buffer that can be used with an insert cursor.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

Specified by:
createRowBuffer in interface ITable
Returns:
A reference to a com.esri.arcgis.geodatabase.IRowBuffer
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

updateSearchedRows

public void updateSearchedRows(IQueryFilter queryFilter,
                               IRowBuffer buffer)
                        throws java.io.IOException,
                               AutomationException
Description copied from interface: ITable
Update the Rows in the database selected by the specified query.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

Specified by:
updateSearchedRows in interface ITable
Parameters:
queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
buffer - A reference to a com.esri.arcgis.geodatabase.IRowBuffer (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

deleteSearchedRows

public void deleteSearchedRows(IQueryFilter queryFilter)
                        throws java.io.IOException,
                               AutomationException
Description copied from interface: ITable
Delete the Rows in the database selected by the specified query.

Supported Platforms

Windows, Solaris, Linux

Specified by:
deleteSearchedRows in interface ITable
Parameters:
queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

rowCount

public int rowCount(IQueryFilter queryFilter)
             throws java.io.IOException,
                    AutomationException
Description copied from interface: ITable
The number of Rows selected by the specified query.

Supported Platforms

Windows, Solaris, Linux

Specified by:
rowCount in interface ITable
Parameters:
queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
Returns:
The numRows
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

ITable_search

public ICursor ITable_search(IQueryFilter queryFilter,
                             boolean recycling)
                      throws java.io.IOException,
                             AutomationException
Description copied from interface: ITable
An object cursor that can be used to fetch row objects selected by the specified query.

Specified by:
ITable_search in interface ITable
Parameters:
queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
recycling - The recycling (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ICursor
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

update

public ICursor update(IQueryFilter queryFilter,
                      boolean recycling)
               throws java.io.IOException,
                      AutomationException
Description copied from interface: ITable
Returns a cursor that can be used to update Rows selected by the specified query.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

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

Specified by:
update in interface ITable
Parameters:
queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
recycling - The recycling (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ICursor
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

insert

public ICursor insert(boolean useBuffering)
               throws java.io.IOException,
                      AutomationException
Description copied from interface: ITable
Returns a cursor that can be used to insert new Rows.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

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

Specified by:
insert in interface ITable
Parameters:
useBuffering - The useBuffering (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ICursor
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

select

public ISelectionSet select(IQueryFilter queryFilter,
                            int selType,
                            int selOption,
                            IWorkspace selectionContainer)
                     throws java.io.IOException,
                            AutomationException
Description copied from interface: ITable
A selection that contains the object ids selected by the specified query.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

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

Specified by:
select in interface ITable
Parameters:
queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
selType - A com.esri.arcgis.geodatabase.esriSelectionType constant (in)
selOption - A com.esri.arcgis.geodatabase.esriSelectionOption constant (in)
selectionContainer - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ISelectionSet
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findField

public int findField(java.lang.String name)
              throws java.io.IOException,
                     AutomationException
Description copied from interface: IClass
The index of the field with the specified name.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

Specified by:
findField in interface IClass
Parameters:
name - The name (in)
Returns:
The fieldIndex
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getFields

public IFields getFields()
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IClass
The fields collection for this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getFields in interface IClass
Returns:
A reference to a com.esri.arcgis.geodatabase.IFields
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getIndexes

public IIndexes getIndexes()
                    throws java.io.IOException,
                           AutomationException
Description copied from interface: IClass
The indexes collection for this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getIndexes in interface IClass
Returns:
A reference to a com.esri.arcgis.geodatabase.IIndexes
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addField

public void addField(IField field)
              throws java.io.IOException,
                     AutomationException
Description copied from interface: IClass
Adds a field to this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:
addField in interface IClass
Parameters:
field - A reference to a com.esri.arcgis.geodatabase.IField (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteField

public void deleteField(IField field)
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: IClass
Deletes a field from this object class.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

 

Specified by:
deleteField in interface IClass
Parameters:
field - A reference to a com.esri.arcgis.geodatabase.IField (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addIndex

public void addIndex(IIndex index)
              throws java.io.IOException,
                     AutomationException
Description copied from interface: IClass
Adds an index to this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:
addIndex in interface IClass
Parameters:
index - A reference to a com.esri.arcgis.geodatabase.IIndex (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteIndex

public void deleteIndex(IIndex index)
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: IClass
Deletes an index from this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:
deleteIndex in interface IClass
Parameters:
index - A reference to a com.esri.arcgis.geodatabase.IIndex (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isHasOID

public boolean isHasOID()
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: IClass
Indicates if the class has an object identity (OID) field.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isHasOID in interface IClass
Returns:
The hasOID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOIDFieldName

public java.lang.String getOIDFieldName()
                                 throws java.io.IOException,
                                        AutomationException
Description copied from interface: IClass
The name of the field corresponding to the OID.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getOIDFieldName in interface IClass
Returns:
The name
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getCLSID

public IUID getCLSID()
              throws java.io.IOException,
                     AutomationException
Description copied from interface: IClass
The GUID for the COM Class (CoClass) corresponding to instances of this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getCLSID in interface IClass
Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEXTCLSID

public IUID getEXTCLSID()
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: IClass
The GUID for the COM Class (CoClass) corresponding to the class extension for this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getEXTCLSID in interface IClass
Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getExtension

public java.lang.Object getExtension()
                              throws java.io.IOException,
                                     AutomationException
Description copied from interface: IClass
The extension for this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getExtension in interface IClass
Returns:
A reference to another Object (IUnknown)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtensionProperties

public IPropertySet getExtensionProperties()
                                    throws java.io.IOException,
                                           AutomationException
Description copied from interface: IClass
The extension properties for this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getExtensionProperties in interface IClass
Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getObjectClassID

public int getObjectClassID()
                     throws java.io.IOException,
                            AutomationException
Description copied from interface: IObjectClass
The unique ID for the object class.

Supported Platforms

Windows, Solaris, Linux

Description

Returns the unique ID of the object class.

Remarks

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

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

Specified by:
getObjectClassID in interface IObjectClass
Returns:
The objectClassID
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getRelationshipClasses

public IEnumRelationshipClass getRelationshipClasses(int role)
                                              throws java.io.IOException,
                                                     AutomationException
Description copied from interface: IObjectClass
The relationship classes in which this object class participates in for the specified role.

Supported Platforms

Windows, Solaris, Linux

Description

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

Remarks

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

Specified by:
getRelationshipClasses in interface IObjectClass
Parameters:
role - A com.esri.arcgis.geodatabase.esriRelRole constant (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumRelationshipClass
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
IEnumRelationshipClass, esriRelRole

getAliasName

public java.lang.String getAliasName()
                              throws java.io.IOException,
                                     AutomationException
Description copied from interface: IObjectClass
The alias name of the object class.

Supported Platforms

Windows, Solaris, Linux

Description

Returns the alias name for the object class.

Remarks

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

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

Specified by:
getAliasName in interface IObjectClass
Returns:
The name
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
See Also:
IModelInfo

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws java.io.IOException,
                                             AutomationException
Description copied from interface: IGeoDataset
The spatial reference of the GeoDataset.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
getSpatialReference in interface IGeoDataset
Returns:
A reference to a com.esri.arcgis.geometry.ISpatialReference
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtent

public IEnvelope getExtent()
                    throws java.io.IOException,
                           AutomationException
Description copied from interface: IGeoDataset
The extent of the GeoDataset.

Supported Platforms

Windows, Solaris, Linux

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.

 

Specified by:
getExtent in interface IGeoDataset
Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getShapeType

public int getShapeType()
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: IFeatureClass
The type of the default Shape for the features in this feature class.

Supported Platforms

Windows, Solaris, Linux

Description

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

Remarks

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

Specified by:
getShapeType in interface IFeatureClass
Returns:
A com.esri.arcgis.geometry.esriGeometryType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFeatureType

public int getFeatureType()
                   throws java.io.IOException,
                          AutomationException
Description copied from interface: IFeatureClass
The type of features in this feature class.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

Specified by:
getFeatureType in interface IFeatureClass
Returns:
A com.esri.arcgis.geodatabase.esriFeatureType constant
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
See Also:
esriFeatureType

getShapeFieldName

public java.lang.String getShapeFieldName()
                                   throws java.io.IOException,
                                          AutomationException
Description copied from interface: IFeatureClass
The name of the default sShape field.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

Specified by:
getShapeFieldName in interface IFeatureClass
Returns:
The name
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
See Also:
IGeometry, ILine, IPoint, IPolygon

getAreaField

public IField getAreaField()
                    throws java.io.IOException,
                           AutomationException
Description copied from interface: IFeatureClass
The geometry area field.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

A null pointer will be returned if:

Specified by:
getAreaField in interface IFeatureClass
Returns:
A reference to a com.esri.arcgis.geodatabase.IField
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
See Also:
IField, IFields

getLengthField

public IField getLengthField()
                      throws java.io.IOException,
                             AutomationException
Description copied from interface: IFeatureClass
The geometry length field.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

A null pointer will be returned if:

Specified by:
getLengthField in interface IFeatureClass
Returns:
A reference to a com.esri.arcgis.geodatabase.IField
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
See Also:
IField, IFields

getFeatureDataset

public IFeatureDataset getFeatureDataset()
                                  throws java.io.IOException,
                                         AutomationException
Description copied from interface: IFeatureClass
The feature dataset that contains the feature class.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

Specified by:
getFeatureDataset in interface IFeatureClass
Returns:
A reference to a com.esri.arcgis.geodatabase.IFeatureDataset
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
IFeatureDataset, IDataset

createFeature

public IFeature createFeature()
                       throws java.io.IOException,
                              AutomationException
Description copied from interface: IFeatureClass
Create a new feature, with a system assigned object ID and null property values.

Supported Platforms

Windows, Solaris, Linux

Remarks

CreateFeature will create a new feature for the feature class. The new feature is by default assigned a unique object ID (OID). All other fields are initialized to null values if they can be made null and to built-in default values appropriate to the type of the field if they cannot be made null. Use the IFeature::Store method to actually store this new feature in the database. When working with a versioned feature class, CreateFeature should only be called within an edit session. You can start an edit session by calling IWorkspaceEdit::StartEditing. All edits to features that participate in a Topology or Geometric Network must be performed within an edit session and bracketed within an edit operation.

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

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

The basic process to create a new feature is:

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

Specified by:
createFeature in interface IFeatureClass
Returns:
A reference to a com.esri.arcgis.geodatabase.IFeature
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
IFeature, IRowSubtypes, IWorkspaceEdit

getFeature

public IFeature getFeature(int iD)
                    throws java.io.IOException,
                           AutomationException
Description copied from interface: IFeatureClass
Get the feature with the specified object ID.

Supported Platforms

Windows, Solaris, Linux

Remarks

GetFeature will return the IFeature interface for a feature in the feature class with a given Object ID (OID). This method is typically used to find a particular feature that you know the OID for.  Use a cursor if you wish to loop through all features in the feature class.

Calling the GetFeature method on a feature class (via the IFeatureClass interface on the feature class) has the same effect as calling the GetRow method on the FeatureClass (via the ITable interface on the feature class) except that the IFeatureClass methods return IFeature interfaces.
 

Specified by:
getFeature in interface IFeatureClass
Parameters:
iD - The iD (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IFeature
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
See Also:
IObject, IFeature

getFeatures

public IFeatureCursor getFeatures(java.lang.Object fids,
                                  boolean recycling)
                           throws java.io.IOException,
                                  AutomationException
Description copied from interface: IFeatureClass
Get a cursor of Rows given a set of object ids.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

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

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

getFeatureClassID

public int getFeatureClassID()
                      throws java.io.IOException,
                             AutomationException
Description copied from interface: IFeatureClass
The unique ID for the Feature Class.

Supported Platforms

Windows, Solaris, Linux

Remarks

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


Specified by:
getFeatureClassID in interface IFeatureClass
Returns:
The fID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
IObjectClass

createFeatureBuffer

public IFeatureBuffer createFeatureBuffer()
                                   throws java.io.IOException,
                                          AutomationException
Description copied from interface: IFeatureClass
Create a feature buffer that can be used with an insert cursor.

Supported Platforms

Windows, Solaris, Linux

Remarks

The CreateFeatureBuffer method creates a feature buffer and returns the IFeatureBuffer interface. This can be used to create new features in the feature class with an insert cursor. Like creating a feature with IFeatureClass::CreateFeature, the field values for the new feature must be initialized to some value before it can be stored in the database. All edits to features that participate in a Topology or Geometric Network must be performed within an edit session and bracketed within an edit operation.

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

Specified by:
createFeatureBuffer in interface IFeatureClass
Returns:
A reference to a com.esri.arcgis.geodatabase.IFeatureBuffer
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
IFeature, IFeatureCursor, IFeatureBuffer

featureCount

public int featureCount(IQueryFilter queryFilter)
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: IFeatureClass
The number of features selected by the specified query.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

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

Specified by:
featureCount in interface IFeatureClass
Parameters:
queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
Returns:
The numFeatures
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
See Also:
IQueryFilter

search

public IFeatureCursor search(IQueryFilter filter,
                             boolean recycling)
                      throws java.io.IOException,
                             AutomationException
Description copied from interface: IFeatureClass
Returns an object cursor that can be used to fetch feature objects selected by the specified query.

Supported Platforms

Windows, Solaris, Linux

Remarks

Search will return an IFeatureCursor with all of the features that satisfy some attribute and/or spatial query as specified by an IQueryFilter object. If Nothing is given as the IQueryFilter, then the feature cursor will have all of the features from the feature class.

The recycling parameter controls row object allocation behavior. Recycling cursors rehydrate a single feature object on each fetch and can be used to optimize read-only access, for example, when drawing. It is illegal to maintain a reference on a feature object returned by a recycling cursor across multiple calls to NextFeature on the cursor. Feature objects returned by a recycling cursor should not be modified. Non-recycling cursors return a separate feature object on each fetch. The features returned by a non-recycling cursor may be modified and stored with polymorphic behavior. The Geodatabase guarantees "unique instance semantics" on non-recycling feature objects fetched during an edit session. If the feature object to be retrieved by a call to search has already been instantiated and is being referenced by the calling application, then a reference to the existing feature object is returned.

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

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

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

IFeatureClass_update

public IFeatureCursor IFeatureClass_update(IQueryFilter filter,
                                           boolean recycling)
                                    throws java.io.IOException,
                                           AutomationException
Description copied from interface: IFeatureClass
Returns a cursor that can be used to update features selected by the specified query.

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

IFeatureClass_insert

public IFeatureCursor IFeatureClass_insert(boolean useBuffering)
                                    throws java.io.IOException,
                                           AutomationException
Description copied from interface: IFeatureClass
Returns a cursor that can be used to insert new features.

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

queryTemporalExtent

public void queryTemporalExtent(java.lang.Object[] pvarStartTime,
                                java.lang.Object[] pvarEndTime)
                         throws java.io.IOException,
                                AutomationException
Description copied from interface: ITemporalFeatureClass
Queries the feature class using the full temporal extent.

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

getTemporalColumnName

public java.lang.String getTemporalColumnName()
                                       throws java.io.IOException,
                                              AutomationException
Description copied from interface: ITemporalFeatureClass
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.

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

setTemporalColumnName

public void setTemporalColumnName(java.lang.String pVal)
                           throws java.io.IOException,
                                  AutomationException
Description copied from interface: ITemporalFeatureClass
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.

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

isContainsTemporalObjects

public boolean isContainsTemporalObjects()
                                  throws java.io.IOException,
                                         AutomationException
Description copied from interface: ITemporalFeatureClass
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.

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

getTemporalObjectColumnName

public java.lang.String getTemporalObjectColumnName()
                                             throws java.io.IOException,
                                                    AutomationException
Description copied from interface: ITemporalFeatureClass
Name of the column containing the temporal 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.

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

getPostActionProcessor

public IActionProcessor getPostActionProcessor()
                                        throws java.io.IOException,
                                               AutomationException
Description copied from interface: ITemporalFeatureClass
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.

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

setPostActionProcessorByRef

public void setPostActionProcessorByRef(IActionProcessor ppiProcessor)
                                 throws java.io.IOException,
                                        AutomationException
Description copied from interface: ITemporalFeatureClass
Evaluates data messages once they are placed in the feature class' internal storage.

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

getPostActions

public IActionCollection getPostActions()
                                 throws java.io.IOException,
                                        AutomationException
Description copied from interface: ITemporalFeatureClass
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.

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

setPostActionsByRef

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

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

registerListener

public void registerListener(IListener piListener)
                      throws java.io.IOException,
                             AutomationException
Description copied from interface: ITemporalFeatureClass
Registers a Listener Object with the feature class.

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

isAutoPurge

public boolean isAutoPurge()
                    throws java.io.IOException,
                           AutomationException
Description copied from interface: ITemporalFeatureClass
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.

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

setAutoPurge

public void setAutoPurge(boolean pVal)
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: ITemporalFeatureClass
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.

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

getThreshold

public java.lang.Object getThreshold()
                              throws java.io.IOException,
                                     AutomationException
Description copied from interface: ITemporalFeatureClass
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.

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

setThreshold

public void setThreshold(java.lang.Object pVal)
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: ITemporalFeatureClass
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.

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

getPurgePercentage

public double getPurgePercentage()
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: ITemporalFeatureClass
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.

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

setPurgePercentage

public void setPurgePercentage(double pVal)
                        throws java.io.IOException,
                               AutomationException
Description copied from interface: ITemporalFeatureClass
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.

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

getPurgeRule

public int getPurgeRule()
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: ITemporalFeatureClass
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.

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

setPurgeRule

public void setPurgeRule(int pVal)
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: ITemporalFeatureClass
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.

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

pruneTable

public void pruneTable()
                throws java.io.IOException,
                       AutomationException
Description copied from interface: ITemporalFeatureClass
Method PruneTable.

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

writeProperties

public void writeProperties(IStream piStream)
                     throws java.io.IOException,
                            AutomationException
Description copied from interface: IDirectData
Method WriteProperties.

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

readProperties

public void readProperties(IStream piStream)
                    throws java.io.IOException,
                           AutomationException
Description copied from interface: IDirectData
Method ReadProperties.

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

postMessage

public void postMessage(IDataMessage piMsg)
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: IDirectData
Method PostMessage.

Description

This method is the entry point for all data messages into the feature class.  This method will perform pre and post action processing as well as data validity checking and database insertions.

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

getPreActionProcessor

public IActionProcessor getPreActionProcessor()
                                       throws java.io.IOException,
                                              AutomationException
Description copied from interface: IDirectData
Property PreActionProcessor.

Description

The pre-action processor is the action processor that will evaluate data messages before they are placed in the feature class's internal storage. This action processor has the capability to filter or drop a data message if a user-defined filter rule determines that the data message needs to be excluded.

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

setPreActionProcessorByRef

public void setPreActionProcessorByRef(IActionProcessor ppiProcessor)
                                throws java.io.IOException,
                                       AutomationException
Description copied from interface: IDirectData
Property PreActionProcessor.

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

getPreActions

public IActionCollection getPreActions()
                                throws java.io.IOException,
                                       AutomationException
Description copied from interface: IDirectData
Property PreActions.

Description

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

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

setPreActionsByRef

public void setPreActionsByRef(IActionCollection ppiActions)
                        throws java.io.IOException,
                               AutomationException
Description copied from interface: IDirectData
Property PreActions.

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

lastKnownOIDs

public IFeatureIDSet lastKnownOIDs(java.lang.Object varStartingTime,
                                   java.lang.Object varEndingTime)
                            throws java.io.IOException,
                                   AutomationException
Description copied from interface: ITemporalSearch
Searches for the last known OIDs in the dataset.

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

lastKnownFeatures

public ICursor lastKnownFeatures(java.lang.Object varStartingTime,
                                 java.lang.Object varEndingTime)
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: ITemporalSearch
Searches for last known features in the dataset.

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

getCurrentZone

public java.lang.String getCurrentZone()
                                throws java.io.IOException,
                                       AutomationException
Description copied from interface: ITimeZone
The current Time Zone.

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

setCurrentZone

public void setCurrentZone(java.lang.String pbstrCurrentZone)
                    throws java.io.IOException,
                           AutomationException
Description copied from interface: ITimeZone
The current Time Zone.

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

getZoneList

public java.lang.Object getZoneList()
                             throws java.io.IOException,
                                    AutomationException
Description copied from interface: ITimeZone
List of time zones.

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

isAdjustForDaylightSavings

public boolean isAdjustForDaylightSavings()
                                   throws java.io.IOException,
                                          AutomationException
Description copied from interface: ITimeZone
Indicates whether or not to Adjust For Daylight Savings.

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

setAdjustForDaylightSavings

public void setAdjustForDaylightSavings(boolean pVal)
                                 throws java.io.IOException,
                                        AutomationException
Description copied from interface: ITimeZone
Indicates whether or not to Adjust For Daylight Savings.

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

getTimeZoneXML

public java.lang.String getTimeZoneXML()
                                throws java.io.IOException,
                                       AutomationException
Description copied from interface: ITimeZone
The XML representation of a TimeZone.

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

setTimeZoneXML

public void setTimeZoneXML(java.lang.String pbstrXML)
                    throws java.io.IOException,
                           AutomationException
Description copied from interface: ITimeZone
The XML representation of a TimeZone.

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

isCanSelect

public boolean isCanSelect()
                    throws java.io.IOException,
                           AutomationException
Description copied from interface: ITableCapabilities
Indicates if the table supports selection.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
isCanSelect in interface ITableCapabilities
Returns:
The canSelect
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getServerName

public java.lang.String getServerName()
                               throws java.io.IOException,
                                      AutomationException
Description copied from interface: ITemporalFeatureClass2
Return Server Name.

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

getConnectionName

public java.lang.String getConnectionName()
                                   throws java.io.IOException,
                                          AutomationException
Description copied from interface: ITemporalFeatureClass2
Return Connection Name.

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

getExcludedTrackingEventIDs

public IStringArray getExcludedTrackingEventIDs()
                                         throws java.io.IOException,
                                                AutomationException
Description copied from interface: IExcludedEventIDs
String array of EventIDs to be permanently purged and ignored.

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

setExcludedTrackingEventIDs

public void setExcludedTrackingEventIDs(IStringArray pVal)
                                 throws java.io.IOException,
                                        AutomationException
Description copied from interface: IExcludedEventIDs
String array of EventIDs to be permanently purged and ignored.

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