com.esri.arcgis.geodatabase.ObjectClass
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
public class ObjectClass
Esri Object Class object.
An object class is a table whose rows represent entities, modeled as objects with properties and behavior. The row objects handed out by an object class support the IRow and the IObject interfaces.
An object class may participate in any number of relationship classes that relate its instances to objects (entities) in other object classes.
An object class may contain a discriminating field, referred to as the subtype field that may be used to partition its instances into a number of subtypes. All subtypes share the same field definition and are stored in the same table, however individual subtypes may differ in the default values and domains assigned to fields. The subtyping mechanism can also be used in defining attribute and connectivity rules that apply to the instances of the object class. The subtyping mechanism is a lightweight alternative to creating multiple subclasses each represented by its own object class.
An object class has a non-negative object class ID which is unique within the geodatabase. This ID is assigned to the object class at the time that it is created or at the time that an existing table in the RDBMS is registered with the geodatabase as an object class. The Name of the object class is the same as the name of the table in the DBMS in which the objects in the object class are stored and follows the same fully qualified naming conventions.
An object class may have an AliasName property that is stored as part of its definition by the geodatabase. The AliasName may be retrieved and used for display purposes by applications.
An object class may have a ModelName property that is stored as part of its definition by the geodatabase. The model name is not exposed to end users and if defined, can be used as a search key to find an object class by a standard model name that is adhered to across databases. A model name must be unique across the workspace.
IRelQueryTableManage,
RelQueryTable,
Table,
IClass,
RelQueryRow,
IRelQueryTableName,
RelQueryCursor,
IRelQueryTable,
IObjectClass,
IRelQueryTableInfo,
RelQueryTableFactory,
com.esri.arcgis.arcmapUI.ISpatialJoin#setJoinTableByRef(com.esri.arcgis.geodatabase.ITable),
ITable,
ObjectClass,
com.esri.arcgis.geoDatabaseUI.ICalculator,
com.esri.arcgis.arcmapUI.ISpatialJoin#setSourceTableByRef(com.esri.arcgis.geodatabase.ITable),
IRelQueryTableFactory,
RelQueryTableName,
Serialized Form| Constructor Summary | |
|---|---|
ObjectClass(Object obj)
Construct a ObjectClass 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 |
addGlobalID(String fieldName)
Adds a global ID column to a class and populates it with GUIDs. |
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 |
alterAliasName(String name)
The alias name of the object class. |
void |
alterClassExtensionCLSID(IUID classExtensionCLSID,
IPropertySet classExtensionProperties)
Changes the class extension COM class associated with this database class. |
void |
alterClassExtensionProperties(IPropertySet classExtensionProperties)
Changes the class extension properties associated with this object class. |
void |
alterDefaultValue(String fieldName,
Object value)
The default value of the object class field. |
void |
alterDomain(String fieldName,
IDomain domain)
The default domain of the object class field. |
void |
alterFieldAliasName(String fieldName,
String aliasName)
The alias name of the object class field. |
void |
alterFieldModelName(String fieldName,
String modelName)
The model name of the object class field. |
void |
alterFieldName(String fieldName,
String newFieldName)
Alter the name of the object class field. |
void |
alterInstanceCLSID(IUID instanceCLSID)
Changes the instance COM class associated with this database class. |
void |
alterModelName(String name)
The model name of the object class. |
void |
alterRule(IRule rule)
Alter the existing validation rule. |
void |
analyze(int tableComponents)
Analyze the data to update/generate DBMS statistics. |
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. |
void |
changeSchemaLock(int schemaLock)
Changes a schema lock. |
IDataset |
copy(String copyName,
IWorkspace copyWorkspace)
Copies this dataset to a new dataset with the specified name. |
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 |
deleteGlobalID()
Deletes the global ID column. |
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 |
findField(String name)
The index of the field with the specified name. |
String |
getAliasName()
The alias name of the object class. |
int |
getAllowableComponents()
The allowable components to be analyzed. |
String |
getBrowseName()
The browse name of the dataset. |
String |
getCategory()
The category of the dataset. |
IUID |
getCLSID()
The GUID for the COM Class (CoClass) corresponding to instances of this object class. |
void |
getCurrentSchemaLocks(IEnumSchemaLockInfo[] schemaLockInfo)
The list of current locks. |
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. |
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. |
IFields |
getFields()
The fields collection for this object class. |
IName |
getFullName()
The associated name object. |
IIndexes |
getIndexes()
The indexes collection for this object class. |
String |
getModelName()
The model name of the field. |
String |
getName()
The name of the Dataset. |
int |
getObjectClassID()
The unique ID for the object class. |
String |
getOIDFieldName()
The name of the field corresponding to the OID. |
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. |
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. |
int |
getType()
The type of the Dataset. |
IWorkspace |
getWorkspace()
The workspace containing this dataset. |
int |
hashCode()
the hashcode for this object |
ICursor |
insert(boolean useBuffering)
Returns a cursor that can be used to insert new Rows. |
boolean |
isBeingEdited()
True if the dataset is being edited. |
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. |
boolean |
isHasOID()
Indicates if the class has an object identity (OID) field. |
boolean |
isHasSubtype()
Indicates if the table has subtypes. |
ICursor |
ITable_search(IQueryFilter queryFilter,
boolean recycling)
An object cursor that can be used to fetch row objects selected by the specified query. |
int |
registerAsObjectClass(String suggestedOIDFieldName,
String configKeyword)
Registers this class with the database, assigning it a class id and creating an object id column. |
void |
registerGlobalIDColumn(String columnName)
Registers this column as an Global ID with the database. |
void |
rename(String name)
Renames this Dataset. |
int |
rowCount(IQueryFilter queryFilter)
The number of Rows selected by the specified query. |
ISelectionSet |
select(IQueryFilter queryFilter,
int selType,
int selOption,
IWorkspace selectionContainer)
A selection that contains the object ids selected by the specified query. |
void |
setBrowseName(String name)
The browse name of the dataset. |
void |
setCreatedAtFieldName(String rhs1)
Changes the field name for recording the creation time for Editor Tracking on this object class. |
void |
setCreatorFieldName(String rhs1)
Changes the field name for recording the creator for Editor Tracking on this object class. |
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 |
setEditedAtFieldName(String rhs1)
Changes the field name for recording the edit time for Editor Tracking on this object class. |
void |
setEditorFieldName(String rhs1)
Changes the field name for recording the editor for Editor Tracking on this object class. |
void |
setIsTimeInUTC(boolean rhs1)
Change the property to determine Editor Tracking times are recorded in UTC. |
void |
setModelName(String name)
The model name of the field. |
void |
setSubtypeFieldName(String fieldName)
The subtype field name. |
void |
unregisterGlobalIDColumn(String columnName)
Unregisters this column as an OID with the database. |
ICursor |
update(IQueryFilter queryFilter,
boolean recycling)
Returns a cursor that can be used to update Rows selected by the specified query. |
void |
updateSearchedRows(IQueryFilter queryFilter,
IRowBuffer buffer)
Update the Rows in the database selected by the specified query. |
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. |
| 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 ObjectClass(Object obj)
throws IOException
obj to ObjectClass. *
ObjectClass o = (ObjectClass)obj; // will not work
ObjectClass o = new ObjectClass(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server
IOException - if there are interop problems
ObjectClass theObjectClass = (ObjectClass) obj;| Method Detail |
|---|
public boolean equals(Object o)
equals in class Objectpublic int hashCode()
hashCode in class Object
public String getName()
throws IOException,
AutomationException
getName in interface IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IName getFullName()
throws IOException,
AutomationException
getFullName in interface IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getBrowseName()
throws IOException,
AutomationException
getBrowseName in interface IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setBrowseName(String name)
throws IOException,
AutomationException
setBrowseName in interface IDatasetname - 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 IDatasetIOException - 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 IDatasetIOException - 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 IDatasetIOException - 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 IDatasetIOException - 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 IDatasetIOException - 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 IDatasetIOException - 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 IDatasetcopyName - 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 IDatasetIOException - 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 IDatasetIOException - 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 IDatasetIOException - 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 IDatasetname - The name (in)
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 IDatasetEditIOException - 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 IDatasetEditInfoIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isCanUndo()
throws IOException,
AutomationException
isCanUndo in interface IDatasetEditInfoIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isCanRedo()
throws IOException,
AutomationException
isCanRedo in interface IDatasetEditInfoIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void analyze(int tableComponents)
throws IOException,
AutomationException
When applied to a feature dataset, Analyze updates the statistics for all of the tables.
analyze in interface IDatasetAnalyzetableComponents - The tableComponents (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getAllowableComponents()
throws IOException,
AutomationException
The AllowableComponents property indicates which parts of the table or feature class can be analyzed. The returned value is based on the esriTableComponents enumeration. Members from this enumeration can be bitwise or’d together.
getAllowableComponents in interface IDatasetAnalyzeIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void changeSchemaLock(int schemaLock)
throws IOException,
AutomationException
changeSchemaLock in interface ISchemaLockschemaLock - A com.esri.arcgis.geodatabase.esriSchemaLock constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getCurrentSchemaLocks(IEnumSchemaLockInfo[] schemaLockInfo)
throws IOException,
AutomationException
The ISchemaLockInfo interface is used in concert with ISchemaLock to provide information about a schema lock, for example, whether it is shared or exclusive and for ArcSDE geodatabases, the name of the user who has the lock. Note that there will always be at least one schema lock on the dataset. Also note that by checking the schema locks on a dataset a shared schema lock is applied to the data.
getCurrentSchemaLocks in interface ISchemaLockschemaLockInfo - A reference to a com.esri.arcgis.geodatabase.IEnumSchemaLockInfo (out: use single element array)
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 IClassname - The name (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IFields getFields()
throws IOException,
AutomationException
getFields in interface IClassIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IIndexes getIndexes()
throws IOException,
AutomationException
getIndexes in interface IClassIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void addField(IField field)
throws IOException,
AutomationException
Prior to adding a new field to a class, an exclusive schema lock should be obtained using the ISchemaLock interface.
Attempting to add a new field that does not allow null values will fail, if the class already has data in it. The only solution is to recreate the class with the non-nullable field, then copy the rows from the original class into the new class.
addField in interface IClassfield - A reference to a com.esri.arcgis.geodatabase.IField (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void deleteField(IField field)
throws IOException,
AutomationException
DeleteField removes the specified field from a table, object class or feature class. Fields that are required by the Geodatabase and cannot be removed include:
Prior to deleting a field from a class, an exclusive schema lock should be obtained using the ISchemaLock interface.
// Assume we have a reference to a FeatureClass (pFC) IFields pFields; IField pField; pFields = pFC.getFields(); pField = pFields.getField(pFields.findField("MyField")); pFC.deleteField(pField);
deleteField in interface IClassfield - A reference to a com.esri.arcgis.geodatabase.IField (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void addIndex(IIndex index)
throws IOException,
AutomationException
Prior to adding a new index to a class, an exclusive schema lock should be obtained using the ISchemaLock interface.
addIndex in interface IClassindex - A reference to a com.esri.arcgis.geodatabase.IIndex (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void deleteIndex(IIndex index)
throws IOException,
AutomationException
Prior to deleting an index from a class, an exclusive schema lock should be obtained using the ISchemaLock interface.
deleteIndex in interface IClassindex - A reference to a com.esri.arcgis.geodatabase.IIndex (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isHasOID()
throws IOException,
AutomationException
isHasOID in interface IClassIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getOIDFieldName()
throws IOException,
AutomationException
getOIDFieldName in interface IClassIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IUID getCLSID()
throws IOException,
AutomationException
getCLSID in interface IClassIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IUID getEXTCLSID()
throws IOException,
AutomationException
getEXTCLSID in interface IClassIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public Object getExtension()
throws IOException,
AutomationException
getExtension in interface IClassIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IPropertySet getExtensionProperties()
throws IOException,
AutomationException
getExtensionProperties in interface IClassIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IRow createRow()
throws IOException,
AutomationException
The CreateRow method creates a new row in the underlying database with a system assigned object id value. A row object representing the created row is returned to the caller. The row object returned has the system assigned object ID as the value of the OIDField. All other fields are initialized to null values if they can be made null and to built-in default values appropriate to the type of the field if they cannot be made null.
The caller is responsible for setting the desired field values into the row and calling the Store method on the row. If the table represents an object class with subtypes, then it is the caller’s responsibility to set the default subtype code into the row and call the InitDefaultValues method on the row before storing, if that is the desired result. For tables without object behavior, insert cursors offer a more efficient way for inserting new rows.
createRow in interface ITableIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IRow getRow(int oID)
throws IOException,
AutomationException
The GetRow method returns an existing row object, given its object ID value. The caller can query the returned row object for additional object specific interfaces. The retrieved row may be modified; calling Store on the row object after changing it will trigger messages to related objects and will mark the row for committing to the database.
getRow in interface ITableoID - The oID (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ICursor getRows(Object oids,
boolean recycling)
throws IOException,
AutomationException
The GetRows method returns a cursor that may be used to retrieve a set of rows specified by the input array of object id values. See the description of the Search method to understand the meaning of the recycling parameter. It is far more efficient to retrieve a set of rows using the GetRows method than it is to retrieve each individual row using the GetRow method. The retrieved rows may be modified; Store should be called on the row objects after changing them.
The oids parameter should be passed an integer array. For example:
// Get a recycling cursor for the OID array.
int[] oids = new int[] { 10844, 10853, 10871 };
ICursor cursor = table.getRows(oids, true);
getRows in interface ITableoids - A Variant (in)recycling - The recycling (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IRowBuffer createRowBuffer()
throws IOException,
AutomationException
The CreateRowBuffer method creates a new row buffer object in memory and returns it to the caller. No row is created in the database. The returned row buffer does not have an object ID value. The caller can set values into the row buffer and use it as an argument to the InsertRow method on an insert cursor; the latter is obtained by calling the Insert method on the Table.
createRowBuffer in interface ITableIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void updateSearchedRows(IQueryFilter queryFilter,
IRowBuffer buffer)
throws IOException,
AutomationException
This method will edit the rows matching the query filter's constraints. The values in each row will be replaced with the corresponding field's value in the provided row buffer. The fields being edited should be specified in the query filter's SubFields property. If the row buffer contains null values, and the SubFields property is not properly set, the row's values will be overwritten with the row buffer's null values.
updateSearchedRows in interface ITablequeryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)buffer - A reference to a com.esri.arcgis.geodatabase.IRowBuffer (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void deleteSearchedRows(IQueryFilter queryFilter)
throws IOException,
AutomationException
deleteSearchedRows in interface ITablequeryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int rowCount(IQueryFilter queryFilter)
throws IOException,
AutomationException
rowCount in interface ITablequeryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ICursor ITable_search(IQueryFilter queryFilter,
boolean recycling)
throws IOException,
AutomationException
ITable_search in interface ITablequeryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)recycling - The recycling (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ICursor update(IQueryFilter queryFilter,
boolean recycling)
throws IOException,
AutomationException
The Update method returns an update cursor that can be used to update or delete rows. It offers somewhat faster performance than multiple calls to Store or Delete on row objects fetched using a non-recycling search cursor for tables storing simple rows and simple features. There is no difference in performance for complex objects and features.
When using cursors within an edit session, they should always be scoped to edit operations. In other words, a cursor should be created after an edit operation has begun and should not be used once that edit operation has been stopped or aborted.
update in interface ITablequeryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)recycling - The recycling (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ICursor insert(boolean useBuffering)
throws IOException,
AutomationException
The Insert method returns an insert cursor that can be used to bulk insert rows. It offers significantly faster performance than multiple calls to CreateRow and Store for tables storing simple rows and simple features (that is, for tables whose CLSID is esriGeoDatabase.Row, esriGeoDatabase.Object, or esriGeoDatabase.Feature).
Insert cursors on tables containing complex objects use the CreateRow and Store methods to achieve polymorphism, and there is no difference in performance in these cases.
When using cursors within an edit session, they should always be scoped to edit operations. In other words, a cursor should be created after an edit operation has begun and should not be used once that edit operation has been stopped or aborted.
insert in interface ITableuseBuffering - The useBuffering (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ISelectionSet select(IQueryFilter queryFilter,
int selType,
int selOption,
IWorkspace selectionContainer)
throws IOException,
AutomationException
The Select method returns a selection set that holds either row IDs or row objects from the Table depending on the selection option. Multiple selection sets can be created on the same table. It is up to a client application or object to keep a reference on created selections and use them as appropriate. For example, a FeatureLayer creates and uses selections on a FeatureClass (a type of Table).
The selType parameter determines the type of selection set that will be created: an ID set, a snapshot, or a hybrid. See the ISelectionSet interface for a comparison of the three types.
When calling Select the selectionContainer parameter is no longer required. A null value should be passed as this parameter.
select in interface ITablequeryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)selType - A com.esri.arcgis.geodatabase.esriSelectionType constant (in)selOption - A com.esri.arcgis.geodatabase.esriSelectionOption constant (in)selectionContainer - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getObjectClassID()
throws IOException,
AutomationException
Returns the unique ID of the object class.
Each feature class or table registered with the geodatabase is an object class. Object classes have a unique ID which distinguishes them from other object classes in the geodatabase. The ObjectClassID property returns this ID as a long. The object class ID is assigned by the system when the class is created, or registered with the geodatabase, it cannot be modified.
Those feature classes and tables that are in the database, but not registered with the geodatabase will always have an object class ID of -1.
getObjectClassID in interface IObjectClassIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IEnumRelationshipClass getRelationshipClasses(int role)
throws IOException,
AutomationException
getRelationshipClasses in interface IObjectClassrole - A com.esri.arcgis.geodatabase.esriRelRole constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getAliasName()
throws IOException,
AutomationException
Returns the alias name for the object class.
Object classes in a geodatabase can have between one and three names. The name of the object class, which is the same as the name of the table in the DBMS in which the objects in the object class are stored, the alias name which the user can set for display purposes in end user applications. The third name is the model name which is a tool for developers of custom objects to use to guarantee the names of objects independent of the true name or alias name.
The AliasName property returns the alias name for the object class. If the object class has no alias name, then AliasName will return the name of the object class (fully qualified if on ArcSDE). The alias name can be modified using the IClassSchemEdit interface.
getAliasName in interface IObjectClassIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int registerAsObjectClass(String suggestedOIDFieldName,
String configKeyword)
throws IOException,
AutomationException
The RegisterAsObjectClass method will register a table or feature class (ArcSDE layer) in the database with the Geodatabase. The act of registering the data as an object class will create records for the object class in the Geodatabase system tables and assign the object class a unique ID. Once a table or SDE layer is registered as an object class, it can participate in rules, topological relationships and relationships.
When registering a table or ArcSDE layer as an object class, an ObjectID field must be added to it. This field will contain the object IDs which uniquely identify each feature in the class. The object IDs for existing data will automatically be generated. Once a table or ArcSDE layer has been registered as an object class in the Geodatabase, it cannot be unregistered.
RegisterAsObjectClass takes two arguments: the name of the object ID field, and the ArcSDE configuration keyword to use for storage of the new data that is inserted into the object ID field. RegisterAsObjectClass returns a long which is the object class ID assigned to the newly registered class.
registerAsObjectClass in interface IClassSchemaEditsuggestedOIDFieldName - The suggestedOIDFieldName (in)configKeyword - The configKeyword (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IObjectClass
public void alterInstanceCLSID(IUID instanceCLSID)
throws IOException,
AutomationException
The AlterInstanceCLSID is used to change the behavior class for an object class in the Geodatabase. For example, you may have a class that stores simple feature objects and you want to change it to implement a custom object that you have developed. You use the AlterInstanceCLSID to do so.
AlterInstanceCLSID will try to instantiate the object for the CLSID that you provide. If it fails to instantiate it, the method will fail. Therefore, you must have the DLL which has the implementation of your custom object registered on your system before you call AlterInstanceCLSID.
Before you QI for AlterInstanceCLSID, you will have had to open the object class. So, if this fails because you no longer have the DLL registered on your system, then you must use the IFeatureWorkspaceSchemaEdit interface to alter the instance CLSID.
No additional checking is done beyond instantiating the instance object. If the object class does not have the fields required for supporting the custom object then your class may not function with its new instance CLSID.
alterInstanceCLSID in interface IClassSchemaEditinstanceCLSID - A reference to a com.esri.arcgis.system.IUID (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void alterClassExtensionCLSID(IUID classExtensionCLSID,
IPropertySet classExtensionProperties)
throws IOException,
AutomationException
The AlterClassExtensionCLSID method is used to change the class extension for an object class in the Geodatabase. For example, you may have a class to which you want to associate a class extension that you have developed. You use the AlterClassExtensionCLSID to do so.
AlterClassExtensionCLSID will try to instantiate the object for the class extension that you provide. If it fails to instantiate it, the method will fail. Therefore, you must have the DLL which has the implementation of your class extension registered on your system before you call AlterClassExtensionCLSID.
Before you QI for AlterClassExtensionCLSID, you will have had to open the object class. So, if this fails because you no longer have the DLL registered on your system for a class extension that is already associated with the class, then you must use the IFeatureWorkspaceSchemaEdit interface to alter the class extension CLSID.
alterClassExtensionCLSID in interface IClassSchemaEditclassExtensionCLSID - A reference to a com.esri.arcgis.system.IUID (in)classExtensionProperties - A reference to a com.esri.arcgis.system.IPropertySet (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void alterAliasName(String name)
throws IOException,
AutomationException
Alters 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 AlterAliasName method sets the alias name for the object class. The alias name can be returned using the IObjectClass interface.
alterAliasName in interface IClassSchemaEditname - The name (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IObjectClass
public void alterFieldAliasName(String fieldName,
String aliasName)
throws IOException,
AutomationException
Alters the alias name for a field in the object class.
Fields in object classes in a Geodatabase can have between one and three names. The name of the field, which is the same as the name of the field in 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 fields independent of the true name or alias name.
The AlterFieldAliasName method sets the alias name for a field in the object class. The alias name can be returned using the IField interface.
alterFieldAliasName in interface IClassSchemaEditfieldName - The fieldName (in)aliasName - The aliasName (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IField
public void alterModelName(String name)
throws IOException,
AutomationException
Alters the model 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 AlterModelName method sets the model name for the object class. The model name can be returned using the IModelInfo interface.
alterModelName in interface IClassSchemaEditname - The name (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void alterFieldModelName(String fieldName,
String modelName)
throws IOException,
AutomationException
Alters the model name for a field in the object class.
Fields in object classes in a Geodatabase can have between one and three names. The name of the field, which is the same as the name of the field in 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 fields independent of the true name or alias name.
The AlterFieldModelName method sets the model name for a field in the object class. The model name can be returned using the IModelInfo interface.
alterFieldModelName in interface IClassSchemaEditfieldName - The fieldName (in)modelName - The modelName (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IField
public void alterDomain(String fieldName,
IDomain domain)
throws IOException,
AutomationException
Domains are used in the Geodatabase to validate the contents of fields in an object class. For example, you can use a domain to specify a valid range of values, or a valid set of values for a particular field in an object class. You can assign domains to a field in an object class at either the class level, or the subtype level. The AlterDomain method on IClassSchemaEdit allows you to set a domain for a field at the class level.
AlterDomain takes as arguments the name of the field you want to associate a domain with as a string, and the domain you are associating as an IDomain. You can get an enumeration of domains in a workspace by calling the Domains or DomainsByFieldType methods on the IWorkspaceDomains interface.
Once a domain is associated with a field in your object class, the values in that field will be validated against that domain when a row in the object class is validated with the IValidate interface, or the Validate Selection command in the Editor.
alterDomain in interface IClassSchemaEditfieldName - 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.IField
public void alterDefaultValue(String fieldName,
Object value)
throws IOException,
AutomationException
You can assign a default value to a field in an object class at either the class level, or the subtype level. The AlterDefaultValue method on IClassSchemaEdit allows you to set a default value for a field at the class level.
AlterDefaultValue takes as arguments the name of the field you want to associate a default value with as a string, and the default value you are associating as a variant. AlterDefaultValue will fail if the default value cannot be stored in the field.
Once a default value is associated with a field in your object class, you can use the InitDefaultValues method on IRowSubtypes to populate the fields in a object in your object class with its default value. This method is most often called after you have created a new feature or object in the object class, and before storing it.
alterDefaultValue in interface IClassSchemaEditfieldName - The fieldName (in)value - A Variant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IField
public void alterClassExtensionProperties(IPropertySet classExtensionProperties)
throws IOException,
AutomationException
The AlterClassExtensionProperties method is used to change the class extension properties for an object class in the Geodatabase that already has a class extension associated with it.
AlterClassExtensionProperties takes as an argument the new properties for the class extension as an IPropertySet.
alterClassExtensionProperties in interface IClassSchemaEdit2classExtensionProperties - A reference to a com.esri.arcgis.system.IPropertySet (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IPropertySet
public void addGlobalID(String fieldName)
throws IOException,
AutomationException
Adds a column of type GlobalID to a Geodatabase table or feature class.
GlobalID columns can be added or deleted to versioned as well as non-versioned ArcSDE tables. In ArcSDE, GlobalID columns can be added to tables that already have data. With Personal or File Geodatabases, however, the tables must have no rows otherwise an error is generated when trying to add the column.
Attempts to add these columns for non-supported data sources like shapefile and coverages fail with errors.
addGlobalID in interface IClassSchemaEdit3fieldName - The fieldName (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void deleteGlobalID()
throws IOException,
AutomationException
Deletes a column of type GlobalID to a Geodatabse Table or FeatureClass.
GlobalID columns can be added or deleted to versioned as well as non-versioned ArcSDE tables.
deleteGlobalID in interface IClassSchemaEdit3IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setEditorFieldName(String rhs1)
throws IOException,
AutomationException
EditorFieldName sets the String field that will store the names of users who last edited features or records. The field specified must already exist.
Once you set this property, editor tracking is enabled on the dataset. If you later need to stop recording editor user name information, set the EditorFieldName property to an empty string. To disable editor tracking on the dataset, CreatorFieldName, CreatedAtFieldName, EditorFieldName, and EditedAtFieldName must each be set to an empty string.
setEditorFieldName in interface IClassSchemaEdit4rhs1 - The rhs1 (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setCreatorFieldName(String rhs1)
throws IOException,
AutomationException
CreatorFieldName sets the String field that will store the names of users who create features or records. The field specified must already exist.
Once you set this property, editor tracking is enabled on the dataset. If you later need to stop recording creator user name information, set the CreatorFieldName property to an empty string. To disable editor tracking on the dataset, CreatorFieldName, CreatedAtFieldName, EditorFieldName, and EditedAtFieldName must each be set to an empty string.
setCreatorFieldName in interface IClassSchemaEdit4rhs1 - The rhs1 (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setEditedAtFieldName(String rhs1)
throws IOException,
AutomationException
EditedAtFieldName sets the Date field that will store the date and time features or records were last edited. The field specified must already exist.
Once you set this property, editor tracking is enabled on the dataset. If you later need to stop recording last edited date information, set the EditedAtFieldName property to an empty string. To disable editor tracking on the dataset, CreatorFieldName, CreatedAtFieldName, EditorFieldName, and EditedAtFieldName must each be set to an empty string.
setEditedAtFieldName in interface IClassSchemaEdit4rhs1 - The rhs1 (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setCreatedAtFieldName(String rhs1)
throws IOException,
AutomationException
CreatedAtFieldName sets the Date field that will store the date and time features or records were created. The field specified must already exist.
Once you set this property, editor tracking is enabled on the dataset. If you later need to stop recording when features or records are created, set the CreatedAtFieldName property to an empty string. To disable editor tracking on the dataset, CreatorFieldName, CreatedAtFieldName, EditorFieldName, and EditedAtFieldName must each be set to an empty string.
setCreatedAtFieldName in interface IClassSchemaEdit4rhs1 - The rhs1 (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setIsTimeInUTC(boolean rhs1)
throws IOException,
AutomationException
IsTimeInUTC sets whether time will be recorded in UTC or database time.
If you don't specify this, time will be recorded in UTC.
setIsTimeInUTC in interface IClassSchemaEdit4rhs1 - The rhs1 (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void alterFieldName(String fieldName,
String newFieldName)
throws IOException,
AutomationException
alterFieldName in interface IClassSchemaEdit4fieldName - The fieldName (in)newFieldName - The newFieldName (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void registerGlobalIDColumn(String columnName)
throws IOException,
AutomationException
This method converts a field of type GUID to a field of type GlobalID.
The object must reference an unversioned ArcSDE feature class or table. Use the IVersionedObject3::IsRegisteredAsVersioned property to determine if a dataset is versioned. Additionally the dataset must not be replicated. Use the IWorkspaceReplicasAdmin2::IsReferencedByReplica method to determine if the dataset is part of a replica.
A Global ID field must not already exist on the dataset referenced by the object. Use the IClassEx::HasGlobalID property to determine if a dataset has a Global ID field.
The columnName must reference a field of type GUID in the dataset referenced by the object. The IField::Type property can be used to determine a field type.
There must be no duplicate values in the GUID field. See the DataStatistics coclass for more information.
Another requirement is that the GUID field must be not nullable. See the IField::IsNullable property for more information. By default, GUID columns are nullable. However, when adding a GUID column to a dataset you can specify this field be not nullable. This is possible whether or not the dataset you are adding the new GUID field to already has populated rows. If you add a GUID column to a popluated dataset, and set the IsNullable property of this field to be false, the GUID values will be populated with a default value of {00000000-0000-0000-0000-000000000000}.
If you have a GUID field but it is nullable, to satisfy the requirements of this method, you can simply add a new GUID field, ensure you set the IsNullable property to false, and calculate the values from your GUID field into the newly added GUID field.
Errors will be returned if any of the above requirements are not met.
registerGlobalIDColumn in interface IClassSchemaEditExcolumnName - The columnName (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void unregisterGlobalIDColumn(String columnName)
throws IOException,
AutomationException
This method converts a field of type GlobalID to a field of type GUID.
The object must reference an unversioned ArcSDE feature class or table. Use the IVersionedObject3::IsRegisteredAsVersioned property to determine if a dataset is versioned. Additionally the dataset must not be replicated. Use the IWorkspaceReplicasAdmin2::IsReferencedByReplica method to determine if the dataset is part of a replica.
A Global ID field must not already exist on the dataset referenced by the object. Use the IClassEx::HasGlobalID property to determine if a dataset has a Global ID field.
The columnName must reference a field of type GlobalID in the dataset referenced by the object. The IField::Type property can be used to determine a field type.
Errors will be returned if any of the above requirements are not met.
unregisterGlobalIDColumn in interface IClassSchemaEditExcolumnName - The columnName (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 IModelInfoIOException - 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 IModelInfoname - The name (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IObjectClass,
IField
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 ISubtypesIOException - 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.
getDefaultSubtypeCode in interface ISubtypesIOException - 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.
setDefaultSubtypeCode in interface ISubtypessubtypeCode - 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 ISubtypessubtypeCode - 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 ISubtypessubtypeCode - 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 ISubtypessubtypeCode - 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 ISubtypessubtypeCode - 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 ISubtypesIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setSubtypeFieldName(String fieldName)
throws IOException,
AutomationException
setSubtypeFieldName in interface ISubtypesfieldName - 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.
getSubtypeFieldIndex in interface ISubtypesIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getSubtypeName(int subtypeCode)
throws IOException,
AutomationException
getSubtypeName in interface ISubtypessubtypeCode - 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 ISubtypesIOException - 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 ISubtypessubtypeCode - 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 ISubtypessubtypeCode - 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 IValidationIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IEnumRule getRulesByField(String fieldName)
throws IOException,
AutomationException
getRulesByField in interface IValidationfieldName - 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 IValidationsubtypeCode - 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 IValidationrule - 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 IValidationrule - 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 IValidationselection - 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 IValidationselection - 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 IValidationselection - 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 IValidation2rule - 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 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 IObjectClassInfocanBypassStoreMethod in interface IObjectClassInfo2IOException - 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 IObjectClassInfo2IOException - 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 ITableCapabilitiesIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||