|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.trackinganalyst.TemporalRecordSet
public class TemporalRecordSet
Defines the COM coclass for the TemporalRecordSet COM object.
This object defines the COM CoClass for the TemporalRecordset COM object. This object's primary purpose is to index or sort a feature class and provide the mechanism to allow cursors to be created from this object that provide feature data in temporal order from oldest to newest.
Constructor Summary | |
---|---|
TemporalRecordSet()
Constructs a TemporalRecordSet using ArcGIS Engine. |
|
TemporalRecordSet(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,
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. |
Object |
convertToSupportedObject(int docVersion)
Convert the object to another object that is supported. |
IDataset |
copy(String copyName,
IWorkspace copyWorkspace)
Copies this dataset to a new dataset with the specified name. |
IFeature |
createFeature()
Create a new feature, with a system assigned object ID and null property values. |
IFeatureBuffer |
createFeatureBuffer()
Create a feature buffer that can be used with an insert cursor. |
IRow |
createRow()
Creates a row in the database with a system assigned object ID and null property values. |
IRowBuffer |
createRowBuffer()
Creates a row buffer that can be used with an insert cursor. |
void |
delete()
Deletes this dataset. |
void |
deleteField(IField field)
Deletes a field from this object class. |
void |
deleteIndex(IIndex index)
Deletes an index from this object class. |
void |
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(Object o)
Compare this object with another |
int |
featureCount(IQueryFilter queryFilter)
The number of features selected by the specified query. |
int |
findField(String name)
The index of the field with the specified name. |
String |
getAliasName()
The alias name of the object class. |
IField |
getAreaField()
The geometry area field. |
String |
getBrowseName()
The browse name of the dataset. |
int |
getCachingMode()
The feature class caching mode. |
String |
getCategory()
The category of the dataset. |
void |
getClassID(GUID[] pClassID)
getClassID |
static 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. |
Object |
getDefaultValue(int subtypeCode,
String fieldName)
The default value for the associated attribute. |
IDomain |
getDomain(int subtypeCode,
String fieldName)
The domain given the subtype and field. |
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. |
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(Object fids,
boolean recycling)
Deprecated. This method uses C style arrays which are not supported in the ArcGIS API for Java. It is replaced by GeoDatabaseHelper#getFeatures(com.esri.arcgis.geodatabase.IFeatureClass, int[], boolean) . |
int |
getFeatureType()
The type of features in this feature class. |
IFields |
getFields()
The fields collection for this object class. |
String |
getFirstTrackId()
Retrives the first Track ID in the list. |
IName |
getFullName()
The associated name object. |
IGeodataXform |
getGeodataXform()
The geodata transformation of the GeoDataset. |
IIndexes |
getIndexes()
The indexes collection for this object class. |
ITime |
getLastUpdateTime(String trackId)
Returns the time that a given track was last updated. |
IField |
getLengthField()
The geometry length field. |
String |
getModelName()
The model name of the field. |
Object |
getMostCurrentFeature()
Returns success, but does nothing. |
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). |
String |
getNextTrackId()
Retrives the next Track ID in the list. |
int |
getObjectClassID()
The unique ID for the object class. |
String |
getOIDFieldName()
The name of the field corresponding to the OID. |
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(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(String fieldName)
The rules associated with the attribute. |
IEnumRule |
getRulesBySubtypeCode(int subtypeCode)
The rules associated with the subtype. |
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. |
String |
getStartTimeFieldName()
The feature start time field name. |
IEnumDataset |
getSubsets()
Datasets contained within this dataset. |
int |
getSubtypeFieldIndex()
The subtype field index. |
String |
getSubtypeFieldName()
The subtype field name. |
String |
getSubtypeName(int subtypeCode)
The subtype name. |
IEnumSubtype |
getSubtypes()
The subtypes associated with the class. |
String |
getTemporalColumnName()
Identifies the column containing time and date information. |
String |
getTimeFieldAmFormat()
Custom string representation of the AM symbol. |
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. |
String |
getTimeFieldPmFormat()
Custom string representation of the PM symbol. |
String |
getTimeSeriesColumnName()
Identifies column in the feature class containing temporal observations with time series. |
ISelectionSet |
getTrackFeatures(String trackId)
Returns a selection set of features in a given track. |
String |
getTrackIDFieldName()
The name of the field used to group features into tracks. |
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(Object cacheStartingTime,
Object cacheEndingTime,
ISelectionSet selSet,
IQueryFilter queryFilter,
int localeLanguageID,
String dateFormat,
String timeFormat,
String amDesignator,
String pmDesignator)
Re-builds the temporal index and caches features based on the supplied temporal parameters. |
void |
indexFeatureClass2(Object startingTime,
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(Object varStartingTime,
Object varEndingTime)
Searches for last known features in the dataset. |
IFeatureIDSet |
lastKnownOIDs(Object varStartingTime,
Object varEndingTime)
Searches for the last known OIDs in the dataset. |
void |
load(IStream pstm)
load |
void |
queryTemporalExtent(Object[] pvarStartTime,
Object[] pvarEndTime)
Queries temporal data within the full temporal extent of the dataset. |
void |
queryTrackTimeExtent(String trackId,
ITime[] startTime,
ITime[] endTime)
Returns the start and end times of a given track. |
void |
readExternal(ObjectInput in)
|
void |
rebuildIndex()
Re-build the temporal index and cache, according to the ITxFeatureClass properties. |
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(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(Object startDate,
Object endDate)
Allows user to select record set by its date value. |
void |
setBrowseName(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,
String fieldName,
Object value)
The default value for the associated attribute. |
void |
setDomainByRef(int subtypeCode,
String fieldName,
IDomain domain)
The domain given the subtype and field. |
void |
setEndTimeFieldName(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(String name)
The model name of the field. |
void |
setStartTimeFieldName(String name)
The feature start time field name. |
void |
setSubtypeFieldName(String fieldName)
The subtype field name. |
void |
setTemporalColumnName(String name)
Identifies the column containing time and date information. |
void |
setTimeFieldAmFormat(String amFormat)
Custom string representation of the AM symbol. |
void |
setTimeFieldFormat(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(String pmFormat)
Custom string representation of the PM symbol. |
void |
setTimeSeriesColumnName(String name)
Identifies column in the feature class containing temporal observations with time series. |
void |
setTrackIDFieldName(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(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 |
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef |
---|
getJintegraDispatch, release |
Constructor Detail |
---|
public TemporalRecordSet() throws IOException, UnknownHostException
IOException
- if there are interop problems
UnknownHostException
- if there are interop problemspublic TemporalRecordSet(Object obj) throws IOException
obj
to TemporalRecordSet
.
obj
- an object returned from ArcGIS Engine or Server
IOException
- if there are interop problems
TemporalRecordSet theTemporalRecordSet = (TemporalRecordSet) obj;
Method Detail |
---|
public static String getClsid()
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public String getTemporalColumnName() throws IOException, AutomationException
getTemporalColumnName
in interface ITemporalRecordSet
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTemporalColumnName(String name) throws IOException, AutomationException
setTemporalColumnName
in interface ITemporalRecordSet
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IFeatureClass getFeatureClass() throws IOException, AutomationException
getFeatureClass
in interface ITemporalRecordSet
getFeatureClass
in interface ITxFeatureClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setFeatureClassByRef(IFeatureClass featureClass) throws IOException, AutomationException
setFeatureClassByRef
in interface ITemporalRecordSet
setFeatureClassByRef
in interface ITxFeatureClass
featureClass
- A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void indexFeatureClass(Object cacheStartingTime, Object cacheEndingTime, ISelectionSet selSet, IQueryFilter queryFilter, int localeLanguageID, String dateFormat, String timeFormat, String amDesignator, String pmDesignator) throws IOException, AutomationException
indexFeatureClass
in interface ITemporalRecordSet
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)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getCount() throws IOException, AutomationException
getCount
in interface ITemporalRecordSet
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IFeatureCursor search(IQueryFilter queryFilter, boolean recycling, boolean forDrawing) throws IOException, AutomationException
search
in interface ITemporalRecordSet
queryFilter
- A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)recycling
- The recycling (in)forDrawing
- The forDrawing (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isCacheFeatures() throws IOException, AutomationException
isCacheFeatures
in interface ITemporalRecordSet
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setCacheFeatures(boolean cacheTheFeatures) throws IOException, AutomationException
setCacheFeatures
in interface ITemporalRecordSet
cacheTheFeatures
- The cacheTheFeatures (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getTimeSeriesColumnName() throws IOException, AutomationException
getTimeSeriesColumnName
in interface ITemporalRecordSet
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTimeSeriesColumnName(String name) throws IOException, AutomationException
setTimeSeriesColumnName
in interface ITemporalRecordSet
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getFeatureCacheWindow() throws IOException, AutomationException
getFeatureCacheWindow
in interface ITemporalRecordSet
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setFeatureCacheWindow(int percent) throws IOException, AutomationException
setFeatureCacheWindow
in interface ITemporalRecordSet
percent
- The percent (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Object getOldestFeature() throws IOException, AutomationException
getOldestFeature
in interface ITemporalRecordSet
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Object getMostCurrentFeature() throws IOException, AutomationException
getMostCurrentFeature
in interface ITemporalRecordSet
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ISelectionSet selectByDate(Object startDate, Object endDate) throws IOException, AutomationException
selectByDate
in interface ITemporalRecordSet
startDate
- A Variant (in)endDate
- A Variant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IFeatureIDSet lastKnownOIDs(Object varStartingTime, Object varEndingTime) throws IOException, AutomationException
lastKnownOIDs
in interface ITemporalSearch
varStartingTime
- A Variant (in)varEndingTime
- A Variant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ICursor lastKnownFeatures(Object varStartingTime, Object varEndingTime) throws IOException, AutomationException
lastKnownFeatures
in interface ITemporalSearch
varStartingTime
- A Variant (in)varEndingTime
- A Variant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void queryTemporalExtent(Object[] pvarStartTime, Object[] pvarEndTime) throws IOException, AutomationException
queryTemporalExtent
in interface ITemporalSearch
pvarStartTime
- A Variant (in/out: use single element array)pvarEndTime
- A Variant (in/out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void interfaceSupportsErrorInfo(GUID riid) throws IOException, AutomationException
Indicates whether the interface supports IErrorInfo.
interfaceSupportsErrorInfo
in interface ISupportErrorInfo
riid
- A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getCachingMode() throws IOException, AutomationException
getCachingMode
in interface ITxFeatureClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setCachingMode(int cachingMode) throws IOException, AutomationException
setCachingMode
in interface ITxFeatureClass
cachingMode
- A com.esri.arcgis.geodatabaseextensions.esriTxFeatureClassCachingMode constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getTrackIDFieldName() throws IOException, AutomationException
getTrackIDFieldName
in interface ITxFeatureClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTrackIDFieldName(String name) throws IOException, AutomationException
setTrackIDFieldName
in interface ITxFeatureClass
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getStartTimeFieldName() throws IOException, AutomationException
getStartTimeFieldName
in interface ITxFeatureClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setStartTimeFieldName(String name) throws IOException, AutomationException
setStartTimeFieldName
in interface ITxFeatureClass
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getEndTimeFieldName() throws IOException, AutomationException
getEndTimeFieldName
in interface ITxFeatureClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setEndTimeFieldName(String name) throws IOException, AutomationException
setEndTimeFieldName
in interface ITxFeatureClass
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getTimeFieldFormat() throws IOException, AutomationException
getTimeFieldFormat
in interface ITxFeatureClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTimeFieldFormat(String timeFieldFormat) throws IOException, AutomationException
setTimeFieldFormat
in interface ITxFeatureClass
timeFieldFormat
- The timeFieldFormat (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getTimeFieldAmFormat() throws IOException, AutomationException
getTimeFieldAmFormat
in interface ITxFeatureClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTimeFieldAmFormat(String amFormat) throws IOException, AutomationException
setTimeFieldAmFormat
in interface ITxFeatureClass
amFormat
- The amFormat (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getTimeFieldPmFormat() throws IOException, AutomationException
getTimeFieldPmFormat
in interface ITxFeatureClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTimeFieldPmFormat(String pmFormat) throws IOException, AutomationException
setTimeFieldPmFormat
in interface ITxFeatureClass
pmFormat
- The pmFormat (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getTimeFieldLocaleID() throws IOException, AutomationException
getTimeFieldLocaleID
in interface ITxFeatureClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTimeFieldLocaleID(int localeID) throws IOException, AutomationException
setTimeFieldLocaleID
in interface ITxFeatureClass
localeID
- The localeID (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void indexFeatureClass2(Object startingTime, Object endingTime, ISelectionSet selSet, IQueryFilter queryFilter) throws IOException, AutomationException
indexFeatureClass2
in interface ITxFeatureClass
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)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void rebuildIndex() throws IOException, AutomationException
rebuildIndex
in interface ITxFeatureClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getShapeType() throws IOException, AutomationException
ShapeType returns the basic type of geometry of a shape. For the purposes of using the ShapeType property in deciding how to render/symbolize a layer, only esriGeometryPolyline, esriGeometryPolygon, esriGeometryPoint, esriGeometryMulitpoint, and esriGeometryMultipatch need to be checked. All the other types will report as being one of these five types. The reason is that esriGeometryBezier3Curve or esriGeometryPath, etc. can be segments or parts of another shape.
getShapeType
in interface IFeatureClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IFeatureClass.getShapeType()
,
esriGeometryType
public int getFeatureType() throws IOException, AutomationException
This read-only property returns the feature type for the feature class as an esriFeatureType value. This property can be used to determine if a feature class is of a particular type, in order for the feature class to added to a network or topology, or possibly to skip over the feature class in an enumerator.
getFeatureType
in interface IFeatureClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.esriFeatureType
public String getShapeFieldName() throws IOException, AutomationException
This read-only property returns the name of the geometry field for the feature class.
getShapeFieldName
in interface IFeatureClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IPoint
,
IPolygon
,
IGeometry
,
ILine
public IField getAreaField() throws IOException, AutomationException
This read-only property returns the name of the field which records the area of each feature. Only feature classes that have a ShapeType of esriGeometryPolygon have an Area field.
A null pointer will be returned if:
getAreaField
in interface IFeatureClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IField
,
IFields
public IField getLengthField() throws IOException, AutomationException
This read-only property returns the name of the field which records the length of each feature. Only feature classes that have a ShapeType of esriGeometryPolygon or esriGeometryPolyLine have a Length field. For Line features, this field records the length of the polyline. For polygon features, this field records the perimeter of the polygon.
A null pointer will be returned if:
getLengthField
in interface IFeatureClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IField
,
IFields
public IFeatureDataset getFeatureDataset() throws IOException, AutomationException
This read-only property returns the IFeatureDataset interface on the feature dataset that this feature class is a memeber of. If the feature class is a stand alone feature class (it does not have a feature dataset), then this function will return a null pointer. A coverage feature class will return the IFeatureDataset interface to the coverage itself. Shapefiles will always return a null pointer.
getFeatureDataset
in interface IFeatureClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IFeature createFeature() throws IOException, AutomationException
CreateFeature will create a new feature for the feature class. The new feature is by default assigned a unique object ID (OID). All other fields are initialized to null values if they can be made null and to built-in default values appropriate to the type of the field if they cannot be made null. Use the IFeature::Store method to actually store this new feature in the database. When working with a versioned feature class, CreateFeature should only be called within an edit session. You can start an edit session by calling IWorkspaceEdit::StartEditing. All edits to features that participate in a Topology or Geometric Network must be performed within an edit session and bracketed within an edit operation.
After calling CreateFeature, the default subtype value is not automatically set nor are default values initialized. For features without a subtype that have defined default values, calling IRowSubtypes::InitDefaultValues will initialize the default values. Use IRowSubtypes::SubtypeCode to set the subtype value for features with subtypes before calling IRowSubtypes::InitDefaultValues to initialize the default values for the particular subtype.
Calling the CreateFeature method on a feature class (via the IFeatureClass interface on the feature class) has the same effect as calling the CreateRow method on the FeatureClass (via the ITable interface on the feature class) except that the IFeatureClass methods return IFeature interfaces on the returned row object.
If multiple features with common attributes are being sequentially created, the CreateFeatureBuffer method, IFeatureCursor.InsertFeature method and IFeatureBuffer interface should be used for better performance.
The basic process to create a new feature is:
1) Create the feature
2) Create the geometry for the feature
3) Store the geometry in the feature
4) Store the feature
createFeature
in interface IFeatureClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IFeature
,
IFeatureCursor
public IFeature getFeature(int iD) throws IOException, AutomationException
GetFeature will return a feature from the feature class with the parameter-specified Object ID (OID). This method is typically used to find a particular feature with a known Object ID. A cursor should be used to iterate through all features in a feature class.
Calling the GetFeature method on a feature class (via the IFeatureClass interface on the feature class) has the same effect as calling the GetRow method on the feature class (via the ITable interface) except that the return value is an IFeature reference, rather than IRow.
getFeature
in interface IFeatureClass
iD
- The iD (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IFeature
,
IFeatureCursor
public IFeatureCursor getFeatures(Object fids, boolean recycling) throws IOException, AutomationException
GeoDatabaseHelper#getFeatures(com.esri.arcgis.geodatabase.IFeatureClass, int[], boolean)
.
GetFeatures will return an IFeatureCursor which contains the features from the feature class with the parameter-specified Object IDs (OID). This method can be used to loop through a particular set of features with known Object IDs.
Calling the GetFeatures method from the IFeatureClass interface has the same effect as calling the GetRows method from the ITable interface except that the return value is an IFeatureCursor reference, rather than an ICursor reference.
The fids parameter should be provided with an integer array. If the array contains an invalid Object ID, no error will occur, and no feature will be retrieved for the value.
This method should not be called from .NET or Java applications. Instead, call IGeoDatabaseBridge.GetFeatures.
getFeatures
in interface IFeatureClass
fids
- A Variant (in)recycling
- The recycling (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IFeature
,
IFeatureCursor
public int getFeatureClassID() throws IOException, AutomationException
This read-only property will return the unique identifier for this feature class. All feature classes inside Geodatabases have a unique ID. Coverage and Shapefile feature classes do not, so IFeatureClass::FeatureClassID will always return -1 for Coverage and Shapefile feature classes. Since IFeatureClass inherits from IObjectClass, you can also get the feature class ID from IObjectClass:: ObjectClassID.
getFeatureClassID
in interface IFeatureClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IObjectClass
public IFeatureBuffer createFeatureBuffer() throws IOException, AutomationException
The CreateFeatureBuffer method creates a feature buffer and returns the IFeatureBuffer interface. This can be used to create new features in the feature class with an insert cursor. Like creating a feature with IFeatureClass::CreateFeature, the field values for the new feature must be initialized to some value before it can be stored in the database. All edits to features that participate in a Topology or Geometric Network must be performed within an edit session and bracketed within an edit operation.
Calling the CreateFeatureBuffer method in IFeatureClass has the same effect as calling the CreateRowBuffer interface in ITable except that the IFeatureClass methods return an IFeatureBuffer interface on the created row buffer.
createFeatureBuffer
in interface IFeatureClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IFeature
,
IFeatureCursor
public int featureCount(IQueryFilter queryFilter) throws IOException, AutomationException
FeatureCount returns the number of features that satisfy some attribute and/or spatial query as specified by an IQueryFilter object. If Nothing is supplied for the IQueryFilter, then FeatureCount returns the total number of features in the feature class.
featureCount
in interface IFeatureClass
queryFilter
- A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.In Java, rather than passing Nothing to get the total number of features, you should pass null.
public IFeatureCursor search(IQueryFilter filter, boolean recycling) throws IOException, AutomationException
Search will return an IFeatureCursor with all of the features that satisfy the attribute and/or spatial constraints as specified by an IQueryFilter reference. If a null value is passed to the filter parameter, the feature cursor will return all of the features from the feature class.
The recycling parameter controls row object allocation behavior. Recycling cursors rehydrate a single feature object on each fetch and can be used to optimize read-only access, for example, when drawing. It is illegal to maintain a reference on a feature object returned by a recycling cursor across multiple calls to NextFeature on the cursor. Features returned by a recycling cursor should not be modified. Non-recycling cursors return a separate feature object on each fetch. The features returned by a non-recycling cursor may be modified and stored with polymorphic behavior.
The Geodatabase guarantees "unique instance semantics" on non-recycling feature objects fetched during an edit session. In other words, if the feature retrieved by a search cursor has already been instantiated and is being referenced by the calling application, then a reference to the existing feature object is returned.
Non-recycling feature cursors returned from the Search method *MUST* be used when copying features from the cursor into an insert cursor of another class. This is because a recycling cursor reuses the same geometry and under some circumstances all of the features inserted into the insert cursor may have the same geometry. Using a non-recycling cursor ensures that each geometry is unique.
Existing rows can be edited with either a search cursor or an update cursor. When using a search cursor, NextRow is called, returning a reference to a row. The row is edited, and IRow.Store is called. When using an update cursor, NextRow is called, the row is edited, and ICursor.UpdateRow is called with the row as a parameter. It is important to remember, when using an update cursor, do not call the Store method.
|
ArcMap |
Engine - Simple |
Engine - Complex |
Inside edit sessions |
Search Cursor |
Search Cursor |
Search Cursor |
Outside edit sessions |
Search Cursor |
Update Cursor |
Search Cursor |
When using cursors within an edit session, they should always be scoped to edit operations. In other words, a cursor should be created after an edit operation has begun and should not be used once that edit operation has been stopped or aborted.
search
in interface IFeatureClass
filter
- A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)recycling
- The recycling (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IQueryFilter
public IFeatureCursor IFeatureClass_update(IQueryFilter filter, boolean recycling) throws IOException, AutomationException
IFeatureClass_update
in interface IFeatureClass
filter
- A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)recycling
- The recycling (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IFeatureCursor IFeatureClass_insert(boolean useBuffering) throws IOException, AutomationException
IFeatureClass_insert
in interface IFeatureClass
useBuffering
- The useBuffering (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ISelectionSet select(IQueryFilter queryFilter, int selType, int selOption, IWorkspace selectionContainer) throws IOException, AutomationException
Select will return an ISelectionSet with all of the features that satisfy some attribute and/or spatial query as specified by an IQueryFilter object. If Nothing is given as the IQueryFilter, then the selection will have all of the features from the feature class.
Calling the Select method in IFeatureClass has the same effect as calling the corresponding method in ITable.
The selType parameter determines the type of selection set that will be created: an ID set, a snapshot, or a hybrid. See the ISelectionSet interface for a comparison of the three types.
When calling Select the selectionContainer parameter is no longer required. A null value should be passed as this parameter.
select
in interface IFeatureClass
select
in interface ITable
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)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IQueryFilter
public int getObjectClassID() throws IOException, AutomationException
Returns the unique ID of the object class.
Each feature class or table registered with the geodatabase is an object class. Object classes have a unique ID which distinguishes them from other object classes in the geodatabase. The ObjectClassID property returns this ID as a long. The object class ID is assigned by the system when the class is created, or registered with the geodatabase, it cannot be modified.
Those feature classes and tables that are in the database, but not registered with the geodatabase will always have an object class ID of -1.
getObjectClassID
in interface IObjectClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnumRelationshipClass getRelationshipClasses(int role) throws IOException, AutomationException
getRelationshipClasses
in interface IObjectClass
role
- A com.esri.arcgis.geodatabase.esriRelRole constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getAliasName() throws IOException, AutomationException
Returns the alias name for the object class.
Object classes in a geodatabase can have between one and three names. The name of the object class, which is the same as the name of the table in the DBMS in which the objects in the object class are stored, the alias name which the user can set for display purposes in end user applications. The third name is the model name which is a tool for developers of custom objects to use to guarantee the names of objects independent of the true name or alias name.
The AliasName property returns the alias name for the object class. If the object class has no alias name, then AliasName will return the name of the object class (fully qualified if on ArcSDE). The alias name can be modified using the IClassSchemEdit interface.
getAliasName
in interface IObjectClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int findField(String name) throws IOException, AutomationException
If FindField returns -1, the Field could not be found in the Fields collection.
Developers working with SDE should be aware of qualified field names and their impact on calls to FindField. For more information, see the IFields2 interface.
findField
in interface IClass
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IFields getFields() throws IOException, AutomationException
getFields
in interface IClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IIndexes getIndexes() throws IOException, AutomationException
getIndexes
in interface IClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void addField(IField field) throws IOException, AutomationException
Prior to adding a new field to a class, an exclusive schema lock should be obtained using the ISchemaLock interface.
Attempting to add a new field that does not allow null values will fail, if the class already has data in it. The only solution is to recreate the class with the non-nullable field, then copy the rows from the original class into the new class.
addField
in interface IClass
field
- A reference to a com.esri.arcgis.geodatabase.IField (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void deleteField(IField field) throws IOException, AutomationException
DeleteField removes the specified field from a table, object class or feature class. Fields that are required by the Geodatabase and cannot be removed include:
Prior to deleting a field from a class, an exclusive schema lock should be obtained using the ISchemaLock interface.
// Assume we have a reference to a FeatureClass (pFC) IFields pFields; IField pField; pFields = pFC.getFields(); pField = pFields.getField(pFields.findField("MyField")); pFC.deleteField(pField);
deleteField
in interface IClass
field
- A reference to a com.esri.arcgis.geodatabase.IField (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void addIndex(IIndex index) throws IOException, AutomationException
Prior to adding a new index to a class, an exclusive schema lock should be obtained using the ISchemaLock interface.
addIndex
in interface IClass
index
- A reference to a com.esri.arcgis.geodatabase.IIndex (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void deleteIndex(IIndex index) throws IOException, AutomationException
Prior to deleting an index from a class, an exclusive schema lock should be obtained using the ISchemaLock interface.
deleteIndex
in interface IClass
index
- A reference to a com.esri.arcgis.geodatabase.IIndex (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isHasOID() throws IOException, AutomationException
isHasOID
in interface IClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getOIDFieldName() throws IOException, AutomationException
getOIDFieldName
in interface IClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IUID getCLSID() throws IOException, AutomationException
getCLSID
in interface IClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IUID getEXTCLSID() throws IOException, AutomationException
getEXTCLSID
in interface IClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Object getExtension() throws IOException, AutomationException
getExtension
in interface IClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IPropertySet getExtensionProperties() throws IOException, AutomationException
getExtensionProperties
in interface IClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getName() throws IOException, AutomationException
getName
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IName getFullName() throws IOException, AutomationException
getFullName
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getBrowseName() throws IOException, AutomationException
getBrowseName
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setBrowseName(String name) throws IOException, AutomationException
setBrowseName
in interface IDataset
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getType() throws IOException, AutomationException
// Assume we have a reference to an IfeatureClass (pFeatureClass) IDataset pDataset = null;
pDataset = new IDatasetProxy(pFeatureClass);
System.out.println(pDataset.getName() + " " + pDataset.getType());
if(pFeatureClass != null){
pDataset = pFeatureClass.getFeatureDataset();
System.out.println(pDataset.getName() + " " + pDataset.getType());
}
pDataset = new IDatasetProxy(pDataset.getWorkspace());
System.out.println(pDataset.getName() + " " +
pDataset.getType());
getType
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getCategory() throws IOException, AutomationException
IDataset::Category returns a description of the category of the dataset. The description returned from the Category property is the same value that is displayed in the Type column within the Contents tab in ArcCatalog. The value will contain a description of the dataset such as "Topology" prefixed with a description of the type of workspace containing the dataset such as "File Geodatabase".
The description returned from IDataset::Category may change between releases of ArcGIS. In addition to this, returned strings are localized, meaning that code relying on a specific string being provided may fail when deployed with a different version of ArcGIS than it was developed with, or when deployed to a client using a different language than it was developed with.
getCategory
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnumDataset getSubsets() throws IOException, AutomationException
The Subsets property returns other Dataset objects contained in this dataset.
IDataset::Subsets is not supported for Graph objects such as a Geometric Network. To return the feature classes contained in a Geometric Network, use the IFeatureClassContainer interface.
getSubsets
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IWorkspace getWorkspace() throws IOException, AutomationException
The Workspace property returns the containing workspace for this dataset.
getWorkspace
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IPropertySet getPropertySet() throws IOException, AutomationException
The PropertySet property is used to return any additional intrinsic properties (but not metadata properties) that may apply to the dataset. One use of this property is to distinguish between the types of File Geodatabase datafile formats. If called on a Feature Class or Table in a File Geodatabase the Datafile Format property can either be esriFGDBStandardDatafile or esriFGDBCompressedDatafile.
Most datasets do not implement this property and will either raise an error or return a null value if it's called. There are a handful of exceptions that will return property sets; these include the datasets from file geodatabases (as mentioned above) and coverages.
Examples of intrinsic properties for which explicit methods exist include the SpatialReference and the Extent methods available on the IGeoDataset interface. In most cases this PropertySet will be empty.
IDataset::PropertySet is not supported for Graph objects such as a Geometric Network.
getPropertySet
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean canCopy() throws IOException, AutomationException
The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods. For example, you may not delete a network feature class nor can you use the Copy method on a Geodatabase feature class. To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.
The CanCopy method is supported by:
canCopy
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IDataset copy(String copyName, IWorkspace copyWorkspace) throws IOException, AutomationException
IDataset::Copy should only be used with datasets from file-based data sources, such as shapefiles and coverages.
copy
in interface IDataset
copyName
- The copyName (in)copyWorkspace
- A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean canDelete() throws IOException, AutomationException
The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods. For example, you may not delete a network feature class nor can you use the Copy method on a Geodatabase feature class. To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.
canDelete
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void delete() throws IOException, AutomationException
Certain feature classes, such as network and topology feature classes, cannot be deleted until their containing objects are deleted.
delete
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean canRename() throws IOException, AutomationException
The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods. For example, you may not delete or rename a network feature class nor can you use the Copy method on a Geodatabase feature class. To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.
canRename
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void rename(String name) throws IOException, AutomationException
IDataset::Rename does not support the renaming of Graph objects such as a Geometric Network. In addition, certain feature classes, such as network feature classes, cannot be renamed.
rename
in interface IDataset
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ISpatialReference getSpatialReference() throws IOException, AutomationException
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.
getSpatialReference
in interface IGeoDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnvelope getExtent() throws IOException, AutomationException
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.
getExtent
in interface IGeoDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IGeodataXform getGeodataXform() throws IOException, AutomationException
getGeodataXform
in interface IGeoDataset2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ISpatialReference getNativeSpatialReference() throws IOException, AutomationException
getNativeSpatialReference
in interface IGeoDataset2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnvelope getNativeExtent() throws IOException, AutomationException
getNativeExtent
in interface IGeoDataset2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IRow createRow() throws IOException, AutomationException
The CreateRow method creates a new row in the underlying database with a system assigned object id value. A row object representing the created row is returned to the caller. The row object returned has the system assigned object ID as the value of the OIDField. All other fields are initialized to null values if they can be made null and to built-in default values appropriate to the type of the field if they cannot be made null.
The caller is responsible for setting the desired field values into the row and calling the Store method on the row. If the table represents an object class with subtypes, then it is the caller’s responsibility to set the default subtype code into the row and call the InitDefaultValues method on the row before storing, if that is the desired result. For tables without object behavior, insert cursors offer a more efficient way for inserting new rows.
createRow
in interface ITable
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IRow getRow(int oID) throws IOException, AutomationException
The GetRow method returns an existing row object, given its object ID value. The caller can query the returned row object for additional object specific interfaces. The retrieved row may be modified; calling Store on the row object after changing it will trigger messages to related objects and will mark the row for committing to the database.
getRow
in interface ITable
oID
- The oID (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ICursor getRows(Object oids, boolean recycling) throws IOException, AutomationException
The GetRows method returns a cursor that may be used to retrieve a set of rows specified by the input array of object id values. See the description of the Search method to understand the meaning of the recycling parameter. It is far more efficient to retrieve a set of rows using the GetRows method than it is to retrieve each individual row using the GetRow method. The retrieved rows may be modified; Store should be called on the row objects after changing them.
The oids parameter should be passed an integer array. For example:
// Get a recycling cursor for the OID array.
int[] oids = new int[] { 10844, 10853, 10871 };
ICursor cursor = table.getRows(oids, true);
getRows
in interface ITable
oids
- A Variant (in)recycling
- The recycling (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IRowBuffer createRowBuffer() throws IOException, AutomationException
The CreateRowBuffer method creates a new row buffer object in memory and returns it to the caller. No row is created in the database. The returned row buffer does not have an object ID value. The caller can set values into the row buffer and use it as an argument to the InsertRow method on an insert cursor; the latter is obtained by calling the Insert method on the Table.
createRowBuffer
in interface ITable
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void updateSearchedRows(IQueryFilter queryFilter, IRowBuffer buffer) throws IOException, AutomationException
This method will edit the rows matching the query filter's constraints. The values in each row will be replaced with the corresponding field's value in the provided row buffer. The fields being edited should be specified in the query filter's SubFields property. If the row buffer contains null values, and the SubFields property is not properly set, the row's values will be overwritten with the row buffer's null values.
updateSearchedRows
in interface ITable
queryFilter
- A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)buffer
- A reference to a com.esri.arcgis.geodatabase.IRowBuffer (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void deleteSearchedRows(IQueryFilter queryFilter) throws IOException, AutomationException
deleteSearchedRows
in interface ITable
queryFilter
- A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int rowCount(IQueryFilter queryFilter) throws IOException, AutomationException
rowCount
in interface ITable
queryFilter
- A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ICursor ITable_search(IQueryFilter queryFilter, boolean recycling) throws IOException, AutomationException
ITable_search
in interface ITable
queryFilter
- A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)recycling
- The recycling (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ICursor update(IQueryFilter queryFilter, boolean recycling) throws IOException, AutomationException
The Update method returns an update cursor that can be used to update or delete rows. It offers somewhat faster performance than multiple calls to Store or Delete on row objects fetched using a non-recycling search cursor for tables storing simple rows and simple features. There is no difference in performance for complex objects and features.
When using cursors within an edit session, they should always be scoped to edit operations. In other words, a cursor should be created after an edit operation has begun and should not be used once that edit operation has been stopped or aborted.
update
in interface ITable
queryFilter
- A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)recycling
- The recycling (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ICursor insert(boolean useBuffering) throws IOException, AutomationException
The Insert method returns an insert cursor that can be used to bulk insert rows. It offers significantly faster performance than multiple calls to CreateRow and Store for tables storing simple rows and simple features (that is, for tables whose CLSID is esriGeoDatabase.Row, esriGeoDatabase.Object, or esriGeoDatabase.Feature).
Insert cursors on tables containing complex objects use the CreateRow and Store methods to achieve polymorphism, and there is no difference in performance in these cases.
When using cursors within an edit session, they should always be scoped to edit operations. In other words, a cursor should be created after an edit operation has begun and should not be used once that edit operation has been stopped or aborted.
insert
in interface ITable
useBuffering
- The useBuffering (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isCanSelect() throws IOException, AutomationException
Use CanSelect to determine if you can open a selection set on the table. A situation where CanSelect will be False is a standalone database table without an OID column.
isCanSelect
in interface ITableCapabilities
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isBeingEdited() throws IOException, AutomationException
Once an edit session has been started on a workspace, the IsBeingEdited method on the IDatasetEdit interface can be used to determine if a particular dataset is participating in the edit session.
The reasons why a dataset may not participate include the connected user has no privileges or permission to edit the dataset, the connected user is not licensed to edit this type of dataset, or the dataset is not versioned but a versioned edit session has been started (or vice versa).
isBeingEdited
in interface IDatasetEdit
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isCanEdit() throws IOException, AutomationException
This property is to be used within an active edit session, results cannot be guaranteed if called on a dataset outside of an edit session.
isCanEdit
in interface IDatasetEditInfo
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isCanUndo() throws IOException, AutomationException
isCanUndo
in interface IDatasetEditInfo
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isCanRedo() throws IOException, AutomationException
isCanRedo
in interface IDatasetEditInfo
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isLoadOnlyMode() throws IOException, AutomationException
isLoadOnlyMode
in interface IFeatureClassLoad
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setLoadOnlyMode(boolean isInLoadMode) throws IOException, AutomationException
setLoadOnlyMode
in interface IFeatureClassLoad
isInLoadMode
- The isInLoadMode (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void updateExtent() throws IOException, AutomationException
The UpdateExtent method recalculates the XY, Z and M extent for a feature class, based on the features contained within it. This extent is returned by the IGeodataset.Extent property. As new features are added to a feature class in a geodatabase, or a shapefile feature class, the extent is automatically expanded to accomodate them, however, when features are deleted, the extent does not shrink to eliminate areas where there are no longer features. This method will shrink the extent of the feature class to eliminate these areas.
The extent is a property of the feature class' schema, therefore, it requires an exclusive schema lock to execute, and is not an undoable operation. In the case of personal, File and ArcSDE geodatabase feature classes, the M and Z extent are not stored with the class. In the case of shapefiles, the M and Z extents are stored with the feature class.
When calling this method against an ArcSDE feature class, the extent is calculated based on the features that exist for that feature class in all versions. The extent will not shrink unless this method is called after the database has been compressed.
This method is not supported on coverage feature classes. A coverage's extent is maintained automatically during the editing process.
Note: The extents discussed here is not the same as the spatial reference domain. The domains (XY, Z, M) define the valid range of coordinate values that can be stored in a feature class. The extents reflect the actual range of coordinate values that exist within the feature class. The extents cannot be larger than the domains.
updateExtent
in interface IFeatureClassManage
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void writeFeature(IFeature feature) throws IOException, AutomationException
All edits to features that participate in a Topology or Geometric Network must be performed within an edit session and bracketed within an edit operation.
writeFeature
in interface IFeatureClassWrite
feature
- A reference to a com.esri.arcgis.geodatabase.IFeature (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void writeFeatures(ISet features) throws IOException, AutomationException
All edits to features that participate in a Topology or Geometric Network must be performed within an edit session and bracketed within an edit operation.
writeFeatures
in interface IFeatureClassWrite
features
- A reference to a com.esri.arcgis.system.ISet (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void removeFeature(IFeature feature) throws IOException, AutomationException
All edits to features that participate in a Topology or Geometric Network must be performed within an edit session and bracketed within an edit operation.
removeFeature
in interface IFeatureClassWrite
feature
- A reference to a com.esri.arcgis.geodatabase.IFeature (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void removeFeatures(ISet features) throws IOException, AutomationException
All edits to features that participate in a Topology or Geometric Network must be performed within an edit session and bracketed within an edit operation.
removeFeatures
in interface IFeatureClassWrite
features
- A reference to a com.esri.arcgis.system.ISet (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getModelName() throws IOException, AutomationException
Returns the model name currently associated with the field or object class.
getModelName
in interface IModelInfo
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IObjectClass
,
IField
public void setModelName(String name) throws IOException, AutomationException
setModelName
in interface IModelInfo
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IObjectClass
,
IField
public boolean canBypassStoreMethod() throws IOException, AutomationException
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.
canBypassStoreMethod
in interface IObjectClassInfo
canBypassStoreMethod
in interface IObjectClassInfo2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean canBypassEditSession() throws IOException, AutomationException
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.
canBypassEditSession
in interface IObjectClassInfo2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isHasSubtype() throws IOException, AutomationException
HasSubtype property returns a boolean value whether the given object class has subypes or not.
This property returns a boolean value indicating if the object class has subtypes defined. If there are no subtypes defined, it returns FALSE , if there are subypes defined it returns TRUE.
isHasSubtype
in interface ISubtypes
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getDefaultSubtypeCode() throws IOException, AutomationException
DefaultSubtypeCode property sets and returns the default subtype code for the given object class.
This property sets or returns the value of the default subtype code for the associated class.
String aPath = "shape path"; String aName = "shape name"; IWorkspaceFactory shapefileFactory = new ShapefileWorkspaceFactory(); IFeatureWorkspace featureWorkspace = new IFeatureWorkspaceProxy(shapefileFactory.openFromFile(aPath,0)); IFeatureClass featureClass = new IFeatureClassProxy(featureWorkspace.openFeatureClass(aName)); ISubtypes pSubtypes = new ISubtypesProxy(featureClass); long lDefCode = pSubtypes.getDefaultSubtypeCode();
getDefaultSubtypeCode
in interface ISubtypes
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setDefaultSubtypeCode(int subtypeCode) throws IOException, AutomationException
DefaultSubtypeCode property sets the default subtype code for the given object class.
String aPath = "shape path"; String aName = "shape name"; IWorkspaceFactory shapefileFactory = new ShapefileWorkspaceFactory(); IFeatureWorkspace featureWorkspace = new IFeatureWorkspaceProxy(shapefileFactory.openFromFile(aPath,0)); IFeatureClass featureClass = new IFeatureClassProxy(featureWorkspace.openFeatureClass(aName)); ISubtypes pSubtypes = new ISubtypesProxy(featureClass); long lDefCode = pSubtypes.getDefaultSubtypeCode();
setDefaultSubtypeCode
in interface ISubtypes
subtypeCode
- The subtypeCode (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Object getDefaultValue(int subtypeCode, String fieldName) throws IOException, AutomationException
getDefaultValue
in interface ISubtypes
subtypeCode
- The subtypeCode (in)fieldName
- The fieldName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setDefaultValue(int subtypeCode, String fieldName, Object value) throws IOException, AutomationException
setDefaultValue
in interface ISubtypes
subtypeCode
- The subtypeCode (in)fieldName
- The fieldName (in)value
- A Variant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IDomain getDomain(int subtypeCode, String fieldName) throws IOException, AutomationException
getDomain
in interface ISubtypes
subtypeCode
- The subtypeCode (in)fieldName
- The fieldName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setDomainByRef(int subtypeCode, String fieldName, IDomain domain) throws IOException, AutomationException
setDomainByRef
in interface ISubtypes
subtypeCode
- The subtypeCode (in)fieldName
- The fieldName (in)domain
- A reference to a com.esri.arcgis.geodatabase.IDomain (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getSubtypeFieldName() throws IOException, AutomationException
The SubtypeFieldName property is used to either set or return string value for the field that contains the subtypes for this object class. To assign the subtype field, set SubtypeFieldName equal to the name of the field:
String aPath = "shape path"; String aName = "shape name"; IWorkspaceFactory shapefileFactory = new ShapefileWorkspaceFactory(); IFeatureWorkspace featureWorkspace = new IFeatureWorkspaceProxy(shapefileFactory.openFromFile(aPath,0)); IFeatureClass featureClass = new FeatureClassProxy(featureWorkspace.openFeatureClass(aName)); ISubtypes pSubtypes = new ISubtypesProxy(featureClass); pSubtypes.setSubtypeFieldName("TYPECODE"); //The Subtype field can be reset by assigning an empty string to SubtypeFieldName:; pSubtypes.setSubtypeFieldName("");
getSubtypeFieldName
in interface ISubtypes
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSubtypeFieldName(String fieldName) throws IOException, AutomationException
setSubtypeFieldName
in interface ISubtypes
fieldName
- The fieldName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getSubtypeFieldIndex() throws IOException, AutomationException
SubtypeFieldIndex property returns the index of the subtype field.
This property returns the index of the field in the object class which stores the subtype codes. The field index is returned as a Long.
String aPath = "shape path"; String aName = "shape name"; IWorkspaceFactory shapefileFactory = new ShapefileWorkspaceFactory(); IFeatureWorkspace featureWorkspace = new IFeatureWorkspaceProxy(shapefileFactory.openFromFile(aPath,0)); IFeatureClass featureClass = new IFeatureClassProxy(featureWorkspace.openFeatureClass(aName)); ISubtypes pSubtypes = new ISubtypesProxy(featureClass); int subFldIndex = pSubtypes.getSubtypeFieldIndex();
getSubtypeFieldIndex
in interface ISubtypes
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getSubtypeName(int subtypeCode) throws IOException, AutomationException
getSubtypeName
in interface ISubtypes
subtypeCode
- The subtypeCode (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnumSubtype getSubtypes() throws IOException, AutomationException
Subtypes returns a IEnumSubtype populated with all of the subtypes for the given object class.
Every ObjectClass has a default subtype code. If the user has not explicitly specified a default subtype or a subtype field, then DefaultSubtypeCode will return a subtype code of zero. Additionally, you can query the HasSubtype property; a value of False indicates an absence of a default subtype code, True indicates the presence of a default subtype code.
If the client instead asks for the enumeration of subtypes associated with an ObjectClass and no subtype has been previously added to the ObjectClass, then the enumerator will contain a single entry with a code of zero. The subtype field index value will be –1 if a default subtype has not been previously specified. Subtypes may only be short or long integers (esriFieldTypeSmallInteger or esriFieldTypeInteger). When setting the default subtype code, if one already exists, then it will be deleted. A subtype field must have been specified prior to setting the subtype code value.
Every type of field, except for esriFieldTypeShape, may have a default value. When setting the default value (which my be assigned on a subtype basis), it will be checked against the field’s associated Domain (if one exists) for validity.
This property returns all of the subtypes for the associated object class. Subtypes returns an IEnumSubtype enumeration which you can loop through to get all of the subtypes.
getSubtypes
in interface ISubtypes
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void addSubtype(int subtypeCode, String subtypeName) throws IOException, AutomationException
AddSubtype adds the subtype to the set of subtypes for the given object class with the subtype code and subtype name given.
AddSubtype will create a new subtype for the associated object class. This method requires a subtype code as a Long and a subtype name as a String. Before adding subtypes, use the ISubtypes::SubtypeFieldName property to set the subtypes field.
Once created, you can use the ISubtypes::DefaultValue property to set default values for this subtypes fields, and the ISubtypes::Domain property to assign domains to fields for the subtype.
addSubtype
in interface ISubtypes
subtypeCode
- The subtypeCode (in)subtypeName
- The subtypeName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void deleteSubtype(int subtypeCode) throws IOException, AutomationException
DeleteSubtype takes the subtype code parameter to remove the subtype from the set of subtypes of the given object class.
DeleteSubtype will delete a subtype for the associated object class. Calling DeleteSubtype will also remove any reference to that subtype in the geodatabase.
deleteSubtype
in interface ISubtypes
subtypeCode
- The subtypeCode (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnumRule getRules() throws IOException, AutomationException
getRules
in interface IValidation
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnumRule getRulesByField(String fieldName) throws IOException, AutomationException
getRulesByField
in interface IValidation
fieldName
- The fieldName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnumRule getRulesBySubtypeCode(int subtypeCode) throws IOException, AutomationException
getRulesBySubtypeCode
in interface IValidation
subtypeCode
- The subtypeCode (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void addRule(IRule rule) throws IOException, AutomationException
addRule
in interface IValidation
rule
- A reference to a com.esri.arcgis.geodatabase.IRule (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void deleteRule(IRule rule) throws IOException, AutomationException
deleteRule
in interface IValidation
rule
- A reference to a com.esri.arcgis.geodatabase.IRule (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ISelectionSet validate(IQueryFilter selection, IWorkspace workspace) throws IOException, AutomationException
Validate on a row occurs in five steps:
The validate process stops once a row is found invalid. For example, if a network feature violates an attribute rule, the validation process stops and the feature's network connectivity rules are not evaluated until the attribute rule violation is corrected.
validate
in interface IValidation
selection
- A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)workspace
- A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ISelectionSet validateSelection(ISelectionSet selection, IWorkspace workspace) throws IOException, AutomationException
validateSelection
in interface IValidation
selection
- A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)workspace
- A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ISet validateSet(ISet selection) throws IOException, AutomationException
validateSet
in interface IValidation
selection
- A reference to a com.esri.arcgis.system.ISet (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void alterRule(IRule rule) throws IOException, AutomationException
The AlterRule method is used to change the characteristics of an existing rule. This is currently implemented to change a subset of properties for connectivity rules only. These properties are:
To alter other properties of a connectivity rule, the rule must be deleted and recreated with the appropriate changes.
alterRule
in interface IValidation2
rule
- A reference to a com.esri.arcgis.geodatabase.IRule (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getClassID(GUID[] pClassID) throws IOException, AutomationException
IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.
getClassID
in interface IPersist
pClassID
- A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void isDirty() throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
isDirty
in interface IPersistStream
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void load(IStream pstm) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
load
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void save(IStream pstm, int fClearDirty) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
save
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)fClearDirty
- The fClearDirty (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getSizeMax(_ULARGE_INTEGER[] pcbSize) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
getSizeMax
in interface IPersistStream
pcbSize
- A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isSupportedAtVersion(int docVersion) throws IOException, AutomationException
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.
isSupportedAtVersion
in interface IDocumentVersionSupportGEN
docVersion
- A com.esri.arcgis.system.esriArcGISVersion constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Object convertToSupportedObject(int docVersion) throws IOException, AutomationException
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.
convertToSupportedObject
in interface IDocumentVersionSupportGEN
docVersion
- A com.esri.arcgis.system.esriArcGISVersion constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getFirstTrackId() throws IOException, AutomationException
getFirstTrackId
in interface ITxEnumTrackId
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getNextTrackId() throws IOException, AutomationException
getNextTrackId
in interface ITxEnumTrackId
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String[] getTrackIds() throws IOException, AutomationException
getTrackIds
in interface ITxEnumTrackId
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ISelectionSet getTrackFeatures(String trackId) throws IOException, AutomationException
getTrackFeatures
in interface ITxEnumTrackId
trackId
- The trackId (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ITime getLastUpdateTime(String trackId) throws IOException, AutomationException
getLastUpdateTime
in interface ITxEnumTrackId
trackId
- The trackId (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void queryTrackTimeExtent(String trackId, ITime[] startTime, ITime[] endTime) throws IOException, AutomationException
queryTrackTimeExtent
in interface ITxEnumTrackId
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)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void writeExternal(ObjectOutput out) throws IOException
writeExternal
in interface Externalizable
IOException
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
readExternal
in interface Externalizable
IOException
ClassNotFoundException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |