|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.esri.arcgis.schematic.SchematicElementClass
Schematic element class object.
| Constructor Summary | |
SchematicElementClass(java.lang.Object obj)
Construct a SchematicElementClass using a reference to such an object returned from ArcGIS Engine or Server. |
|
| Method Summary | |
void |
addField(IField field)
Adds a field to this object class. |
void |
addIndex(IIndex index)
Adds an index to this object class. |
void |
addRule(IRule rule)
Adds the rule to the set of associated rules. |
void |
addSubtype(int subtypeCode,
java.lang.String subtypeName)
Adds the subtype to the set of associated subtypes. |
void |
alterAliasName(java.lang.String name)
The alias name of the object class. |
void |
alterAssociatedObjectClass(int dataSourceID,
int objectClassID)
Changes the feature class associated with the schematic element class with the new specified datasource ID and the new specified feature class ID. |
void |
alterBuilderPropertySet(IPropertySet propertySet)
Changes the builder PropertySet defined for the schematic element class with the new specified builder PropertySet. |
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 |
alterQuery(int dataSourceID,
IPropertySet propertySet)
Changes the query related to the schematic element class with the new specified datasource ID and the new specified query PropertySet. |
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. |
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. |
ISchematicElement |
createSchematicElement(java.lang.String name,
ISchematicDiagram schematicDiagram)
Creates a new schematic element in the specified schematic diagram. |
void |
delete()
Deletes this dataset. |
void |
deleteField(IField field)
Deletes a field from this object class. |
void |
deleteIndex(IIndex index)
Deletes an index from this object class. |
void |
deleteRule(IRule rule)
Deletes the rule from the set of associated rules. |
void |
deleteSearchedRows(IQueryFilter queryFilter)
Delete the Rows in the database selected by the specified query. |
void |
deleteSubtype(int subtypeCode)
Deletes the subtype from the set of associated subtypes. |
boolean |
equals(java.lang.Object o)
Compare this object with another |
IClass |
esri_getClass()
The class for this class helper. |
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. |
IClass |
getAsIClass()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed. |
IClassHelper |
getAsIClassHelper()
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. |
IDataset |
getAsIDataset()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed. |
IDatasetEdit |
getAsIDatasetEdit()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed. |
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. |
ISchematicElementAssociationContainer |
getAsISchematicElementAssociationContainer()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed. |
ISchematicElementClass |
getAsISchematicElementClass()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed. |
ISchematicElementClassContainer |
getAsISchematicElementClassContainer()
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. |
int |
getAssociatedDataSourceID()
Datasource ID of the feature class associated with the schematic element class. |
IEnumSchematicDiagramClass |
getAssociatedDiagramClasses()
List of the schematic diagram classes associated to the schematic element class. |
int |
getAssociatedObjectClassID()
ID of the feature class associated with the schematic element class. |
java.lang.String |
getBrowseName()
The browse name of the dataset. |
IPropertySet |
getBuilderPropertySet()
Builder property set related to the schematic element class. |
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 |
getDataSourceID()
ID of the datasource related to the schematic element class. |
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. |
ISchematicElementClass |
getParent()
Parent element class of the schematic element class. |
IPropertySet |
getPropertySet()
The set of properties for the dataset. |
IPropertySet |
getQueryPropertySet()
Query PropertySet related to the schematic element class. |
IUID |
getRelationManagerCLSID()
CLSID of the relation manager defined for the schematic elemnt class. |
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. |
ISchematicDataset |
getSchematicDataset()
Schematic dataset related to the schematic element class. |
ISchematicElementAssociation |
getSchematicElementAssociationByID(int iD)
Schematic element association referenced by the specified ID. |
IEnumSchematicElementAssociation |
getSchematicElementAssociations()
Schematic element associations enumeration within the container. |
ISchematicElement |
getSchematicElementByID(int iD,
ISchematicDiagram schematicDiagram)
Schematic element referenced by the specified ID that is contained in the specified schematic diagram. |
ISchematicElement |
getSchematicElementByName(java.lang.String name,
ISchematicDiagram schematicDiagram)
Schematic element referenced by the specified Name that is contained in the specified schematic diagram. |
ISchematicElementClass |
getSchematicElementClassByID(int iD)
Schematic element class referenced by the specified ID. |
ISchematicElementClass |
getSchematicElementClassByName(java.lang.String name)
Schematic element class referenced by the specified Name. |
IEnumSchematicElementClass |
getSchematicElementClasses()
Schematic element classes enumeration within the schematic dataset container. |
IEnumSchematicElement |
getSchematicElements(ISchematicDiagram schematicDiagram)
List of the schematic elements related to the schematic element class within the specified schematic diagram. |
int |
getSchematicElementType()
Schematic element type related to the schematic element class. |
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 |
setParentByRef(ISchematicElementClass parent)
Parent element class of the schematic element class. |
void |
setRelationManagerCLSID(IUID uID)
CLSID of the relation manager defined for the schematic elemnt class. |
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 |
public SchematicElementClass(java.lang.Object obj)
throws java.io.IOException
obj to SchematicElementClass. *
SchematicElementClass o = (SchematicElementClass)obj; // will not work
SchematicElementClass o = new SchematicElementClass(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server
SchematicElementClass theSchematicElementClass = (SchematicElementClass) obj;
java.io.IOException - if there are interop problems| Method Detail |
public ISchematicElementClass getAsISchematicElementClass()
public ISchematicElementClassContainer getAsISchematicElementClassContainer()
public ISchematicElementAssociationContainer getAsISchematicElementAssociationContainer()
public IDataset getAsIDataset()
public IDatasetEdit getAsIDatasetEdit()
public IDatasetEditInfo getAsIDatasetEditInfo()
public ISchemaLock getAsISchemaLock()
public IClass getAsIClass()
public ITable getAsITable()
public IObjectClass getAsIObjectClass()
public IClassSchemaEdit getAsIClassSchemaEdit()
public IClassSchemaEdit2 getAsIClassSchemaEdit2()
public IModelInfo getAsIModelInfo()
public ISubtypes getAsISubtypes()
public IValidation getAsIValidation()
public IValidation2 getAsIValidation2()
public IObjectClassInfo getAsIObjectClassInfo()
public IObjectClassInfo2 getAsIObjectClassInfo2()
public ITableCapabilities getAsITableCapabilities()
public IClassHelper getAsIClassHelper()
public boolean equals(java.lang.Object o)
public int hashCode()
public ISchematicElementClass getParent()
throws java.io.IOException,
AutomationException
ISchematicElementClass
getParent in interface ISchematicElementClassAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setParentByRef(ISchematicElementClass parent)
throws java.io.IOException,
AutomationException
ISchematicElementClass
setParentByRef in interface ISchematicElementClassparent - A reference to a com.esri.arcgis.schematic.ISchematicElementClass (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ISchematicDataset getSchematicDataset()
throws java.io.IOException,
AutomationException
ISchematicElementClass
getSchematicDataset in interface ISchematicElementClassjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getSchematicElementType()
throws java.io.IOException,
AutomationException
ISchematicElementClass
getSchematicElementType in interface ISchematicElementClassAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public ISchematicElement createSchematicElement(java.lang.String name,
ISchematicDiagram schematicDiagram)
throws java.io.IOException,
AutomationException
ISchematicElementClass
createSchematicElement in interface ISchematicElementClassname - The name (in)schematicDiagram - A reference to a com.esri.arcgis.schematic.ISchematicDiagram (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IEnumSchematicElement getSchematicElements(ISchematicDiagram schematicDiagram)
throws java.io.IOException,
AutomationException
ISchematicElementClass
getSchematicElements in interface ISchematicElementClassschematicDiagram - A reference to a com.esri.arcgis.schematic.ISchematicDiagram (in, optional, pass 0 if not required)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ISchematicElement getSchematicElementByID(int iD,
ISchematicDiagram schematicDiagram)
throws java.io.IOException,
AutomationException
ISchematicElementClass
getSchematicElementByID in interface ISchematicElementClassiD - The iD (in)schematicDiagram - A reference to a com.esri.arcgis.schematic.ISchematicDiagram (in, optional, pass 0 if not required)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ISchematicElement getSchematicElementByName(java.lang.String name,
ISchematicDiagram schematicDiagram)
throws java.io.IOException,
AutomationException
ISchematicElementClass
getSchematicElementByName in interface ISchematicElementClassname - The name (in)schematicDiagram - A reference to a com.esri.arcgis.schematic.ISchematicDiagram (in, optional, pass 0 if not required)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public IPropertySet getBuilderPropertySet()
throws java.io.IOException,
AutomationException
ISchematicElementClass
getBuilderPropertySet in interface ISchematicElementClassjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void alterBuilderPropertySet(IPropertySet propertySet)
throws java.io.IOException,
AutomationException
ISchematicElementClass
alterBuilderPropertySet in interface ISchematicElementClasspropertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public int getDataSourceID()
throws java.io.IOException,
AutomationException
ISchematicElementClass
getDataSourceID in interface ISchematicElementClassAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public IPropertySet getQueryPropertySet()
throws java.io.IOException,
AutomationException
ISchematicElementClass
getQueryPropertySet in interface ISchematicElementClassjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void alterQuery(int dataSourceID,
IPropertySet propertySet)
throws java.io.IOException,
AutomationException
ISchematicElementClass
alterQuery in interface ISchematicElementClassdataSourceID - The dataSourceID (in)propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getAssociatedDataSourceID()
throws java.io.IOException,
AutomationException
ISchematicElementClass
getAssociatedDataSourceID in interface ISchematicElementClassAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public int getAssociatedObjectClassID()
throws java.io.IOException,
AutomationException
ISchematicElementClass
getAssociatedObjectClassID in interface ISchematicElementClassjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void alterAssociatedObjectClass(int dataSourceID,
int objectClassID)
throws java.io.IOException,
AutomationException
ISchematicElementClass
alterAssociatedObjectClass in interface ISchematicElementClassdataSourceID - The dataSourceID (in)objectClassID - The objectClassID (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public IUID getRelationManagerCLSID()
throws java.io.IOException,
AutomationException
ISchematicElementClass
getRelationManagerCLSID in interface ISchematicElementClassjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setRelationManagerCLSID(IUID uID)
throws java.io.IOException,
AutomationException
ISchematicElementClass
setRelationManagerCLSID in interface ISchematicElementClassuID - A reference to a com.esri.arcgis.system.IUID (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public IEnumSchematicDiagramClass getAssociatedDiagramClasses()
throws java.io.IOException,
AutomationException
ISchematicElementClass
getAssociatedDiagramClasses in interface ISchematicElementClassAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public int getObjectClassID()
throws java.io.IOException,
AutomationException
IObjectClassReturns 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 IObjectClassAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public IEnumRelationshipClass getRelationshipClasses(int role)
throws java.io.IOException,
AutomationException
IObjectClassReturns an enumeration of the relationship classes in which the object class participates.
Object classes in a geodatabase may participate in any number of relationships classes. The RelationshipClasses property allows you to get a list of those relationship classes that the object class participates in by what role it plays (origin, destination, or either) defined by the esriRelRole enumeration used when you call this property. This property returns a IEnumRelationshipClass interface which you can use to loop through those relationship classes that are returned.
getRelationshipClasses in interface IObjectClassrole - A com.esri.arcgis.geodatabase.esriRelRole constant (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IEnumRelationshipClass,
esriRelRole
public java.lang.String getAliasName()
throws java.io.IOException,
AutomationException
IObjectClassReturns 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 IObjectClassAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.IModelInfo
public int findField(java.lang.String name)
throws java.io.IOException,
AutomationException
IClassIf FindField returns -1, the Field could not be found in the Fields collection.
findField in interface IClassname - The name (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public IFields getFields()
throws java.io.IOException,
AutomationException
IClass
getFields in interface IClassAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public IIndexes getIndexes()
throws java.io.IOException,
AutomationException
IClass
getIndexes in interface IClassjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void addField(IField field)
throws java.io.IOException,
AutomationException
IClass
addField in interface IClassfield - A reference to a com.esri.arcgis.geodatabase.IField (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void deleteField(IField field)
throws java.io.IOException,
AutomationException
IClassDeleteField removes the specified field from a table, object class or feature class. Fields that are required by the Geodatabase and cannot be removed include:
deleteField in interface IClassfield - A reference to a com.esri.arcgis.geodatabase.IField (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void addIndex(IIndex index)
throws java.io.IOException,
AutomationException
IClass
addIndex in interface IClassindex - A reference to a com.esri.arcgis.geodatabase.IIndex (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void deleteIndex(IIndex index)
throws java.io.IOException,
AutomationException
IClass
deleteIndex in interface IClassindex - A reference to a com.esri.arcgis.geodatabase.IIndex (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isHasOID()
throws java.io.IOException,
AutomationException
IClass
isHasOID in interface IClassjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public java.lang.String getOIDFieldName()
throws java.io.IOException,
AutomationException
IClass
getOIDFieldName in interface IClassAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public IUID getCLSID()
throws java.io.IOException,
AutomationException
IClass
getCLSID in interface IClassjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IUID getEXTCLSID()
throws java.io.IOException,
AutomationException
IClass
getEXTCLSID in interface IClassAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public java.lang.Object getExtension()
throws java.io.IOException,
AutomationException
IClass
getExtension in interface IClassjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IPropertySet getExtensionProperties()
throws java.io.IOException,
AutomationException
IClass
getExtensionProperties in interface IClassAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public IEnumSchematicElementClass getSchematicElementClasses()
throws java.io.IOException,
AutomationException
ISchematicElementClassContainer
getSchematicElementClasses in interface ISchematicElementClassContainerAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public ISchematicElementClass getSchematicElementClassByID(int iD)
throws java.io.IOException,
AutomationException
ISchematicElementClassContainer
getSchematicElementClassByID in interface ISchematicElementClassContaineriD - The iD (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ISchematicElementClass getSchematicElementClassByName(java.lang.String name)
throws java.io.IOException,
AutomationException
ISchematicElementClassContainer
getSchematicElementClassByName in interface ISchematicElementClassContainername - The name (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public IEnumSchematicElementAssociation getSchematicElementAssociations()
throws java.io.IOException,
AutomationException
ISchematicElementAssociationContainer
getSchematicElementAssociations in interface ISchematicElementAssociationContainerAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public ISchematicElementAssociation getSchematicElementAssociationByID(int iD)
throws java.io.IOException,
AutomationException
ISchematicElementAssociationContainer
getSchematicElementAssociationByID in interface ISchematicElementAssociationContaineriD - The iD (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public java.lang.String getName()
throws java.io.IOException,
AutomationException
IDataset
getName in interface IDatasetAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public IName getFullName()
throws java.io.IOException,
AutomationException
IDataset
getFullName in interface IDatasetAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public java.lang.String getBrowseName()
throws java.io.IOException,
AutomationException
IDataset
getBrowseName in interface IDatasetjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setBrowseName(java.lang.String name)
throws java.io.IOException,
AutomationException
IDataset
setBrowseName in interface IDatasetname - The name (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public int getType()
throws java.io.IOException,
AutomationException
IDataset
getType in interface IDatasetAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public java.lang.String getCategory()
throws java.io.IOException,
AutomationException
IDatasetIDataset::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.
getCategory in interface IDatasetAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public IEnumDataset getSubsets()
throws java.io.IOException,
AutomationException
IDatasetThe 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 IDatasetAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public IWorkspace getWorkspace()
throws java.io.IOException,
AutomationException
IDatasetThe Workspace property returns the containing workspace for this dataset.
getWorkspace in interface IDatasetjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IPropertySet getPropertySet()
throws java.io.IOException,
AutomationException
IDatasetThe 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.
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 IDatasetAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public boolean canCopy()
throws java.io.IOException,
AutomationException
IDatasetThe 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 IDatasetAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public IDataset copy(java.lang.String copyName,
IWorkspace copyWorkspace)
throws java.io.IOException,
AutomationException
IDatasetIDataset::Copy does not support the copying of Graph objects such as a Geometric Network.
copy in interface IDatasetcopyName - The copyName (in)copyWorkspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.GeoDBDataTransfer
public boolean canDelete()
throws java.io.IOException,
AutomationException
IDatasetThe 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 IDatasetjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void delete()
throws java.io.IOException,
AutomationException
IDatasetCertain feature classes, such as network and topology feature classes, cannot be deleted until their containing objects are deleted.
delete in interface IDatasetAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public boolean canRename()
throws java.io.IOException,
AutomationException
IDatasetThe 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 IDatasetjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void rename(java.lang.String name)
throws java.io.IOException,
AutomationException
IDatasetIDataset::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)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isBeingEdited()
throws java.io.IOException,
AutomationException
IDatasetEdit
isBeingEdited in interface IDatasetEditjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isCanEdit()
throws java.io.IOException,
AutomationException
IDatasetEditInfo
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 IDatasetEditInfojava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isCanUndo()
throws java.io.IOException,
AutomationException
IDatasetEditInfo
isCanUndo in interface IDatasetEditInfojava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isCanRedo()
throws java.io.IOException,
AutomationException
IDatasetEditInfo
isCanRedo in interface IDatasetEditInfoAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void changeSchemaLock(int schemaLock)
throws java.io.IOException,
AutomationException
ISchemaLock
changeSchemaLock in interface ISchemaLockschemaLock - A com.esri.arcgis.geodatabase.esriSchemaLock constant (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getCurrentSchemaLocks(IEnumSchemaLockInfo[] schemaLockInfo)
throws java.io.IOException,
AutomationException
ISchemaLockReturns an enumeration of the schema locks currently on the dataset. Not that there will always be at least one schema lock on the dataset. 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)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public IRow createRow()
throws java.io.IOException,
AutomationException
ITableThe 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 ITablejava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IRow getRow(int oID)
throws java.io.IOException,
AutomationException
ITableThe 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)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ICursor getRows(java.lang.Object oids,
boolean recycling)
throws java.io.IOException,
AutomationException
ITableThe 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.
getRows in interface ITableoids - A Variant (in)recycling - The recycling (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public IRowBuffer createRowBuffer()
throws java.io.IOException,
AutomationException
ITableThe 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 ITableAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void updateSearchedRows(IQueryFilter queryFilter,
IRowBuffer buffer)
throws java.io.IOException,
AutomationException
ITableAll edits to features that participate in a Topology or Geometric Network must be performed within an edit session and bracketed within an edit operation.
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)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void deleteSearchedRows(IQueryFilter queryFilter)
throws java.io.IOException,
AutomationException
ITable
deleteSearchedRows in interface ITablequeryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int rowCount(IQueryFilter queryFilter)
throws java.io.IOException,
AutomationException
ITable
rowCount in interface ITablequeryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ICursor ITable_search(IQueryFilter queryFilter,
boolean recycling)
throws java.io.IOException,
AutomationException
ITable
ITable_search in interface ITablequeryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)recycling - The recycling (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ICursor update(IQueryFilter queryFilter,
boolean recycling)
throws java.io.IOException,
AutomationException
ITableThe Update method returns an ‘update’ cursor that can be used to update or delete rows. It offers somewhat faster performance than multiple calls to Store or Delete on row objects fetched using a non-recycling search cursor for tables storing simple rows and simple features. There is no difference in performance for custom features.
All edits to features that participate in a Topology or Geometric Network must be bracketed within an edit operation.
update in interface ITablequeryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)recycling - The recycling (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ICursor insert(boolean useBuffering)
throws java.io.IOException,
AutomationException
ITableThe Insert method returns an ‘insert’ cursor that can be used to bulk insert rows. It offers significantly faster performance than multiple calls to CreateRow and Store for tables storing simple rows and simple features (that is, for tables whose CLSID is esriGeoDatabase.Row, esriGeoDatabase.Object, or esriGeoDatabase.Feature).
Insert cursors on tables containing custom rows and objects use the CreateRow and Store methods to achieve polymorphism, and there is no difference in performance in these cases.
insert in interface ITableuseBuffering - The useBuffering (in)
java.io.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 java.io.IOException,
AutomationException
ITableThe Select method returns a selection set that holds either row ids or row objects from the Table depending on the selection option. Multiple selection sets can be created on the same table. It is up to a client application or object to keep a reference on created selections and use them as appropriate. For example, a FeatureLayer creates and uses selections on a FeatureClass (a type of Table).
When calling Select the selectionContainer parameter is no longer required. Null (C#, VB.Net) or Nothing (VB6) should be supplied it its place.
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)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int registerAsObjectClass(java.lang.String suggestedOIDFieldName,
java.lang.String configKeyword)
throws java.io.IOException,
AutomationException
IClassSchemaEditThe 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)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.IObjectClass,
IFeatureClass,
IClass
public void alterInstanceCLSID(IUID instanceCLSID)
throws java.io.IOException,
AutomationException
IClassSchemaEditThe 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)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.IFeatureWorkspaceSchemaEdit
public void alterClassExtensionCLSID(IUID classExtensionCLSID,
IPropertySet classExtensionProperties)
throws java.io.IOException,
AutomationException
IClassSchemaEditThe 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)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.IFeatureWorkspaceSchemaEdit,
IObjectClassExtension
public void alterAliasName(java.lang.String name)
throws java.io.IOException,
AutomationException
IClassSchemaEditAlters 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)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.IModelInfo,
IObjectClass
public void alterFieldAliasName(java.lang.String fieldName,
java.lang.String aliasName)
throws java.io.IOException,
AutomationException
IClassSchemaEditAlters 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)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.IField
public void alterModelName(java.lang.String name)
throws java.io.IOException,
AutomationException
IClassSchemaEditAlters 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)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.IModelInfo
public void alterFieldModelName(java.lang.String fieldName,
java.lang.String modelName)
throws java.io.IOException,
AutomationException
IClassSchemaEditAlters 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)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.IModelInfo,
IField
public void alterDomain(java.lang.String fieldName,
IDomain domain)
throws java.io.IOException,
AutomationException
IClassSchemaEditDomains 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)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IField,
IDomain,
IWorkspaceDomains
public void alterDefaultValue(java.lang.String fieldName,
java.lang.Object value)
throws java.io.IOException,
AutomationException
IClassSchemaEditYou 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)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IField,
ISubtypes,
IRowSubtypes
public void alterClassExtensionProperties(IPropertySet classExtensionProperties)
throws java.io.IOException,
AutomationException
IClassSchemaEdit2The 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)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.IPropertySet,
IObjectClassExtension
public java.lang.String getModelName()
throws java.io.IOException,
AutomationException
IModelInfoReturns the model name currently associated with the field or object class.
getModelName in interface IModelInfojava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IField,
IObjectClass,
IClassSchemaEdit
public void setModelName(java.lang.String name)
throws java.io.IOException,
AutomationException
IModelInfo
setModelName in interface IModelInfoname - The name (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IField,
IFieldEdit,
IObjectClass,
IClassSchemaEdit
public boolean isHasSubtype()
throws java.io.IOException,
AutomationException
ISubtypesHasSubtype 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 ISubtypesAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public int getDefaultSubtypeCode()
throws java.io.IOException,
AutomationException
ISubtypesDefaultSubtypeCode 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 ISubtypesAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setDefaultSubtypeCode(int subtypeCode)
throws java.io.IOException,
AutomationException
ISubtypesDefaultSubtypeCode property sets the default subtype code for the given object class.
setDefaultSubtypeCode in interface ISubtypessubtypeCode - The subtypeCode (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public java.lang.Object getDefaultValue(int subtypeCode,
java.lang.String fieldName)
throws java.io.IOException,
AutomationException
ISubtypesDefaultValue property returns the default value for the given subtype.
This property return the default value for a particular field associated with a subtype. It requires the subtype code as a Long and the field name as a String . You can use the IField::Type property to determine the type of field that you are passing into the function so you will know what data type is being returned.
getDefaultValue in interface ISubtypessubtypeCode - The subtypeCode (in)fieldName - The fieldName (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setDefaultValue(int subtypeCode,
java.lang.String fieldName,
java.lang.Object value)
throws java.io.IOException,
AutomationException
ISubtypesDefaultValue property sets the default value for the given subtype.
This property sets the default value for a particlar field associated with a subtype. It requires the subtype code as a Long and the field name as a String.
setDefaultValue in interface ISubtypessubtypeCode - The subtypeCode (in)fieldName - The fieldName (in)value - A Variant (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public IDomain getDomain(int subtypeCode,
java.lang.String fieldName)
throws java.io.IOException,
AutomationException
ISubtypesThe Domain property returns or sets the domain given the subtype code and the fieldname of the subtype.
This property returns or sets an IDomain object associated with a particular subtype code and field. The subtype code is required as a Long and field name as a String.
getDomain in interface ISubtypessubtypeCode - The subtypeCode (in)fieldName - The fieldName (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setDomainByRef(int subtypeCode,
java.lang.String fieldName,
IDomain domain)
throws java.io.IOException,
AutomationException
ISubtypes
setDomainByRef in interface ISubtypessubtypeCode - The subtypeCode (in)fieldName - The fieldName (in)domain - A reference to a com.esri.arcgis.geodatabase.IDomain (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public java.lang.String getSubtypeFieldName()
throws java.io.IOException,
AutomationException
ISubtypesThe 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:
getSubtypeFieldName in interface ISubtypesAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setSubtypeFieldName(java.lang.String fieldName)
throws java.io.IOException,
AutomationException
ISubtypes
setSubtypeFieldName in interface ISubtypesfieldName - The fieldName (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public int getSubtypeFieldIndex()
throws java.io.IOException,
AutomationException
ISubtypesSubtypeFieldIndex 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 ISubtypesAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public java.lang.String getSubtypeName(int subtypeCode)
throws java.io.IOException,
AutomationException
ISubtypesSubtypeName property returns the subtype name for the subtype referred to by the parameter subtypecode.
This property returns the name of a subtype for a given subtype code for the associated object class. The subtype code is required as a Long and returns the name of the subtype as a String.
getSubtypeName in interface ISubtypessubtypeCode - The subtypeCode (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public IEnumSubtype getSubtypes()
throws java.io.IOException,
AutomationException
ISubtypesSubtypes 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 ISubtypesjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void addSubtype(int subtypeCode,
java.lang.String subtypeName)
throws java.io.IOException,
AutomationException
ISubtypesAddSubtype 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)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void deleteSubtype(int subtypeCode)
throws java.io.IOException,
AutomationException
ISubtypesDeleteSubtype 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)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IEnumRule getRules()
throws java.io.IOException,
AutomationException
IValidation
getRules in interface IValidationAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public IEnumRule getRulesByField(java.lang.String fieldName)
throws java.io.IOException,
AutomationException
IValidation
getRulesByField in interface IValidationfieldName - The fieldName (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IEnumRule getRulesBySubtypeCode(int subtypeCode)
throws java.io.IOException,
AutomationException
IValidation
getRulesBySubtypeCode in interface IValidationsubtypeCode - The subtypeCode (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void addRule(IRule rule)
throws java.io.IOException,
AutomationException
IValidation
addRule in interface IValidationrule - A reference to a com.esri.arcgis.geodatabase.IRule (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void deleteRule(IRule rule)
throws java.io.IOException,
AutomationException
IValidation
deleteRule in interface IValidationrule - A reference to a com.esri.arcgis.geodatabase.IRule (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ISelectionSet validate(IQueryFilter selection,
IWorkspace workspace)
throws java.io.IOException,
AutomationException
IValidationValidate 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)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ISelectionSet validateSelection(ISelectionSet selection,
IWorkspace workspace)
throws java.io.IOException,
AutomationException
IValidation
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)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ISet validateSet(ISet selection)
throws java.io.IOException,
AutomationException
IValidation
validateSet in interface IValidationselection - A reference to a com.esri.arcgis.system.ISet (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void alterRule(IRule rule)
throws java.io.IOException,
AutomationException
IValidation2The AlterRule method is used to change the characteristics of an existing rule. This is currently only implemented to change connectivity rules.
alterRule in interface IValidation2rule - A reference to a com.esri.arcgis.geodatabase.IRule (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean canBypassStoreMethod()
throws java.io.IOException,
AutomationException
IObjectClassInfoCanBypassStore 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 IObjectClassInfoAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public boolean canBypassEditSession()
throws java.io.IOException,
AutomationException
IObjectClassInfo2CanBypassEditSession 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 IObjectClassInfo2AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public boolean isCanSelect()
throws java.io.IOException,
AutomationException
ITableCapabilitiesUse 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 ITableCapabilitiesjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IClass esri_getClass()
throws java.io.IOException,
AutomationException
IClassHelper
esri_getClass in interface IClassHelperjava.io.IOException - 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 | |||||||||