ObjectClass (ArcObjects Java API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.geodatabase
Class ObjectClass

java.lang.Object
  com.esri.arcgis.geodatabase.ObjectClass

All Implemented Interfaces:: IClass, IClassSchemaEdit, IClassSchemaEdit2, IClassSchemaEdit3, IDataset, IDatasetAnalyze, IDatasetEdit, IDatasetEditInfo, IModelInfo, IObjectClass, IObjectClassInfo, IObjectClassInfo2, ISchemaLock, ISubtypes, ITable, ITableCapabilities, IValidation, IValidation2, java.io.Serializable

public class ObjectClass
extends java.lang.Object
implements IDataset, IDatasetEdit, IDatasetEditInfo, IDatasetAnalyze, ISchemaLock, IClass, ITable, IObjectClass, IClassSchemaEdit, IClassSchemaEdit2, IClassSchemaEdit3, IModelInfo, ISubtypes, IValidation, IValidation2, IObjectClassInfo, IObjectClassInfo2, ITableCapabilities

ObjectClass Object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Remarks

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.

See Also:: IObjectClass, Table, IRowSubtypes, Serialized Form

Constructor Summary
`ObjectClass(java.lang.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(java.lang.String fieldName)` Adds a global ID column to a class & 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, java.lang.String subtypeName)` Adds the subtype to the set of associated subtypes.
`void`	`alterAliasName(java.lang.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(java.lang.String fieldName, java.lang.Object value)` The default value of the object class field.
`void`	`alterDomain(java.lang.String fieldName, IDomain domain)` The default domain of the object class field.
`void`	`alterFieldAliasName(java.lang.String fieldName, java.lang.String aliasName)` The alias name of the object class field.
`void`	`alterFieldModelName(java.lang.String fieldName, java.lang.String modelName)` The model name of the object class field.
`void`	`alterInstanceCLSID(IUID instanceCLSID)` Changes the instance COM class associated with this database class.
`void`	`alterModelName(java.lang.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(java.lang.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(java.lang.Object o)` Compare this object with another
`int`	`findField(java.lang.String name)` The index of the field with the specified name.
`java.lang.String`	`getAliasName()` The alias name of the object class.
`int`	`getAllowableComponents()` The allowable components to be analyzed.
`IClass`	`getAsIClass()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IClassSchemaEdit`	`getAsIClassSchemaEdit()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IClassSchemaEdit2`	`getAsIClassSchemaEdit2()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IClassSchemaEdit3`	`getAsIClassSchemaEdit3()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IDataset`	`getAsIDataset()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IDatasetAnalyze`	`getAsIDatasetAnalyze()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IDatasetEdit`	`getAsIDatasetEdit()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IDatasetEditInfo`	`getAsIDatasetEditInfo()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IModelInfo`	`getAsIModelInfo()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IObjectClass`	`getAsIObjectClass()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IObjectClassInfo`	`getAsIObjectClassInfo()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IObjectClassInfo2`	`getAsIObjectClassInfo2()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`ISchemaLock`	`getAsISchemaLock()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`ISubtypes`	`getAsISubtypes()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`ITable`	`getAsITable()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`ITableCapabilities`	`getAsITableCapabilities()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IValidation`	`getAsIValidation()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IValidation2`	`getAsIValidation2()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`java.lang.String`	`getBrowseName()` The browse name of the dataset.
`java.lang.String`	`getCategory()` The category of the dataset.
`IUID`	`getCLSID()` The GUID for the COM Class (CoClass) corresponding to instances of this object class.
`void`	`getCurrentSchemaLocks(IEnumSchemaLockInfo[] schemaLockInfo)` The list of current locks.
`int`	`getDefaultSubtypeCode()` The default subtype associated with the class.
`java.lang.Object`	`getDefaultValue(int subtypeCode, java.lang.String fieldName)` The default value for the associated attribute.
`IDomain`	`getDomain(int subtypeCode, java.lang.String fieldName)` The domain given the subtype and field.
`IUID`	`getEXTCLSID()` The GUID for the COM Class (CoClass) corresponding to the class extension for this object class.
`java.lang.Object`	`getExtension()` The extension for this object class.
`IPropertySet`	`getExtensionProperties()` The extension properties for this object class.
`IFields`	`getFields()` The fields collection for this object class.
`IName`	`getFullName()` The associated name object.
`IIndexes`	`getIndexes()` The indexes collection for this object class.
`java.lang.String`	`getModelName()` The model name of the field.
`java.lang.String`	`getName()` The name of the Dataset.
`int`	`getObjectClassID()` The unique ID for the object class.
`java.lang.String`	`getOIDFieldName()` The name of the field corresponding to the OID.
`IPropertySet`	`getPropertySet()` The set of properties for the dataset.
`IEnumRelationshipClass`	`getRelationshipClasses(int role)` The relationship classes in which this object class participates in for the specified role.
`IRow`	`getRow(int oID)` The row from the database with the specified object ID.
`ICursor`	`getRows(java.lang.Object oids, boolean recycling)` The cursor of rows based on a set of object ids.
`IEnumRule`	`getRules()` The rules associated with the class.
`IEnumRule`	`getRulesByField(java.lang.String fieldName)` The rules associated with the attribute.
`IEnumRule`	`getRulesBySubtypeCode(int subtypeCode)` The rules associated with the subtype.
`IEnumDataset`	`getSubsets()` Datasets contained within this dataset.
`int`	`getSubtypeFieldIndex()` The subtype field index.
`java.lang.String`	`getSubtypeFieldName()` The subtype field name.
`java.lang.String`	`getSubtypeName(int subtypeCode)` The subtype name.
`IEnumSubtype`	`getSubtypes()` The subtypes associated with the class.
`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(java.lang.String suggestedOIDFieldName, java.lang.String configKeyword)` Registers this class with the database, assigning it a class id and creating an object id column.
`void`	`rename(java.lang.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(java.lang.String name)` The browse name of the dataset.
`void`	`setDefaultSubtypeCode(int subtypeCode)` The default subtype associated with the class.
`void`	`setDefaultValue(int subtypeCode, java.lang.String fieldName, java.lang.Object value)` The default value for the associated attribute.
`void`	`setDomainByRef(int subtypeCode, java.lang.String fieldName, IDomain domain)` The domain given the subtype and field.
`void`	`setModelName(java.lang.String name)` The model name of the field.
`void`	`setSubtypeFieldName(java.lang.String fieldName)` The subtype field name.
`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

Constructor Detail

ObjectClass

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

Construct a ObjectClass using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ObjectClass.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
* 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 ObjectClass theObjectClass = (ObjectClass) obj;
Throws:: java.io.IOException - if there are interop problems

Method Detail