com.esri.arcgis.trackinganalyst
Class TemporalRecordSet

java.lang.Object
  com.esri.arcgis.trackinganalyst.TemporalRecordSet

All Implemented Interfaces:

ITemporalSearch, IClass, IDataset, IDatasetEdit, IDatasetEditInfo, IFeatureClass, IFeatureClassLoad, IFeatureClassManage, IFeatureClassWrite, IGeoDataset, IGeoDataset2, IModelInfo, IObjectClass, IObjectClassInfo, IObjectClassInfo2, ISubtypes, ITable, ITableCapabilities, IValidation, IValidation2, ITemporalRecordSet, ITxEnumTrackId, ITxFeatureClass, com.esri.arcgis.interop.RemoteObjRef, IDocumentVersionSupportGEN, IPersist, IPersistStream, ISupportErrorInfo, java.io.Externalizable, java.io.Serializable

public class TemporalRecordSet
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ITemporalRecordSet, ITemporalSearch, ISupportErrorInfo, ITxFeatureClass, IFeatureClass, IClass, IDataset, IGeoDataset, IGeoDataset2, IObjectClass, ITable, ITableCapabilities, IDatasetEdit, IDatasetEditInfo, IFeatureClassLoad, IFeatureClassManage, IFeatureClassWrite, IModelInfo, IObjectClassInfo, IObjectClassInfo2, ISubtypes, IValidation, IValidation2, IPersist, IPersistStream, IDocumentVersionSupportGEN, ITxEnumTrackId, java.io.Externalizable

COM Class 'TemporalRecordSet'. Generated 3/19/2015 1:20:45 PM from 'C:\ArcGIS\COM\esriTrackingAnalyst.olb'

Description 'Defines the COM coclass for the TemporalRecordSet COM object.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

Fields inherited from interface com.esri.arcgis.geodatabaseextensions.ITemporalRecordSet

IID, IID78c74302_17cf_11d5_b7cf_00010265adc5, xxDummy

Fields inherited from interface com.esri.arcgis.carto.ITemporalSearch

IID, IIDdf2b7788_6450_4c78_b43f_c80c3c2730cc, xxDummy

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabaseextensions.ITxFeatureClass

IID, IIDb7a65dde_9218_4e42_8c62_299ac695a66a, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IFeatureClass

IID, IIDd4803ee6_79f4_11d0_97fc_0080c7f79481, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IObjectClass

IID1afcdb31_ac09_11d2_8a1e_006097aff44e

Fields inherited from interface com.esri.arcgis.geodatabase.IClass

IID1afcdb32_ac09_11d2_8a1e_006097aff44e

Fields inherited from interface com.esri.arcgis.geodatabase.IDataset

IID, IID2d04c042_7766_11d0_b77d_00805f7ced21, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IGeoDataset2

IID, IID8fefccb6_9519_4700_9e01_3450106a11a4, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.ITable

IID, IIDfcb01cb5_9f0b_11d0_bec7_00805f7c4268, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.ITableCapabilities

IID, IID8b0338b9_3b3d_11d4_9fbb_00c04f6bdf0c, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IDatasetEdit

IID, IID448c5d21_9746_11d1_89e2_006097aff44e, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IDatasetEditInfo

IID, IID234c31c1_9740_11d1_89e2_006097aff44e, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IFeatureClassLoad

IID, IIDc3bff943_e069_11d1_aa82_00c04fa37585, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IFeatureClassManage

IID, IID0fb7a29c_11aa_406b_8096_26ac8ea27ba6, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IFeatureClassWrite

IID, IIDb3e3a101_c50c_11d1_8876_0000f877762d, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IModelInfo

IID, IID2d660904_1dbd_11d3_9f87_00c04f6bdd84, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.ISubtypes

IID, IIDaef78514_848f_11d2_aaba_00c04fa37b82, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IValidation2

IID, IID48469230_851c_11d4_a0c9_00c04f6bdd84, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IValidation

IIDd410a9ba_475a_11d2_9932_0000f80372b4

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Fields inherited from interface com.esri.arcgis.geodatabaseextensions.ITxEnumTrackId

IID, IID057b4c30_5c61_4b6c_a24d_b02f98be418f, xxDummy

Constructor Summary

TemporalRecordSet()
Constructs a TemporalRecordSet using ArcGIS Engine.

TemporalRecordSet(java.lang.Object obj)
Construct a TemporalRecordSet using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

void	addField(IField field) Adds a field to this object class.
void	addIndex(IIndex index) Adds an index to this object class.
void	addRule(IRule rule) Adds the rule to the set of associated rules.
void	addSubtype(int subtypeCode, java.lang.String subtypeName) Adds the subtype to the set of associated subtypes.
void	alterRule(IRule rule) Alter the existing validation rule.
boolean	canBypassEditSession() Indicates if updates to objects can be safely made outside of an edit session.
boolean	canBypassStoreMethod() Indicates if updates to objects can bypass the Store method and OnChange notifications for efficiency.
boolean	canCopy() True if this dataset can be copied.
boolean	canDelete() True if this dataset can be deleted.
boolean	canRename() True if this dataset can be renamed.
java.lang.Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
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	deleteRule(IRule rule) Deletes the rule from the set of associated rules.
void	deleteSearchedRows(IQueryFilter queryFilter) Delete the Rows in the database selected by the specified query.
void	deleteSubtype(int subtypeCode) Deletes the subtype from the set of associated subtypes.
boolean	equals(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.
java.lang.String	getBrowseName() The browse name of the dataset.
int	getCachingMode() The feature class caching mode.
java.lang.String	getCategory() The category of the dataset.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
IUID	getCLSID() The GUID for the COM Class (CoClass) corresponding to instances of this object class.
int	getCount() Number of features contained by the cursor.
int	getDefaultSubtypeCode() The default subtype associated with the class.
java.lang.Object	getDefaultValue(int subtypeCode, java.lang.String fieldName) The default value for the associated attribute.
IDomain	getDomain(int subtypeCode, java.lang.String fieldName) The domain given the subtype and field.
java.lang.String	getEndTimeFieldName() The feature end time field name.
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	getFeatureCacheWindow() Determines the number of features to cache if FeaturesCached property is true.
IFeatureClass	getFeatureClass() A reference to the feature class of which this record set is a member.
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.
java.lang.String	getFirstTrackId() Retrives the first Track ID in the list.
IName	getFullName() The associated name object.
IGeodataXform	getGeodataXform() The geodata transformation of the GeoDataset.
IIndexes	getIndexes() The indexes collection for this object class.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
ITime	getLastUpdateTime(java.lang.String trackId) Returns the time that a given track was last updated.
IField	getLengthField() The geometry length field.
java.lang.String	getModelName() The model name of the field.
java.lang.Object	getMostCurrentFeature() Returns success, but does nothing.
java.lang.String	getName() The name of the Dataset.
IEnvelope	getNativeExtent() The native extent of the GeoDataset (before transformation applied).
ISpatialReference	getNativeSpatialReference() The native spatial reference of the GeoDataset (before transformation applied).
java.lang.String	getNextTrackId() Retrives the next Track ID in the list.
int	getObjectClassID() The unique ID for the object class.
java.lang.String	getOIDFieldName() The name of the field corresponding to the OID.
java.lang.Object	getOldestFeature() Returns success, but does nothing.
IPropertySet	getPropertySet() The set of properties for the dataset.
IEnumRelationshipClass	getRelationshipClasses(int role) The relationship classes in which this object class participates in for the specified role.
IRow	getRow(int oID) The row from the database with the specified object ID.
ICursor	getRows(java.lang.Object oids, boolean recycling) The cursor of rows based on a set of object ids.
IEnumRule	getRules() The rules associated with the class.
IEnumRule	getRulesByField(java.lang.String fieldName) The rules associated with the attribute.
IEnumRule	getRulesBySubtypeCode(int subtypeCode) The rules associated with the subtype.
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.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
ISpatialReference	getSpatialReference() The spatial reference of the GeoDataset.
java.lang.String	getStartTimeFieldName() The feature start time field name.
IEnumDataset	getSubsets() Datasets contained within this dataset.
int	getSubtypeFieldIndex() The subtype field index.
java.lang.String	getSubtypeFieldName() The subtype field name.
java.lang.String	getSubtypeName(int subtypeCode) The subtype name.
IEnumSubtype	getSubtypes() The subtypes associated with the class.
java.lang.String	getTemporalColumnName() Identifies the column containing time and date information.
java.lang.String	getTimeFieldAmFormat() Custom string representation of the AM symbol.
java.lang.String	getTimeFieldFormat() The format used to parse time fields.
int	getTimeFieldLocaleID() Language identifier to be used when parsing time fields from a custom time string.
java.lang.String	getTimeFieldPmFormat() Custom string representation of the PM symbol.
java.lang.String	getTimeSeriesColumnName() Identifies column in the feature class containing temporal observations with time series.
ISelectionSet	getTrackFeatures(java.lang.String trackId) Returns a selection set of features in a given track.
java.lang.String	getTrackIDFieldName() The name of the field used to group features into tracks.
java.lang.String[]	getTrackIds() Retrives the Track ID list.
int	getType() The type of the Dataset.
IWorkspace	getWorkspace() The workspace containing this dataset.
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.
void	indexFeatureClass(java.lang.Object cacheStartingTime, java.lang.Object cacheEndingTime, ISelectionSet selSet, IQueryFilter queryFilter, int localeLanguageID, java.lang.String dateFormat, java.lang.String timeFormat, java.lang.String amDesignator, java.lang.String pmDesignator) Re-builds the temporal index and caches features based on the supplied temporal parameters.
void	indexFeatureClass2(java.lang.Object startingTime, java.lang.Object endingTime, ISelectionSet selSet, IQueryFilter queryFilter) Re-build the temporal index and cache, according to the ITxFeatureClass properties and given parameters.
ICursor	insert(boolean useBuffering) Returns a cursor that can be used to insert new Rows.
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isBeingEdited() True if the dataset is being edited.
boolean	isCacheFeatures() Controls whether features are cached in the renderer's feature memory or are read from the feature class.
boolean	isCanEdit() True if the dataset supports edit sessions with the ability to discard edits on save.
boolean	isCanRedo() True if the dataset supports edit sessions with the ability to redo undone operations.
boolean	isCanSelect() Indicates if the table supports selection.
boolean	isCanUndo() True if the dataset supports edit sessions with the ability to undo individual edit operations.
void	isDirty() isDirty
boolean	isHasOID() Indicates if the class has an object identity (OID) field.
boolean	isHasSubtype() Indicates if the table has subtypes.
boolean	isLoadOnlyMode() Indicates if the featureclass is in load only mode.
boolean	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
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	load(IStream pstm) load
void	queryTemporalExtent(java.lang.Object[] pvarStartTime, java.lang.Object[] pvarEndTime) Queries temporal data within the full temporal extent of the dataset.
void	queryTrackTimeExtent(java.lang.String trackId, ITime[] startTime, ITime[] endTime) Returns the start and end times of a given track.
void	readExternal(java.io.ObjectInput in)
void	rebuildIndex() Re-build the temporal index and cache, according to the ITxFeatureClass properties.
void	release() Release a TemporalRecordSet.
void	removeFeature(IFeature feature) Deletes a feature from the database, does not trigger OnDelete event.
void	removeFeatures(ISet features) Deletes a set of features from the database, does not trigger OnDelete events.
void	rename(java.lang.String name) Renames this Dataset.
int	rowCount(IQueryFilter queryFilter) The number of Rows selected by the specified query.
void	save(IStream pstm, int fClearDirty) save
IFeatureCursor	search(IQueryFilter filter, boolean recycling) Returns an object cursor that can be used to fetch feature objects selected by the specified query.
IFeatureCursor	search(IQueryFilter queryFilter, boolean recycling, boolean forDrawing) Performs a query on the record set for the given time range, returning a feature cursor.
ISelectionSet	select(IQueryFilter queryFilter, int selType, int selOption, IWorkspace selectionContainer) Returns a selection That contains the object ids selected by the specified query.
ISelectionSet	selectByDate(java.lang.Object startDate, java.lang.Object endDate) Allows user to select record set by its date value.
void	setBrowseName(java.lang.String name) The browse name of the dataset.
void	setCacheFeatures(boolean cacheTheFeatures) Controls whether features are cached in the renderer's feature memory or are read from the feature class.
void	setCachingMode(int cachingMode) The feature class caching mode.
void	setDefaultSubtypeCode(int subtypeCode) The default subtype associated with the class.
void	setDefaultValue(int subtypeCode, java.lang.String fieldName, java.lang.Object value) The default value for the associated attribute.
void	setDomainByRef(int subtypeCode, java.lang.String fieldName, IDomain domain) The domain given the subtype and field.
void	setEndTimeFieldName(java.lang.String name) The feature end time field name.
void	setFeatureCacheWindow(int percent) Determines the number of features to cache if FeaturesCached property is true.
void	setFeatureClassByRef(IFeatureClass featureClass) A reference to the feature class of which this record set is a member.
void	setLoadOnlyMode(boolean isInLoadMode) Indicates if the featureclass is in load only mode.
void	setModelName(java.lang.String name) The model name of the field.
void	setStartTimeFieldName(java.lang.String name) The feature start time field name.
void	setSubtypeFieldName(java.lang.String fieldName) The subtype field name.
void	setTemporalColumnName(java.lang.String name) Identifies the column containing time and date information.
void	setTimeFieldAmFormat(java.lang.String amFormat) Custom string representation of the AM symbol.
void	setTimeFieldFormat(java.lang.String timeFieldFormat) The format used to parse time fields.
void	setTimeFieldLocaleID(int localeID) Language identifier to be used when parsing time fields from a custom time string.
void	setTimeFieldPmFormat(java.lang.String pmFormat) Custom string representation of the PM symbol.
void	setTimeSeriesColumnName(java.lang.String name) Identifies column in the feature class containing temporal observations with time series.
void	setTrackIDFieldName(java.lang.String name) The name of the field used to group features into tracks.
ICursor	update(IQueryFilter queryFilter, boolean recycling) Returns a cursor that can be used to update Rows selected by the specified query.
void	updateExtent() Updates the XY, M, Z extent.
void	updateSearchedRows(IQueryFilter queryFilter, IRowBuffer buffer) Update the Rows in the database selected by the specified query.
ISelectionSet	validate(IQueryFilter selection, IWorkspace workspace) Validates the selection.
ISelectionSet	validateSelection(ISelectionSet selection, IWorkspace workspace) Validates the selection.
ISet	validateSet(ISet selection) Validates the set.
void	writeExternal(java.io.ObjectOutput out)
void	writeFeature(IFeature feature) Stores a feature to the database, does not trigger OnStore event.
void	writeFeatures(ISet features) Stores a set of features to the database, does not trigger OnStore events.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

TemporalRecordSet

public TemporalRecordSet()
                  throws java.io.IOException,
                         java.net.UnknownHostException

Constructs a TemporalRecordSet using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

TemporalRecordSet

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

Construct a TemporalRecordSet using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to TemporalRecordSet.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems TemporalRecordSet theTemporalRecordSet = (TemporalRecordSet) obj;

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a TemporalRecordSet.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getTemporalColumnName

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

Identifies the column containing time and date information.

Specified by:

getTemporalColumnName in interface ITemporalRecordSet

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTemporalColumnName

public void setTemporalColumnName(java.lang.String name)
                           throws java.io.IOException,
                                  AutomationException

Identifies the column containing time and date information.

Specified by:

setTemporalColumnName in interface ITemporalRecordSet

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFeatureClass

public IFeatureClass getFeatureClass()
                              throws java.io.IOException,
                                     AutomationException

A reference to the feature class of which this record set is a member.

Specified by:

getFeatureClass in interface ITemporalRecordSet

Specified by:

getFeatureClass in interface ITxFeatureClass

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFeatureClassByRef

public void setFeatureClassByRef(IFeatureClass featureClass)
                          throws java.io.IOException,
                                 AutomationException

A reference to the feature class of which this record set is a member.

Specified by:

setFeatureClassByRef in interface ITemporalRecordSet

Specified by:

setFeatureClassByRef in interface ITxFeatureClass

Parameters:

featureClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

indexFeatureClass

public void indexFeatureClass(java.lang.Object cacheStartingTime,
                              java.lang.Object cacheEndingTime,
                              ISelectionSet selSet,
                              IQueryFilter queryFilter,
                              int localeLanguageID,
                              java.lang.String dateFormat,
                              java.lang.String timeFormat,
                              java.lang.String amDesignator,
                              java.lang.String pmDesignator)
                       throws java.io.IOException,
                              AutomationException

Re-builds the temporal index and caches features based on the supplied temporal parameters.

Specified by:

indexFeatureClass in interface ITemporalRecordSet

Parameters:

cacheStartingTime - A Variant (in)

cacheEndingTime - A Variant (in)

selSet - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)

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

localeLanguageID - The localeLanguageID (in)

dateFormat - The dateFormat (in)

timeFormat - The timeFormat (in)

amDesignator - The amDesignator (in)

pmDesignator - The pmDesignator (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCount

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

Number of features contained by the cursor.

Specified by:

getCount in interface ITemporalRecordSet

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

search

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

Performs a query on the record set for the given time range, returning a feature cursor.

Specified by:

search in interface ITemporalRecordSet

Parameters:

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

recycling - The recycling (in)

forDrawing - The forDrawing (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.

isCacheFeatures

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

Controls whether features are cached in the renderer's feature memory or are read from the feature class.

Specified by:

isCacheFeatures in interface ITemporalRecordSet

Returns:

The cacheTheFeatures

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCacheFeatures

public void setCacheFeatures(boolean cacheTheFeatures)
                      throws java.io.IOException,
                             AutomationException

Controls whether features are cached in the renderer's feature memory or are read from the feature class.

Specified by:

setCacheFeatures in interface ITemporalRecordSet

Parameters:

cacheTheFeatures - The cacheTheFeatures (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeSeriesColumnName

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

Identifies column in the feature class containing temporal observations with time series.

Specified by:

getTimeSeriesColumnName in interface ITemporalRecordSet

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeSeriesColumnName

public void setTimeSeriesColumnName(java.lang.String name)
                             throws java.io.IOException,
                                    AutomationException

Identifies column in the feature class containing temporal observations with time series.

Specified by:

setTimeSeriesColumnName in interface ITemporalRecordSet

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFeatureCacheWindow

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

Determines the number of features to cache if FeaturesCached property is true.

Specified by:

getFeatureCacheWindow in interface ITemporalRecordSet

Returns:

The percent

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFeatureCacheWindow

public void setFeatureCacheWindow(int percent)
                           throws java.io.IOException,
                                  AutomationException

Determines the number of features to cache if FeaturesCached property is true.

Specified by:

setFeatureCacheWindow in interface ITemporalRecordSet

Parameters:

percent - The percent (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOldestFeature

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

Returns success, but does nothing.

Specified by:

getOldestFeature in interface ITemporalRecordSet

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMostCurrentFeature

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

Returns success, but does nothing.

Specified by:

getMostCurrentFeature in interface ITemporalRecordSet

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

selectByDate

public ISelectionSet selectByDate(java.lang.Object startDate,
                                  java.lang.Object endDate)
                           throws java.io.IOException,
                                  AutomationException

Allows user to select record set by its date value.

Specified by:

selectByDate in interface ITemporalRecordSet

Parameters:

startDate - A Variant (in)

endDate - A Variant (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.

lastKnownOIDs

public IFeatureIDSet lastKnownOIDs(java.lang.Object varStartingTime,
                                   java.lang.Object varEndingTime)
                            throws java.io.IOException,
                                   AutomationException

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:

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

AutomationException - If the ArcObject component throws an exception.

lastKnownFeatures

public ICursor lastKnownFeatures(java.lang.Object varStartingTime,
                                 java.lang.Object varEndingTime)
                          throws java.io.IOException,
                                 AutomationException

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:

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

Queries temporal data within the full temporal extent of the dataset.

Specified by:

queryTemporalExtent in interface ITemporalSearch

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.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCachingMode

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

The feature class caching mode.

Specified by:

getCachingMode in interface ITxFeatureClass

Returns:

A com.esri.arcgis.geodatabaseextensions.esriTxFeatureClassCachingMode constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCachingMode

public void setCachingMode(int cachingMode)
                    throws java.io.IOException,
                           AutomationException

The feature class caching mode.

Specified by:

setCachingMode in interface ITxFeatureClass

Parameters:

cachingMode - A com.esri.arcgis.geodatabaseextensions.esriTxFeatureClassCachingMode constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTrackIDFieldName

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

The name of the field used to group features into tracks.

Specified by:

getTrackIDFieldName in interface ITxFeatureClass

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTrackIDFieldName

public void setTrackIDFieldName(java.lang.String name)
                         throws java.io.IOException,
                                AutomationException

The name of the field used to group features into tracks.

Specified by:

setTrackIDFieldName in interface ITxFeatureClass

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStartTimeFieldName

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

The feature start time field name.

Specified by:

getStartTimeFieldName in interface ITxFeatureClass

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStartTimeFieldName

public void setStartTimeFieldName(java.lang.String name)
                           throws java.io.IOException,
                                  AutomationException

The feature start time field name.

Specified by:

setStartTimeFieldName in interface ITxFeatureClass

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEndTimeFieldName

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

The feature end time field name.

Specified by:

getEndTimeFieldName in interface ITxFeatureClass

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setEndTimeFieldName

public void setEndTimeFieldName(java.lang.String name)
                         throws java.io.IOException,
                                AutomationException

The feature end time field name.

Specified by:

setEndTimeFieldName in interface ITxFeatureClass

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeFieldFormat

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

The format used to parse time fields.

Specified by:

getTimeFieldFormat in interface ITxFeatureClass

Returns:

The timeFieldFormat

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeFieldFormat

public void setTimeFieldFormat(java.lang.String timeFieldFormat)
                        throws java.io.IOException,
                               AutomationException

The format used to parse time fields.

Specified by:

setTimeFieldFormat in interface ITxFeatureClass

Parameters:

timeFieldFormat - The timeFieldFormat (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeFieldAmFormat

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

Custom string representation of the AM symbol.

Specified by:

getTimeFieldAmFormat in interface ITxFeatureClass

Returns:

The amFormat

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeFieldAmFormat

public void setTimeFieldAmFormat(java.lang.String amFormat)
                          throws java.io.IOException,
                                 AutomationException

Custom string representation of the AM symbol.

Specified by:

setTimeFieldAmFormat in interface ITxFeatureClass

Parameters:

amFormat - The amFormat (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeFieldPmFormat

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

Custom string representation of the PM symbol.

Specified by:

getTimeFieldPmFormat in interface ITxFeatureClass

Returns:

The pmFormat

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeFieldPmFormat

public void setTimeFieldPmFormat(java.lang.String pmFormat)
                          throws java.io.IOException,
                                 AutomationException

Custom string representation of the PM symbol.

Specified by:

setTimeFieldPmFormat in interface ITxFeatureClass

Parameters:

pmFormat - The pmFormat (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeFieldLocaleID

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

Language identifier to be used when parsing time fields from a custom time string.

Specified by:

getTimeFieldLocaleID in interface ITxFeatureClass

Returns:

The localeID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeFieldLocaleID

public void setTimeFieldLocaleID(int localeID)
                          throws java.io.IOException,
                                 AutomationException

Language identifier to be used when parsing time fields from a custom time string.

Specified by:

setTimeFieldLocaleID in interface ITxFeatureClass

Parameters:

localeID - The localeID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

indexFeatureClass2

public void indexFeatureClass2(java.lang.Object startingTime,
                               java.lang.Object endingTime,
                               ISelectionSet selSet,
                               IQueryFilter queryFilter)
                        throws java.io.IOException,
                               AutomationException

Re-build the temporal index and cache, according to the ITxFeatureClass properties and given parameters.

Specified by:

indexFeatureClass2 in interface ITxFeatureClass

Parameters:

startingTime - A Variant (in)

endingTime - A Variant (in)

selSet - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)

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.

rebuildIndex

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

Re-build the temporal index and cache, according to the ITxFeatureClass properties.

Specified by:

rebuildIndex in interface ITxFeatureClass

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getShapeType

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

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

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

The type of features in this feature class.

Specified by:

getFeatureType in interface IFeatureClass

Returns:

A com.esri.arcgis.geodatabase.esriFeatureType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getShapeFieldName

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

The name of the default sShape field.

Specified by:

getShapeFieldName in interface IFeatureClass

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAreaField

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

The geometry area field.

Specified by:

getAreaField in interface IFeatureClass

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLengthField

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

The geometry length field.

Specified by:

getLengthField in interface IFeatureClass

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFeatureDataset

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

The feature dataset that contains the feature class.

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.

createFeature

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

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

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.

getFeature

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

Get the feature with the specified object ID.

Specified by:

getFeature in interface IFeatureClass

Parameters:

iD - The iD (in)

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.

getFeatures

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

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

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.

getFeatureClassID

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

The unique ID for the Feature Class.

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.

createFeatureBuffer

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

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

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.

featureCount

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

The number of features selected by the specified query.

Specified by:

featureCount in interface IFeatureClass

Parameters:

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

Returns:

The numFeatures

Throws:

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

AutomationException - If the ArcObject component throws an exception.

search

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

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

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:

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

AutomationException - If the ArcObject component throws an exception.

IFeatureClass_update

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

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:

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

AutomationException - If the ArcObject component throws an exception.

IFeatureClass_insert

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

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.

select

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

Returns a selection That contains the object ids selected by the specified query.

Specified by:

select in interface IFeatureClass

Specified by:

select in interface ITable

Parameters:

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

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

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

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getObjectClassID

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

The unique ID for the object class.

Specified by:

getObjectClassID in interface IObjectClass

Returns:

The objectClassID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRelationshipClasses

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

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

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.

getAliasName

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

The alias name of the object class.

Specified by:

getAliasName in interface IObjectClass

Returns:

The name

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

The index of the field with the specified name.

Specified by:

findField in interface IClass

Parameters:

name - The name (in)

Returns:

The fieldIndex

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFields

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

The fields collection for this object class.

Specified by:

getFields in interface IClass

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getIndexes

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

The indexes collection for this object class.

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

Adds a field to this object class.

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

Deletes a field from this object class.

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

Adds an index to this object class.

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

Deletes an index from this object class.

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

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

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

The name of the field corresponding to the OID.

Specified by:

getOIDFieldName in interface IClass

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCLSID

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

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

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

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

Specified by:

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

getExtension

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

The extension for this object class.

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

The extension properties for this object class.

Specified by:

getExtensionProperties in interface IClass

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

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

The name of the Dataset.

Specified by:

getName in interface IDataset

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFullName

public IName getFullName()
                  throws java.io.IOException,
                         AutomationException

The associated name object.

Specified by:

getFullName in interface IDataset

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBrowseName

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

The browse name of the dataset.

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

The browse name of the dataset.

Specified by:

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

getType

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

The type of the Dataset.

Specified by:

getType in interface IDataset

Returns:

A com.esri.arcgis.geodatabase.esriDatasetType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCategory

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

The category of the dataset.

Specified by:

getCategory in interface IDataset

Returns:

The category

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSubsets

public IEnumDataset getSubsets()
                        throws java.io.IOException,
                               AutomationException

Datasets contained within this dataset.

Specified by:

getSubsets in interface IDataset

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWorkspace

public IWorkspace getWorkspace()
                        throws java.io.IOException,
                               AutomationException

The workspace containing 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

The set of properties for the dataset.

Specified by:

getPropertySet in interface IDataset

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canCopy

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

True if this dataset can be copied.

Specified by:

canCopy in interface IDataset

Returns:

The canCopy

Throws:

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

AutomationException - If the ArcObject component throws an exception.

copy

public IDataset copy(java.lang.String copyName,
                     IWorkspace copyWorkspace)
              throws java.io.IOException,
                     AutomationException

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

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:

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

AutomationException - If the ArcObject component throws an exception.

canDelete

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

True if this dataset can be deleted.

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

Deletes this dataset.

Specified by:

delete in interface IDataset

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canRename

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

True if this dataset can be renamed.

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

Renames this Dataset.

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.

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws java.io.IOException,
                                             AutomationException

The spatial reference of the GeoDataset.

Remarks

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

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSpatialReference in interface IGeoDataset

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

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

The extent of the GeoDataset.

Remarks

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

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

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.

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.

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getExtent in interface IGeoDataset

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGeodataXform

public IGeodataXform getGeodataXform()
                              throws java.io.IOException,
                                     AutomationException

The geodata transformation of the GeoDataset.

Specified by:

getGeodataXform in interface IGeoDataset2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNativeSpatialReference

public ISpatialReference getNativeSpatialReference()
                                            throws java.io.IOException,
                                                   AutomationException

The native spatial reference of the GeoDataset (before transformation applied).

Specified by:

getNativeSpatialReference in interface IGeoDataset2

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.

getNativeExtent

public IEnvelope getNativeExtent()
                          throws java.io.IOException,
                                 AutomationException

The native extent of the GeoDataset (before transformation applied).

Specified by:

getNativeExtent in interface IGeoDataset2

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

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

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

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

The row from the database with the specified object ID.

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

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

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:

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

AutomationException - If the ArcObject component throws an exception.

createRowBuffer

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

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

Specified by:

createRowBuffer in interface ITable

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

updateSearchedRows

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

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

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:

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

AutomationException - If the ArcObject component throws an exception.

deleteSearchedRows

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

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

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

The number of Rows selected by the specified query.

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

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

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

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

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

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.

isCanSelect

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

Indicates if the table supports selection.

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.

isBeingEdited

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

True if the dataset is being edited.

Specified by:

isBeingEdited in interface IDatasetEdit

Returns:

The isBeingEdited

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCanEdit

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

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

Specified by:

isCanEdit in interface IDatasetEditInfo

Returns:

The canEdit

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCanUndo

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

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

Specified by:

isCanUndo in interface IDatasetEditInfo

Returns:

The canUndo

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCanRedo

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

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

Specified by:

isCanRedo in interface IDatasetEditInfo

Returns:

The canUndo

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isLoadOnlyMode

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

Indicates if the featureclass is in load only mode.

Specified by:

isLoadOnlyMode in interface IFeatureClassLoad

Returns:

The isInLoadMode

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLoadOnlyMode

public void setLoadOnlyMode(boolean isInLoadMode)
                     throws java.io.IOException,
                            AutomationException

Indicates if the featureclass is in load only mode.

Specified by:

setLoadOnlyMode in interface IFeatureClassLoad

Parameters:

isInLoadMode - The isInLoadMode (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

updateExtent

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

Updates the XY, M, Z extent.

Specified by:

updateExtent in interface IFeatureClassManage

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeFeature

public void writeFeature(IFeature feature)
                  throws java.io.IOException,
                         AutomationException

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

Specified by:

writeFeature in interface IFeatureClassWrite

Parameters:

feature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeFeatures

public void writeFeatures(ISet features)
                   throws java.io.IOException,
                          AutomationException

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

Specified by:

writeFeatures in interface IFeatureClassWrite

Parameters:

features - A reference to a com.esri.arcgis.system.ISet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeFeature

public void removeFeature(IFeature feature)
                   throws java.io.IOException,
                          AutomationException

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

Specified by:

removeFeature in interface IFeatureClassWrite

Parameters:

feature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeFeatures

public void removeFeatures(ISet features)
                    throws java.io.IOException,
                           AutomationException

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

Specified by:

removeFeatures in interface IFeatureClassWrite

Parameters:

features - A reference to a com.esri.arcgis.system.ISet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getModelName

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

The model name of the field.

Specified by:

getModelName in interface IModelInfo

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setModelName

public void setModelName(java.lang.String name)
                  throws java.io.IOException,
                         AutomationException

The model name of the field.

Specified by:

setModelName in interface IModelInfo

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canBypassStoreMethod

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

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

Remarks

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

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

canBypassStoreMethod in interface IObjectClassInfo

Specified by:

canBypassStoreMethod in interface IObjectClassInfo2

Returns:

The canBypassStore

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canBypassEditSession

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

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

Remarks

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

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

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

canBypassEditSession in interface IObjectClassInfo2

Returns:

The canBypassEditSession

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHasSubtype

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

Indicates if the table has subtypes.

Specified by:

isHasSubtype in interface ISubtypes

Returns:

The hasSubtype

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultSubtypeCode

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

The default subtype associated with the class.

Specified by:

getDefaultSubtypeCode in interface ISubtypes

Returns:

The subtypeCode

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefaultSubtypeCode

public void setDefaultSubtypeCode(int subtypeCode)
                           throws java.io.IOException,
                                  AutomationException

The default subtype associated with the class.

Specified by:

setDefaultSubtypeCode in interface ISubtypes

Parameters:

subtypeCode - The subtypeCode (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultValue

public java.lang.Object getDefaultValue(int subtypeCode,
                                        java.lang.String fieldName)
                                 throws java.io.IOException,
                                        AutomationException

The default value for the associated attribute.

Specified by:

getDefaultValue in interface ISubtypes

Parameters:

subtypeCode - The subtypeCode (in)

fieldName - The fieldName (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefaultValue

public void setDefaultValue(int subtypeCode,
                            java.lang.String fieldName,
                            java.lang.Object value)
                     throws java.io.IOException,
                            AutomationException

The default value for the associated attribute.

Specified by:

setDefaultValue in interface ISubtypes

Parameters:

subtypeCode - The subtypeCode (in)

fieldName - The fieldName (in)

value - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDomain

public IDomain getDomain(int subtypeCode,
                         java.lang.String fieldName)
                  throws java.io.IOException,
                         AutomationException

The domain given the subtype and field.

Specified by:

getDomain in interface ISubtypes

Parameters:

subtypeCode - The subtypeCode (in)

fieldName - The fieldName (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDomainByRef

public void setDomainByRef(int subtypeCode,
                           java.lang.String fieldName,
                           IDomain domain)
                    throws java.io.IOException,
                           AutomationException

The domain given the subtype and field.

Specified by:

setDomainByRef in interface ISubtypes

Parameters:

subtypeCode - The subtypeCode (in)

fieldName - The fieldName (in)

domain - A reference to a com.esri.arcgis.geodatabase.IDomain (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSubtypeFieldName

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

The subtype field name.

Specified by:

getSubtypeFieldName in interface ISubtypes

Returns:

The fieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSubtypeFieldName

public void setSubtypeFieldName(java.lang.String fieldName)
                         throws java.io.IOException,
                                AutomationException

The subtype field name.

Specified by:

setSubtypeFieldName in interface ISubtypes

Parameters:

fieldName - The fieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSubtypeFieldIndex

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

The subtype field index.

Specified by:

getSubtypeFieldIndex in interface ISubtypes

Returns:

The index

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSubtypeName

public java.lang.String getSubtypeName(int subtypeCode)
                                throws java.io.IOException,
                                       AutomationException

The subtype name.

Specified by:

getSubtypeName in interface ISubtypes

Parameters:

subtypeCode - The subtypeCode (in)

Returns:

The subtypeName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSubtypes

public IEnumSubtype getSubtypes()
                         throws java.io.IOException,
                                AutomationException

The subtypes associated with the class.

Specified by:

getSubtypes in interface ISubtypes

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addSubtype

public void addSubtype(int subtypeCode,
                       java.lang.String subtypeName)
                throws java.io.IOException,
                       AutomationException

Adds the subtype to the set of associated subtypes.

Specified by:

addSubtype in interface ISubtypes

Parameters:

subtypeCode - The subtypeCode (in)

subtypeName - The subtypeName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteSubtype

public void deleteSubtype(int subtypeCode)
                   throws java.io.IOException,
                          AutomationException

Deletes the subtype from the set of associated subtypes.

Specified by:

deleteSubtype in interface ISubtypes

Parameters:

subtypeCode - The subtypeCode (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRules

public IEnumRule getRules()
                   throws java.io.IOException,
                          AutomationException

The rules associated with the class.

Specified by:

getRules in interface IValidation

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRulesByField

public IEnumRule getRulesByField(java.lang.String fieldName)
                          throws java.io.IOException,
                                 AutomationException

The rules associated with the attribute.

Specified by:

getRulesByField in interface IValidation

Parameters:

fieldName - The fieldName (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRulesBySubtypeCode

public IEnumRule getRulesBySubtypeCode(int subtypeCode)
                                throws java.io.IOException,
                                       AutomationException

The rules associated with the subtype.

Specified by:

getRulesBySubtypeCode in interface IValidation

Parameters:

subtypeCode - The subtypeCode (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addRule

public void addRule(IRule rule)
             throws java.io.IOException,
                    AutomationException

Adds the rule to the set of associated rules.

Specified by:

addRule in interface IValidation

Parameters:

rule - A reference to a com.esri.arcgis.geodatabase.IRule (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteRule

public void deleteRule(IRule rule)
                throws java.io.IOException,
                       AutomationException

Deletes the rule from the set of associated rules.

Specified by:

deleteRule in interface IValidation

Parameters:

rule - A reference to a com.esri.arcgis.geodatabase.IRule (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

validate

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

Validates the selection.

Specified by:

validate in interface IValidation

Parameters:

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

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

validateSelection

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

Validates the selection.

Specified by:

validateSelection in interface IValidation

Parameters:

selection - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

validateSet

public ISet validateSet(ISet selection)
                 throws java.io.IOException,
                        AutomationException

Validates the set.

Specified by:

validateSet in interface IValidation

Parameters:

selection - A reference to a com.esri.arcgis.system.ISet (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

alterRule

public void alterRule(IRule rule)
               throws java.io.IOException,
                      AutomationException

Alter the existing validation rule.

Specified by:

alterRule in interface IValidation2

Parameters:

rule - A reference to a com.esri.arcgis.geodatabase.IRule (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

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

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

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

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

save

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws java.io.IOException,
                                    AutomationException

Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

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

Specified by:

isSupportedAtVersion in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

The supported

Throws:

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

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public java.lang.Object convertToSupportedObject(int docVersion)
                                          throws java.io.IOException,
                                                 AutomationException

Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

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

Specified by:

convertToSupportedObject in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFirstTrackId

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

Retrives the first Track ID in the list.

Specified by:

getFirstTrackId in interface ITxEnumTrackId

Returns:

The trackId

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNextTrackId

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

Retrives the next Track ID in the list.

Specified by:

getNextTrackId in interface ITxEnumTrackId

Returns:

The trackId

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTrackIds

public java.lang.String[] getTrackIds()
                               throws java.io.IOException,
                                      AutomationException

Retrives the Track ID list.

Specified by:

getTrackIds in interface ITxEnumTrackId

Returns:

The trackIds

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTrackFeatures

public ISelectionSet getTrackFeatures(java.lang.String trackId)
                               throws java.io.IOException,
                                      AutomationException

Returns a selection set of features in a given track.

Specified by:

getTrackFeatures in interface ITxEnumTrackId

Parameters:

trackId - The trackId (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.

getLastUpdateTime

public ITime getLastUpdateTime(java.lang.String trackId)
                        throws java.io.IOException,
                               AutomationException

Returns the time that a given track was last updated.

Specified by:

getLastUpdateTime in interface ITxEnumTrackId

Parameters:

trackId - The trackId (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryTrackTimeExtent

public void queryTrackTimeExtent(java.lang.String trackId,
                                 ITime[] startTime,
                                 ITime[] endTime)
                          throws java.io.IOException,
                                 AutomationException

Returns the start and end times of a given track.

Specified by:

queryTrackTimeExtent in interface ITxEnumTrackId

Parameters:

trackId - The trackId (in)

startTime - A reference to a com.esri.arcgis.system.ITime (out: use single element array)

endTime - A reference to a com.esri.arcgis.system.ITime (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException