SchematicDiagramClass (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.schematic
Class SchematicDiagramClass

java.lang.Object
  com.esri.arcgis.schematic.SchematicDiagramClass

All Implemented Interfaces:: IClass, IClassSchemaEdit, IClassSchemaEdit2, IDataset, IDatasetEdit, IDatasetEditInfo, IGeoDataset, IGeoDatasetSchemaEdit, IMetadata, IMetadataEdit, IModelInfo, IObjectClass, IObjectClassInfo, IObjectClassInfo2, ISchemaLock, ISubtypes, ITable, ITableCapabilities, IValidation, IValidation2, com.esri.arcgis.interop.RemoteObjRef, IGPSchematicBuilder, ISchematicAttributeContainer, ISchematicAttributeDesign, ISchematicBuilder, ISchematicBuilderRuleContainer, ISchematicBuilderRuleContainerEdit, ISchematicDiagramClass, ISchematicDiagramClassContainer, ISchematicInMemoryDiagramContainer, ISchematicObjectClass, ISchematicObjectClassContainer, Serializable

public class SchematicDiagramClass
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISchematicDiagramClass, ISchematicObjectClass, IDataset, IDatasetEdit, IDatasetEditInfo, IClass, IClassSchemaEdit, IClassSchemaEdit2, ITable, ITableCapabilities, IModelInfo, ISchemaLock, IObjectClass, IObjectClassInfo, IObjectClassInfo2, ISubtypes, IValidation, IValidation2, IMetadata, IMetadataEdit, IGeoDataset, IGeoDatasetSchemaEdit, ISchematicBuilder, IGPSchematicBuilder, ISchematicInMemoryDiagramContainer, ISchematicDiagramClassContainer, ISchematicBuilderRuleContainer, ISchematicBuilderRuleContainerEdit, ISchematicObjectClassContainer, ISchematicAttributeDesign, ISchematicAttributeContainer
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISchematicDiagramClass, ISchematicObjectClass, IDataset, IDatasetEdit, IDatasetEditInfo, IClass, IClassSchemaEdit, IClassSchemaEdit2, ITable, ITableCapabilities, IModelInfo, ISchemaLock, IObjectClass, IObjectClassInfo, IObjectClassInfo2, ISubtypes, IValidation, IValidation2, IMetadata, IMetadataEdit, IGeoDataset, IGeoDatasetSchemaEdit, ISchematicBuilder, IGPSchematicBuilder, ISchematicInMemoryDiagramContainer, ISchematicDiagramClassContainer, ISchematicBuilderRuleContainer, ISchematicBuilderRuleContainerEdit, ISchematicObjectClassContainer, ISchematicAttributeDesign, ISchematicAttributeContainer

Schematic diagram class object.

Product Availability

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

See Also:: Serialized Form

Constructor Summary
`SchematicDiagramClass(Object obj)` Construct a SchematicDiagramClass 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.
`ISchematicBuilderRule`	`addSchematicBuilderRule()` Adds a schematic builder rules within the builder rule container.
`void`	`addSubtype(int subtypeCode, String subtypeName)` Adds the subtype to the set of associated subtypes.
`void`	`alterAliasName(String name)` The alias name of the object class.
`void`	`alterClassExtensionCLSID(IUID classExtensionCLSID, IPropertySet classExtensionProperties)` Changes the class extension COM class associated with this database class.
`void`	`alterClassExtensionProperties(IPropertySet classExtensionProperties)` Changes the class extension properties associated with this object class.
`void`	`alterDefaultValue(String fieldName, Object value)` The default value of the object class field.
`void`	`alterDomain(String fieldName, IDomain domain)` The default domain of the object class field.
`void`	`alterFieldAliasName(String fieldName, String aliasName)` The alias name of the object class field.
`void`	`alterFieldModelName(String fieldName, String modelName)` The model name of the object class field.
`void`	`alterInstanceCLSID(IUID instanceCLSID)` Changes the instance COM class associated with this database class.
`void`	`alterModelName(String name)` The model name of the object class.
`void`	`alterRule(IRule rule)` Alter the existing validation rule.
`void`	`alterSchematicAttributeCLSID(String name, IUID uID)` Changes the schematic attribute CLSID.
`void`	`alterSpatialReference(ISpatialReference spatialReference)` Alters the spatial reference of the dataset to match the coordinate system of the input spatial reference, does not reproject the data.
`void`	`associateSchematicElementClass(ISchematicElementClass schematicElementClass)` Associates the element class to the schematic diagram class.
`boolean`	`canBypassEditSession()` Indicates if updates to objects can be safely made outside of an edit session.
`boolean`	`canBypassStoreMethod()` Indicates if updates to objects can bypass the Store method and OnChange notifications for efficiency.
`boolean`	`canCopy()` True if this dataset can be copied.
`boolean`	`canDelete()` True if this dataset can be deleted.
`boolean`	`canRename()` True if this dataset can be renamed.
`void`	`changeSchemaLock(int schemaLock)` Changes a schema lock.
`IDataset`	`copy(String copyName, IWorkspace copyWorkspace)` Copies this dataset to a new dataset with the specified name.
`IRow`	`createRow()` Creates a row in the database with a system assigned object ID and null property values.
`IRowBuffer`	`createRowBuffer()` Creates a row buffer that can be used with an insert cursor.
`ISchematicAttribute`	`createSchematicAttribute(String name, IUID uID)` Creates a schematic in memory attribute.
`ISchematicDiagram`	`createSchematicDiagram(String name, ISchematicDiagramContainer diagramContainer)` Creates a new schematic diagram.
`void`	`delete()` Deletes this dataset.
`void`	`delete(boolean deleteDescendants)` Deletes the schematic object class.
`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.
`void`	`dissociateSchematicElementClass(ISchematicElementClass schematicElementClass)` Dissociates the element class from the schematic diagram class.
`boolean`	`equals(Object o)` Compare this object with another
`int`	`findField(String name)` The index of the field with the specified name.
`ISchematicDiagram`	`generateDiagram(String diagramName, ISchematicDiagramContainer diagramContainer, IPropertySet propertySet, ISchematicBuilderContext context, ITrackCancel cancelTracker)` Generates a new schematic diagram implemented by the schematic diagram builder.
`String`	`getAliasName()` The alias name of the object class.
`IEnumSchematicElementClass`	`getAssociatedSchematicElementClasses()` The associated element classes to the schematic diagram class.
`String`	`getBrowseName()` The browse name of the dataset.
`String`	`getCategory()` The category of the dataset.
`IUID`	`getCLSID()` The GUID for the COM Class (CoClass) corresponding to instances of this object class.
`void`	`getCurrentSchemaLocks(IEnumSchemaLockInfo[] schemaLockInfo)` The list of current locks.
`ISchematicElementClass`	`getDefaultSchematicNodeClass()` Default schematic in memory node element class related to the schematic diagram class.
`int`	`getDefaultSubtypeCode()` The default subtype associated with the class.
`Object`	`getDefaultValue(int subtypeCode, String fieldName)` The default value for the associated attribute.
`IDomain`	`getDomain(int subtypeCode, String fieldName)` The domain given the subtype and field.
`IUID`	`getEXTCLSID()` The GUID for the COM Class (CoClass) corresponding to the class extension for this object class.
`Object`	`getExtension()` The extension for this object class.
`IPropertySet`	`getExtensionProperties()` The extension properties for this object class.
`IEnvelope`	`getExtent()` The extent of the GeoDataset.
`int`	`getExternalQueryEvaluationMode()` External query evaluation mode of the schematic object class.
`IFields`	`getFields()` The fields collection for this object class.
`IName`	`getFullName()` The associated name object.
`Object`	`getIdentifierFieldNames()` Identifier fields names of the schematic object class.
`IIndexes`	`getIndexes()` The indexes collection for this object class.
`IPropertySet`	`getMetadata()` The PropertySet containing metadata.
`String`	`getModelName()` The model name of the field.
`String`	`getName()` Name of the schematic object class.
`int`	`getObjectClassID()` The unique ID for the object class.
`String`	`getOIDFieldName()` The name of the field corresponding to the OID.
`IEnumSchematicBuilderRule`	`getOrderedSchematicBuilderRules()` Schematic ordered builder rules enumeration within the builder rule container.
`ISchematicDiagramClass`	`getParent()` Parent of the schematic diagram class.
`String[]`	`getPredefinedAttributeNames()` Predefined attributes names of the schematic in memory object class.
`IPropertySet`	`getPropertySet()` The set of properties for the dataset.
`String`	`getQueryString()` Query string of the schematic object 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(Object oids, boolean recycling)` The cursor of rows based on a set of object ids.
`IEnumRule`	`getRules()` The rules associated with the class.
`IEnumRule`	`getRulesByField(String fieldName)` The rules associated with the attribute.
`IEnumRule`	`getRulesBySubtypeCode(int subtypeCode)` The rules associated with the subtype.
`ISchematicAlgorithm`	`getSchematicAlgorithm()` Schematic algorithm of the schematic diagram class.
`IEnumSchematicAlgorithm`	`getSchematicAlgorithms()` Schematic algorithms of the schematic diagram class.
`ISchematicAttribute`	`getSchematicAttribute(String name, boolean recursiveSearch)` Retrives recursively or not the schematic attribute referenced by the specified Name.
`IEnumSchematicAttribute`	`getSchematicAttributes()` Schematic attributes enumeration within the schematic attribute container.
`ISchematicBuilder`	`getSchematicBuilder()` Schematic builder of the schematic diagram class.
`int`	`getSchematicBuilderRuleCount()` Number of builder rules within the builder rule container.
`ISchematicDataset`	`getSchematicDataset()` Schematic dataset the schematic object class belongs to.
`ISchematicDataSource`	`getSchematicDataSource()` Schematic data source of the schematic object class.
`ISchematicDiagram`	`getSchematicDiagramByID(int iD)` Schematic diagram referenced by the specified ID.
`ISchematicDiagram`	`getSchematicDiagramByName(String name)` Schematic diagram referenced by the specified Name.
`ISchematicDiagramClass`	`getSchematicDiagramClass(String name)` Schematic diagram class referenced by the specified Name.
`IEnumSchematicDiagramClass`	`getSchematicDiagramClasses()` Schematic diagram classes enumeration within the schematic diagram class container.
`IEnumSchematicDiagram`	`getSchematicDiagrams()` Schematic diagrams enumeration within the schematic dataset or schematic folder container.
`ISchematicInMemoryDiagram`	`getSchematicInMemoryDiagram(String name)` Schematic in memory diagram referenced by the specified Name.
`IEnumSchematicInMemoryDiagram`	`getSchematicInMemoryDiagrams()` Schematic in memory diagrams enumeration within the schematic diagram container.
`ISchematicLayer`	`getSchematicLayerTemplate()` Schematic layer template related to the schematic diagram class.
`ISchematicObjectClass`	`getSchematicObjectClass(String name)` Schematic object class referenced by the specified Name.
`IEnumSchematicObjectClass`	`getSchematicObjectClasses()` Schematic object classes enumeration within the schematic object class container.
`IEnumSchematicQueryParameter`	`getSchematicQueryParameters()` Schematic query parameters of the schematic object class.
`IEnumSchematicAlgorithm`	`getSchematicTraces()` Schematic analyst traces of the schematic diagram class.
`ISpatialReference`	`getSpatialReference()` The spatial reference of the GeoDataset.
`IEnumDataset`	`getSubsets()` Datasets contained within this dataset.
`int`	`getSubtypeFieldIndex()` The subtype field index.
`String`	`getSubtypeFieldName()` The subtype field name.
`String`	`getSubtypeName(int subtypeCode)` The subtype name.
`IEnumSubtype`	`getSubtypes()` The subtypes associated with the class.
`int`	`getType()` The type of the Dataset.
`IWorkspace`	`getWorkspace()` The workspace containing this dataset.
`ISchematicDiagram`	`gPGenerateDiagram(String diagramName, ISchematicDiagramContainer diagramContainer, IEnumGPValue enumGPValue, String builderOptions, ITrackCancel cancelTracker, IGPMessages messages)` Generates a new schematic diagram from an enum of GP values.
`void`	`gPUpdateDiagram(ISchematicDiagram diagram, IEnumGPValue enumGPValue, String builderOptions, ITrackCancel cancelTracker, IGPMessages messages)` Updates an existing diagram from an enum of GP values.
`int`	`hashCode()` the hashcode for this object
`ICursor`	`insert(boolean useBuffering)` Returns a cursor that can be used to insert new Rows.
`ISchematicBuilderRule`	`insertSchematicBuilderRule(int orderNumber)` Inserts a schematic builder rules at given order number within the builder rule container.
`boolean`	`isAlwaysLoadDiagrams()` Indicates if the diagrams which belong to the diagram class are always loaded.
`boolean`	`isBeingEdited()` True if the dataset is being edited.
`boolean`	`isCanAlterSpatialReference()` Indicates if the spatial reference of the dataset can be altered.
`boolean`	`isCanEdit()` True if the dataset supports edit sessions with the ability to discard edits on save.
`boolean`	`isCanEditMetadata()` Indicates if metadata can be edited.
`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.
`boolean`	`isSchematicElementClassAssociated(ISchematicElementClass schematicElementClass)` Indicates whether or not the element class is associated to the schematic diagram class.
`ICursor`	`ITable_search(IQueryFilter queryFilter, boolean recycling)` An object cursor that can be used to fetch row objects selected by the specified query.
`ISchematicInMemoryDiagram`	`loadSchematicInMemoryDiagram(String diagramName)` Loads a schematic in memory diagram specified by its DiagramName.
`void`	`moveSchematicBuilderRule(ISchematicBuilderRule schematicBuilderRule, int orderNumber)` Moves a schematic builder rules to given order number within the builder rule container.
`int`	`registerAsObjectClass(String suggestedOIDFieldName, String configKeyword)` Registers this class with the database, assigning it a class id and creating an object id column.
`void`	`rename(String name)` Renames this Dataset.
`int`	`rowCount(IQueryFilter queryFilter)` The number of Rows selected by the specified query.
`ISelectionSet`	`select(IQueryFilter queryFilter, int selType, int selOption, IWorkspace selectionContainer)` A selection that contains the object ids selected by the specified query.
`void`	`setAlwaysLoadDiagrams(boolean alwaysLoadDiagrams)` Indicates if the diagrams which belong to the diagram class are always loaded.
`void`	`setBrowseName(String name)` The browse name of the dataset.
`void`	`setDefaultSchematicNodeClass(ISchematicElementClass schematicElementClass)` Default schematic in memory node element class related to the schematic diagram class.
`void`	`setDefaultSubtypeCode(int subtypeCode)` The default subtype associated with the class.
`void`	`setDefaultValue(int subtypeCode, String fieldName, Object value)` The default value for the associated attribute.
`void`	`setDomainByRef(int subtypeCode, String fieldName, IDomain domain)` The domain given the subtype and field.
`void`	`setExternalQueryEvaluationMode(int externalQueryEvaluationMode)` External query evaluation mode of the schematic object class.
`void`	`setIdentifierFieldNames(Object names)` Identifier fields names of the schematic object class.
`void`	`setMetadata(IPropertySet ppPropertySet)` The PropertySet containing metadata.
`void`	`setModelName(String name)` The model name of the field.
`void`	`setName(String name)` Name of the schematic object class.
`void`	`setParentByRef(ISchematicDiagramClass parent)` Parent of the schematic diagram class.
`void`	`setQueryString(String queryString)` Query string of the schematic object class.
`void`	`setSchematicAlgorithmByRef(ISchematicAlgorithm schematicAlgorithm)` Schematic algorithm of the schematic diagram class.
`void`	`setSchematicAlgorithmsByRef(IEnumSchematicAlgorithm schematicAlgorithms)` Schematic algorithms of the schematic diagram class.
`void`	`setSchematicBuilderByRef(ISchematicBuilder schematicBuilder)` Schematic builder of the schematic diagram class.
`void`	`setSchematicDataSourceByRef(ISchematicDataSource schematicDataSource)` Schematic data source of the schematic object class.
`void`	`setSchematicLayerTemplate(ISchematicLayer schematicLayer)` Schematic layer template related to the schematic diagram class.
`void`	`setSchematicQueryParameters(IEnumSchematicQueryParameter queryParameters)` Schematic query parameters of the schematic object class.
`void`	`setSchematicTracesByRef(IEnumSchematicAlgorithm schematicAlgorithms)` Schematic analyst traces of the schematic diagram class.
`void`	`setSubtypeFieldName(String fieldName)` The subtype field name.
`void`	`synchronize(int action, int interval)` Updates metadata with the current properties; may create metadata if it doesn't already exist.
`ICursor`	`update(IQueryFilter queryFilter, boolean recycling)` Returns a cursor that can be used to update Rows selected by the specified query.
`void`	`updateDiagram(ISchematicDiagram diagram, IPropertySet propertySet, ISchematicBuilderContext context, ITrackCancel cancelTracker)` Refreshs an existing diagram implemented by the schematic diagram builder.
`void`	`updateSearchedRows(IQueryFilter queryFilter, IRowBuffer buffer)` Update the Rows in the database selected by the specified query.
`ISelectionSet`	`validate(IQueryFilter selection, IWorkspace workspace)` Validates the selection.
`ISelectionSet`	`validateSelection(ISelectionSet selection, IWorkspace workspace)` Validates the selection.
`ISet`	`validateSet(ISet selection)` Validates the set.

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
`getJintegraDispatch, release`

Constructor Detail

SchematicDiagramClass

public SchematicDiagramClass(Object obj)
                      throws IOException

Construct a SchematicDiagramClass using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to SchematicDiagramClass.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.

   * 
SchematicDiagramClass o = (SchematicDiagramClass)obj; // will not work 

 
SchematicDiagramClass o = new SchematicDiagramClass(obj); // Use this constructor instead

* @param obj an object returned from ArcGIS Engine or Server

Throws:: IOException - if there are interop problems SchematicDiagramClass theSchematicDiagramClass = (SchematicDiagramClass) obj;

Method Detail

equals

public boolean equals(Object o)

Compare this object with another

Overrides:: equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:: hashCode in class Object

getParent

public ISchematicDiagramClass getParent()
                                 throws IOException,
                                        AutomationException

Parent of the schematic diagram class.

Product Availability

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

Specified by:: getParent in interface ISchematicDiagramClass

Returns:: A reference to a com.esri.arcgis.schematic.ISchematicDiagramClass
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setParentByRef

public void setParentByRef(ISchematicDiagramClass parent)
                    throws IOException,
                           AutomationException

Parent of the schematic diagram class.

Product Availability

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

Specified by:: setParentByRef in interface ISchematicDiagramClass

Parameters:: parent - A reference to a com.esri.arcgis.schematic.ISchematicDiagramClass (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getAssociatedSchematicElementClasses

public IEnumSchematicElementClass getAssociatedSchematicElementClasses()
                                                                throws IOException,
                                                                       AutomationException

The associated element classes to the schematic diagram class.

Product Availability

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

Specified by:: getAssociatedSchematicElementClasses in interface ISchematicDiagramClass

Returns:: A reference to a com.esri.arcgis.schematic.IEnumSchematicElementClass
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

associateSchematicElementClass

public void associateSchematicElementClass(ISchematicElementClass schematicElementClass)
                                    throws IOException,
                                           AutomationException

Associates the element class to the schematic diagram class.

Product Availability

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

Specified by:: associateSchematicElementClass in interface ISchematicDiagramClass

Parameters:: schematicElementClass - A reference to a com.esri.arcgis.schematic.ISchematicElementClass (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

dissociateSchematicElementClass

public void dissociateSchematicElementClass(ISchematicElementClass schematicElementClass)
                                     throws IOException,
                                            AutomationException

Dissociates the element class from the schematic diagram class.

Product Availability

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

Specified by:: dissociateSchematicElementClass in interface ISchematicDiagramClass

Parameters:: schematicElementClass - A reference to a com.esri.arcgis.schematic.ISchematicElementClass (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isSchematicElementClassAssociated

public boolean isSchematicElementClassAssociated(ISchematicElementClass schematicElementClass)
                                          throws IOException,
                                                 AutomationException

Indicates whether or not the element class is associated to the schematic diagram class.

Product Availability

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

Specified by:: isSchematicElementClassAssociated in interface ISchematicDiagramClass

Parameters:: schematicElementClass - A reference to a com.esri.arcgis.schematic.ISchematicElementClass (in)
Returns:: The isAssociated
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSchematicBuilder

public ISchematicBuilder getSchematicBuilder()
                                      throws IOException,
                                             AutomationException

Schematic builder of the schematic diagram class.

Product Availability

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

Specified by:: getSchematicBuilder in interface ISchematicDiagramClass

Returns:: A reference to a com.esri.arcgis.schematic.ISchematicBuilder
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSchematicBuilderByRef

public void setSchematicBuilderByRef(ISchematicBuilder schematicBuilder)
                              throws IOException,
                                     AutomationException

Schematic builder of the schematic diagram class.

Product Availability

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

Specified by:: setSchematicBuilderByRef in interface ISchematicDiagramClass

Parameters:: schematicBuilder - A reference to a com.esri.arcgis.schematic.ISchematicBuilder (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSchematicAlgorithm

public ISchematicAlgorithm getSchematicAlgorithm()
                                          throws IOException,
                                                 AutomationException

Schematic algorithm of the schematic diagram class.

Product Availability

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

Specified by:: getSchematicAlgorithm in interface ISchematicDiagramClass

Returns:: A reference to a com.esri.arcgis.schematic.ISchematicAlgorithm
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSchematicAlgorithmByRef

public void setSchematicAlgorithmByRef(ISchematicAlgorithm schematicAlgorithm)
                                throws IOException,
                                       AutomationException

Schematic algorithm of the schematic diagram class.

Product Availability

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

Specified by:: setSchematicAlgorithmByRef in interface ISchematicDiagramClass

Parameters:: schematicAlgorithm - A reference to a com.esri.arcgis.schematic.ISchematicAlgorithm (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSchematicAlgorithms

public IEnumSchematicAlgorithm getSchematicAlgorithms()
                                               throws IOException,
                                                      AutomationException

Schematic algorithms of the schematic diagram class.

Product Availability

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

Specified by:: getSchematicAlgorithms in interface ISchematicDiagramClass

Returns:: A reference to a com.esri.arcgis.schematic.IEnumSchematicAlgorithm
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSchematicAlgorithmsByRef

public void setSchematicAlgorithmsByRef(IEnumSchematicAlgorithm schematicAlgorithms)
                                 throws IOException,
                                        AutomationException

Schematic algorithms of the schematic diagram class.

Product Availability

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

Specified by:: setSchematicAlgorithmsByRef in interface ISchematicDiagramClass

Parameters:: schematicAlgorithms - A reference to a com.esri.arcgis.schematic.IEnumSchematicAlgorithm (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSchematicTraces

public IEnumSchematicAlgorithm getSchematicTraces()
                                           throws IOException,
                                                  AutomationException

Schematic analyst traces of the schematic diagram class.

Product Availability

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

Specified by:: getSchematicTraces in interface ISchematicDiagramClass

Returns:: A reference to a com.esri.arcgis.schematic.IEnumSchematicAlgorithm
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSchematicTracesByRef

public void setSchematicTracesByRef(IEnumSchematicAlgorithm schematicAlgorithms)
                             throws IOException,
                                    AutomationException

Schematic analyst traces of the schematic diagram class.

Product Availability

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

Specified by:: setSchematicTracesByRef in interface ISchematicDiagramClass

Parameters:: schematicAlgorithms - A reference to a com.esri.arcgis.schematic.IEnumSchematicAlgorithm (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

loadSchematicInMemoryDiagram

public ISchematicInMemoryDiagram loadSchematicInMemoryDiagram(String diagramName)
                                                       throws IOException,
                                                              AutomationException

Loads a schematic in memory diagram specified by its DiagramName.

Product Availability

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

Specified by:: loadSchematicInMemoryDiagram in interface ISchematicDiagramClass

Parameters:: diagramName - The diagramName (in)
Returns:: A reference to a com.esri.arcgis.schematic.ISchematicInMemoryDiagram
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isAlwaysLoadDiagrams

public boolean isAlwaysLoadDiagrams()
                             throws IOException,
                                    AutomationException

Indicates if the diagrams which belong to the diagram class are always loaded.

Product Availability

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

Specified by:: isAlwaysLoadDiagrams in interface ISchematicDiagramClass

Returns:: The alwaysLoadDiagrams
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setAlwaysLoadDiagrams

public void setAlwaysLoadDiagrams(boolean alwaysLoadDiagrams)
                           throws IOException,
                                  AutomationException

Indicates if the diagrams which belong to the diagram class are always loaded.

Product Availability

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

Specified by:: setAlwaysLoadDiagrams in interface ISchematicDiagramClass

Parameters:: alwaysLoadDiagrams - The alwaysLoadDiagrams (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSchematicLayerTemplate

public void setSchematicLayerTemplate(ISchematicLayer schematicLayer)
                               throws IOException,
                                      AutomationException

Schematic layer template related to the schematic diagram class.

Product Availability

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

Specified by:: setSchematicLayerTemplate in interface ISchematicDiagramClass

Parameters:: schematicLayer - A reference to a com.esri.arcgis.schematic.ISchematicLayer (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSchematicLayerTemplate

public ISchematicLayer getSchematicLayerTemplate()
                                          throws IOException,
                                                 AutomationException

Schematic layer template related to the schematic diagram class.

Product Availability

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

Specified by:: getSchematicLayerTemplate in interface ISchematicDiagramClass

Returns:: A reference to a com.esri.arcgis.schematic.ISchematicLayer
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setDefaultSchematicNodeClass

public void setDefaultSchematicNodeClass(ISchematicElementClass schematicElementClass)
                                  throws IOException,
                                         AutomationException

Default schematic in memory node element class related to the schematic diagram class.

Product Availability

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

Specified by:: setDefaultSchematicNodeClass in interface ISchematicDiagramClass

Parameters:: schematicElementClass - A reference to a com.esri.arcgis.schematic.ISchematicElementClass (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDefaultSchematicNodeClass

public ISchematicElementClass getDefaultSchematicNodeClass()
                                                    throws IOException,
                                                           AutomationException

Default schematic in memory node element class related to the schematic diagram class.

Product Availability

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

Specified by:: getDefaultSchematicNodeClass in interface ISchematicDiagramClass

Returns:: A reference to a com.esri.arcgis.schematic.ISchematicElementClass
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

createSchematicDiagram

public ISchematicDiagram createSchematicDiagram(String name,
                                                ISchematicDiagramContainer diagramContainer)
                                         throws IOException,
                                                AutomationException

Creates a new schematic diagram.

Product Availability

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

Specified by:: createSchematicDiagram in interface ISchematicDiagramClass

Parameters:: name - The name (in); diagramContainer - A reference to a com.esri.arcgis.schematic.ISchematicDiagramContainer (in, optional, pass 0 if not required)
Returns:: A reference to a com.esri.arcgis.schematic.ISchematicDiagram
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSchematicDiagrams

public IEnumSchematicDiagram getSchematicDiagrams()
                                           throws IOException,
                                                  AutomationException

Schematic diagrams enumeration within the schematic dataset or schematic folder container.

Product Availability

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

Specified by:: getSchematicDiagrams in interface ISchematicDiagramClass

Returns:: A reference to a com.esri.arcgis.schematic.IEnumSchematicDiagram
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSchematicDiagramByID

public ISchematicDiagram getSchematicDiagramByID(int iD)
                                          throws IOException,
                                                 AutomationException

Schematic diagram referenced by the specified ID.

Product Availability

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

Specified by:: getSchematicDiagramByID in interface ISchematicDiagramClass

Parameters:: iD - The iD (in)
Returns:: A reference to a com.esri.arcgis.schematic.ISchematicDiagram
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSchematicDiagramByName

public ISchematicDiagram getSchematicDiagramByName(String name)
                                            throws IOException,
                                                   AutomationException

Schematic diagram referenced by the specified Name.

Product Availability

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

Specified by:: getSchematicDiagramByName in interface ISchematicDiagramClass

Parameters:: name - The name (in)
Returns:: A reference to a com.esri.arcgis.schematic.ISchematicDiagram
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

Name of the schematic object class.

Product Availability

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

Specified by:: getName in interface IDataset
Specified by:: getName in interface ISchematicObjectClass

Returns:: The name
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String name)
             throws IOException,
                    AutomationException

Name of the schematic object class.

Product Availability

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

Specified by:: setName in interface ISchematicObjectClass

Parameters:: name - The name (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSchematicDataset

public ISchematicDataset getSchematicDataset()
                                      throws IOException,
                                             AutomationException

Schematic dataset the schematic object class belongs to.

Product Availability

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

Specified by:: getSchematicDataset in interface ISchematicObjectClass

Returns:: A reference to a com.esri.arcgis.schematic.ISchematicDataset
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSchematicQueryParameters

public IEnumSchematicQueryParameter getSchematicQueryParameters()
                                                         throws IOException,
                                                                AutomationException

Schematic query parameters of the schematic object class.

Product Availability

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

Specified by:: getSchematicQueryParameters in interface ISchematicObjectClass

Returns:: A reference to a com.esri.arcgis.schematic.IEnumSchematicQueryParameter
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSchematicQueryParameters

public void setSchematicQueryParameters(IEnumSchematicQueryParameter queryParameters)
                                 throws IOException,
                                        AutomationException

Schematic query parameters of the schematic object class.

Product Availability

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

Specified by:: setSchematicQueryParameters in interface ISchematicObjectClass

Parameters:: queryParameters - A reference to a com.esri.arcgis.schematic.IEnumSchematicQueryParameter (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getQueryString

public String getQueryString()
                      throws IOException,
                             AutomationException

Query string of the schematic object class.

Product Availability

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

Specified by:: getQueryString in interface ISchematicObjectClass

Returns:: The queryString
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setQueryString

public void setQueryString(String queryString)
                    throws IOException,
                           AutomationException

Query string of the schematic object class.

Product Availability

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

Specified by:: setQueryString in interface ISchematicObjectClass

Parameters:: queryString - The queryString (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getIdentifierFieldNames

public Object getIdentifierFieldNames()
                               throws IOException,
                                      AutomationException

Identifier fields names of the schematic object class.

Product Availability

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

Specified by:: getIdentifierFieldNames in interface ISchematicObjectClass

Returns:: A Variant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setIdentifierFieldNames

public void setIdentifierFieldNames(Object names)
                             throws IOException,
                                    AutomationException

Identifier fields names of the schematic object class.

Product Availability

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

Specified by:: setIdentifierFieldNames in interface ISchematicObjectClass

Parameters:: names - A Variant (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSchematicDataSource

public ISchematicDataSource getSchematicDataSource()
                                            throws IOException,
                                                   AutomationException

Schematic data source of the schematic object class.

Product Availability

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

Specified by:: getSchematicDataSource in interface ISchematicObjectClass

Returns:: A reference to a com.esri.arcgis.schematic.ISchematicDataSource
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSchematicDataSourceByRef

public void setSchematicDataSourceByRef(ISchematicDataSource schematicDataSource)
                                 throws IOException,
                                        AutomationException

Schematic data source of the schematic object class.

Product Availability

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

Specified by:: setSchematicDataSourceByRef in interface ISchematicObjectClass

Parameters:: schematicDataSource - A reference to a com.esri.arcgis.schematic.ISchematicDataSource (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

delete

public void delete(boolean deleteDescendants)
            throws IOException,
                   AutomationException

Deletes the schematic object class.

Product Availability

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

Specified by:: delete in interface ISchematicObjectClass

Parameters:: deleteDescendants - The deleteDescendants (in, optional, pass true if not required)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

createSchematicAttribute

public ISchematicAttribute createSchematicAttribute(String name,
                                                    IUID uID)
                                             throws IOException,
                                                    AutomationException

Creates a schematic in memory attribute.

Product Availability

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

Specified by:: createSchematicAttribute in interface ISchematicObjectClass

Parameters:: name - The name (in); uID - A reference to a com.esri.arcgis.system.IUID (in)
Returns:: A reference to a com.esri.arcgis.schematic.ISchematicAttribute
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getPredefinedAttributeNames

public String[] getPredefinedAttributeNames()
                                     throws IOException,
                                            AutomationException

Predefined attributes names of the schematic in memory object class.

Product Availability

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

Specified by:: getPredefinedAttributeNames in interface ISchematicObjectClass

Returns:: The names
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setExternalQueryEvaluationMode

public void setExternalQueryEvaluationMode(int externalQueryEvaluationMode)
                                    throws IOException,
                                           AutomationException

External query evaluation mode of the schematic object class.

Product Availability

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

Specified by:: setExternalQueryEvaluationMode in interface ISchematicObjectClass

Parameters:: externalQueryEvaluationMode - A com.esri.arcgis.schematic.esriSchematicExternalQueryEvaluationMode constant (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getExternalQueryEvaluationMode

public int getExternalQueryEvaluationMode()
                                   throws IOException,
                                          AutomationException

External query evaluation mode of the schematic object class.

Product Availability

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

Specified by:: getExternalQueryEvaluationMode in interface ISchematicObjectClass

Returns:: A com.esri.arcgis.schematic.esriSchematicExternalQueryEvaluationMode constant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getFullName

public IName getFullName()
                  throws IOException,
                         AutomationException

The associated name object.

Remarks

The FullName property returns a Name object for the dataset. The Name object can be persisted and provides a way to get back to the dataset in a future session of the application, via the Open method on the Name object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getFullName in interface IDataset

Returns:: A reference to a com.esri.arcgis.system.IName
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getBrowseName

public String getBrowseName()
                     throws IOException,
                            AutomationException

The browse name of the dataset.

Remarks

BrowseName returns file names without their extension. For example, States.shp would appear as States.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getBrowseName in interface IDataset

Returns:: The name
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setBrowseName

public void setBrowseName(String name)
                   throws IOException,
                          AutomationException

The browse name of the dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setBrowseName in interface IDataset

Parameters:: name - The name (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getType

public int getType()
            throws IOException,
                   AutomationException

The type of the Dataset.

Remarks

The Type property returns the an esriDatasetType value indicating the dataset type, such as esriDTTable or esriDTFeatureClass.

Example:


// Assume we have a reference to an IfeatureClass (pFeatureClass)

      IDataset pDataset = null;


      pDataset = new IDatasetProxy(pFeatureClass);


      System.out.println(pDataset.getName() + " " + pDataset.getType());


      if(pFeatureClass != null){


        pDataset = pFeatureClass.getFeatureDataset();


        System.out.println(pDataset.getName() + " " + pDataset.getType());


      }


      pDataset = new IDatasetProxy(pDataset.getWorkspace());


     System.out.println(pDataset.getName() + " " + 
pDataset.getType());

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getType in interface IDataset

Returns:: A com.esri.arcgis.geodatabase.esriDatasetType constant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getCategory

public String getCategory()
                   throws IOException,
                          AutomationException

The category of the dataset.

Remarks

IDataset::Category returns a description of the category of the dataset. The description returned from the Category property is the same value that is displayed in the Type column within the Contents tab in ArcCatalog. The value will contain a description of the dataset such as "Topology" prefixed with a description of the type of workspace containing the dataset such as "File Geodatabase".

The description returned from IDataset::Category may change between releases of ArcGIS. In addition to this, returned strings are localized, meaning that code relying on a specific string being provided may fail when deployed with a different version of ArcGIS than it was developed with, or when deployed to a client using a different language than it was developed with.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getCategory in interface IDataset

Returns:: The category
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSubsets

public IEnumDataset getSubsets()
                        throws IOException,
                               AutomationException

Datasets contained within this dataset.

Description

The Subsets property returns other Dataset objects contained in this dataset.

Remarks

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSubsets in interface IDataset

Returns:: A reference to a com.esri.arcgis.geodatabase.IEnumDataset
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getWorkspace

public IWorkspace getWorkspace()
                        throws IOException,
                               AutomationException

The workspace containing this dataset.

Description

The Workspace property returns the containing workspace for this dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getWorkspace in interface IDataset

Returns:: A reference to a com.esri.arcgis.geodatabase.IWorkspace
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getPropertySet

public IPropertySet getPropertySet()
                            throws IOException,
                                   AutomationException

The set of properties for the dataset.

Description

The PropertySet property is used to return any additional intrinsic properties (but not metadata properties) that may apply to the dataset. One use of this property is to distinguish between the types of File Geodatabase datafile formats. If called on a Feature Class or Table in a File Geodatabase the Datafile Format property can either be esriFGDBStandardDatafile or esriFGDBCompressedDatafile.

Most datasets do not implement this property and will either raise an error or return a null value if it's called. There are a handful of exceptions that will return property sets; these include the datasets from file geodatabases (as mentioned above) and coverages.

Remarks

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getPropertySet in interface IDataset

Returns:: A reference to a com.esri.arcgis.system.IPropertySet
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

canCopy

public boolean canCopy()
                throws IOException,
                       AutomationException

True if this dataset can be copied.

Remarks

The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods. For example, you may not delete a network feature class nor can you use the Copy method on a Geodatabase feature class. To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.

The CanCopy method is supported by:

CAD Drawings
Coverages
DBase Tables
Info Tables
Raster Datasets
SDC datasets
SDC Network Datasets
Shapefiles
Shapefile Network Datasets

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: canCopy in interface IDataset

Returns:: The canCopy
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

copy

public IDataset copy(String copyName,
                     IWorkspace copyWorkspace)
              throws IOException,
                     AutomationException

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

Remarks

IDataset::Copy should only be used with datasets from file-based data sources, such as shapefiles and coverages.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: copy in interface IDataset

Parameters:: copyName - The copyName (in); copyWorkspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
Returns:: A reference to a com.esri.arcgis.geodatabase.IDataset
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

canDelete

public boolean canDelete()
                  throws IOException,
                         AutomationException

True if this dataset can be deleted.

Remarks

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: canDelete in interface IDataset

Returns:: The canDelete
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

delete

public void delete()
            throws IOException,
                   AutomationException

Deletes this dataset.

Remarks

Certain feature classes, such as network and topology feature classes, cannot be deleted until their containing objects are deleted.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: delete in interface IDataset

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

canRename

public boolean canRename()
                  throws IOException,
                         AutomationException

True if this dataset can be renamed.

Remarks

The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods. For example, you may not delete or rename a network feature class nor can you use the Copy method on a Geodatabase feature class. To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: canRename in interface IDataset

Returns:: The canRename
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

rename

public void rename(String name)
            throws IOException,
                   AutomationException

Renames this Dataset.

Remarks

IDataset::Rename does not support the renaming of Graph objects such as a Geometric Network. In addition, certain feature classes, such as network feature classes, cannot be renamed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: rename in interface IDataset

Parameters:: name - The name (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isBeingEdited

public boolean isBeingEdited()
                      throws IOException,
                             AutomationException

True if the dataset is being edited.

Remarks

Once an edit session has been started on a workspace, the IsBeingEdited method on the IDatasetEdit interface can be used to determine if a particular dataset is participating in the edit session.

The reasons why a dataset may not participate include the connected user has no privileges or permission to edit the dataset, the connected user is not licensed to edit this type of dataset, or the dataset is not versioned but a versioned edit session has been started (or vice versa).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isBeingEdited in interface IDatasetEdit

Returns:: The pIsBeingEdited
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isCanEdit

public boolean isCanEdit()
                  throws IOException,
                         AutomationException

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

Remarks



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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isCanEdit in interface IDatasetEditInfo

Returns:: The pCanEdit
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isCanUndo

public boolean isCanUndo()
                  throws IOException,
                         AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isCanUndo in interface IDatasetEditInfo

Returns:: The pCanUndo
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isCanRedo

public boolean isCanRedo()
                  throws IOException,
                         AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isCanRedo in interface IDatasetEditInfo

Returns:: The pCanUndo
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

findField

public int findField(String name)
              throws IOException,
                     AutomationException

The index of the field with the specified name.

Remarks

If FindField returns -1, the Field could not be found in the Fields collection.

Developers working with SDE should be aware of qualified field names and their impact on calls to FindField. For more information, see the IFields2 interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: findField in interface IClass

Parameters:: name - The name (in)
Returns:: The fieldIndex
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getFields

public IFields getFields()
                  throws IOException,
                         AutomationException

The fields collection for this object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getFields in interface IClass

Returns:: A reference to a com.esri.arcgis.geodatabase.IFields
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getIndexes

public IIndexes getIndexes()
                    throws IOException,
                           AutomationException

The indexes collection for this object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getIndexes in interface IClass

Returns:: A reference to a com.esri.arcgis.geodatabase.IIndexes
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

addField

public void addField(IField field)
              throws IOException,
                     AutomationException

Adds a field to this object class.

Remarks

Prior to adding a new field to a class, an exclusive schema lock should be obtained using the ISchemaLock interface.

Attempting to add a new field that does not allow null values will fail, if the class already has data in it. The only solution is to recreate the class with the non-nullable field, then copy the rows from the original class into the new class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: addField in interface IClass

Parameters:: field - A reference to a com.esri.arcgis.geodatabase.IField (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

deleteField

public void deleteField(IField field)
                 throws IOException,
                        AutomationException

Deletes a field from this object class.

Remarks

DeleteField removes the specified field from a table, object class or feature class. Fields that are required by the Geodatabase and cannot be removed include:

OBJECTID field
SHAPE and shape dependent fields such as SHAPE_Length
Enabled, AncillaryRole and Weight field for network feature classes
Subtype fields. In order to delete a subtype field, it must first be removed as the subtype field, see the help on ISubtypes::SubtypeFieldName

Prior to deleting a field from a class, an exclusive schema lock should be obtained using the ISchemaLock interface.

Example:

// Assume we have a reference to a FeatureClass (pFC)

      IFields pFields;

      IField pField;



      pFields = pFC.getFields();

      pField = pFields.getField(pFields.findField("MyField"));



      pFC.deleteField(pField);

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: deleteField in interface IClass

Parameters:: field - A reference to a com.esri.arcgis.geodatabase.IField (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

addIndex

public void addIndex(IIndex index)
              throws IOException,
                     AutomationException

Adds an index to this object class.

Remarks

Prior to adding a new index to a class, an exclusive schema lock should be obtained using the ISchemaLock interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: addIndex in interface IClass

Parameters:: index - A reference to a com.esri.arcgis.geodatabase.IIndex (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

deleteIndex

public void deleteIndex(IIndex index)
                 throws IOException,
                        AutomationException

Deletes an index from this object class.

Remarks

Prior to deleting an index from a class, an exclusive schema lock should be obtained using the ISchemaLock interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: deleteIndex in interface IClass

Parameters:: index - A reference to a com.esri.arcgis.geodatabase.IIndex (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isHasOID

public boolean isHasOID()
                 throws IOException,
                        AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isHasOID in interface IClass

Returns:: The hasOID
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getOIDFieldName

public String getOIDFieldName()
                       throws IOException,
                              AutomationException

The name of the field corresponding to the OID.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getOIDFieldName in interface IClass

Returns:: The name
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getCLSID

public IUID getCLSID()
              throws IOException,
                     AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getCLSID in interface IClass

Returns:: A reference to a com.esri.arcgis.system.IUID
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getEXTCLSID

public IUID getEXTCLSID()
                 throws IOException,
                        AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getEXTCLSID in interface IClass

Returns:: A reference to a com.esri.arcgis.system.IUID
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getExtension

public Object getExtension()
                    throws IOException,
                           AutomationException

The extension for this object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getExtension in interface IClass

Returns:: A reference to another Object (IUnknown)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getExtensionProperties

public IPropertySet getExtensionProperties()
                                    throws IOException,
                                           AutomationException

The extension properties for this object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getExtensionProperties in interface IClass

Returns:: A reference to a com.esri.arcgis.system.IPropertySet
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

registerAsObjectClass

public int registerAsObjectClass(String suggestedOIDFieldName,
                                 String configKeyword)
                          throws IOException,
                                 AutomationException

Registers this class with the database, assigning it a class id and creating an object id column.

Description

The RegisterAsObjectClass method will register a table or feature class (ArcSDE layer) in the database with the Geodatabase. The act of registering the data as an object class will create records for the object class in the Geodatabase system tables and assign the object class a unique ID. Once a table or SDE layer is registered as an object class, it can participate in rules, topological relationships and relationships.

When registering a table or ArcSDE layer as an object class, an ObjectID field must be added to it. This field will contain the object IDs which uniquely identify each feature in the class. The object IDs for existing data will automatically be generated. Once a table or ArcSDE layer has been registered as an object class in the Geodatabase, it cannot be unregistered.

RegisterAsObjectClass takes two arguments: the name of the object ID field, and the ArcSDE configuration keyword to use for storage of the new data that is inserted into the object ID field. RegisterAsObjectClass returns a long which is the object class ID assigned to the newly registered class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: registerAsObjectClass in interface IClassSchemaEdit

Parameters:: suggestedOIDFieldName - The suggestedOIDFieldName (in); configKeyword - The configKeyword (in)
Returns:: The objectClassID
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IObjectClass

alterInstanceCLSID

public void alterInstanceCLSID(IUID instanceCLSID)
                        throws IOException,
                               AutomationException

Changes the instance COM class associated with this database class.

Description

The AlterInstanceCLSID is used to change the behavior class for an object class in the Geodatabase. For example, you may have a class that stores simple feature objects and you want to change it to implement a custom object that you have developed. You use the AlterInstanceCLSID to do so.

Remarks

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: alterInstanceCLSID in interface IClassSchemaEdit

Parameters:: instanceCLSID - A reference to a com.esri.arcgis.system.IUID (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

alterClassExtensionCLSID

public void alterClassExtensionCLSID(IUID classExtensionCLSID,
                                     IPropertySet classExtensionProperties)
                              throws IOException,
                                     AutomationException

Changes the class extension COM class associated with this database class.

Description

The AlterClassExtensionCLSID method is used to change the class extension for an object class in the Geodatabase. For example, you may have a class to which you want to associate a class extension that you have developed. You use the AlterClassExtensionCLSID to do so.

Remarks

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: alterClassExtensionCLSID in interface IClassSchemaEdit

Parameters:: classExtensionCLSID - A reference to a com.esri.arcgis.system.IUID (in); classExtensionProperties - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

alterAliasName

public void alterAliasName(String name)
                    throws IOException,
                           AutomationException

The alias name of the object class.

Description

Alters the alias name for the object class.

Remarks

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: alterAliasName in interface IClassSchemaEdit

Parameters:: name - The name (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IObjectClass

alterFieldAliasName

public void alterFieldAliasName(String fieldName,
                                String aliasName)
                         throws IOException,
                                AutomationException

The alias name of the object class field.

Description

Alters the alias name for a field in the object class.

Remarks

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: alterFieldAliasName in interface IClassSchemaEdit

Parameters:: fieldName - The fieldName (in); aliasName - The aliasName (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IField

alterModelName

public void alterModelName(String name)
                    throws IOException,
                           AutomationException

The model name of the object class.

Description

Alters the model name for the object class.

Remarks

The AlterModelName method sets the model name for the object class. The model name can be returned using the IModelInfo interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: alterModelName in interface IClassSchemaEdit

Parameters:: name - The name (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

alterFieldModelName

public void alterFieldModelName(String fieldName,
                                String modelName)
                         throws IOException,
                                AutomationException

The model name of the object class field.

Description

Alters the model name for a field in the object class.

Remarks

The AlterFieldModelName method sets the model name for a field in the object class. The model name can be returned using the IModelInfo interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: alterFieldModelName in interface IClassSchemaEdit

Parameters:: fieldName - The fieldName (in); modelName - The modelName (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IField

alterDomain

public void alterDomain(String fieldName,
                        IDomain domain)
                 throws IOException,
                        AutomationException

The default domain of the object class field.

Remarks

Domains are used in the Geodatabase to validate the contents of fields in an object class. For example, you can use a domain to specify a valid range of values, or a valid set of values for a particular field in an object class. You can assign domains to a field in an object class at either the class level, or the subtype level. The AlterDomain method on IClassSchemaEdit allows you to set a domain for a field at the class level.

AlterDomain takes as arguments the name of the field you want to associate a domain with as a string, and the domain you are associating as an IDomain. You can get an enumeration of domains in a workspace by calling the Domains or DomainsByFieldType methods on the IWorkspaceDomains interface.

Once a domain is associated with a field in your object class, the values in that field will be validated against that domain when a row in the object class is validated with the IValidate interface, or the Validate Selection command in the Editor.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: alterDomain in interface IClassSchemaEdit

Parameters:: fieldName - The fieldName (in); domain - A reference to a com.esri.arcgis.geodatabase.IDomain (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IField

alterDefaultValue

public void alterDefaultValue(String fieldName,
                              Object value)
                       throws IOException,
                              AutomationException

The default value of the object class field.

Remarks

You can assign a default value to a field in an object class at either the class level, or the subtype level. The AlterDefaultValue method on IClassSchemaEdit allows you to set a default value for a field at the class level.

AlterDefaultValue takes as arguments the name of the field you want to associate a default value with as a string, and the default value you are associating as a variant. AlterDefaultValue will fail if the default value cannot be stored in the field.

Once a default value is associated with a field in your object class, you can use the InitDefaultValues method on IRowSubtypes to populate the fields in a object in your object class with its default value. This method is most often called after you have created a new feature or object in the object class, and before storing it.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: alterDefaultValue in interface IClassSchemaEdit

Parameters:: fieldName - The fieldName (in); value - A Variant (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IField

alterClassExtensionProperties

public void alterClassExtensionProperties(IPropertySet classExtensionProperties)
                                   throws IOException,
                                          AutomationException

Changes the class extension properties associated with this object class.

Description

The AlterClassExtensionProperties method is used to change the class extension properties for an object class in the Geodatabase that already has a class extension associated with it.

Remarks

AlterClassExtensionProperties takes as an argument the new properties for the class extension as an IPropertySet.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: alterClassExtensionProperties in interface IClassSchemaEdit2

Parameters:: classExtensionProperties - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IPropertySet

createRow

public IRow createRow()
               throws IOException,
                      AutomationException

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

Remarks

The CreateRow method creates a new row in the underlying database with a system assigned object id value. A row object representing the created row is returned to the caller. The row object returned has the system assigned object ID as the value of the OIDField. All other fields are initialized to null values if they can be made null and to built-in default values appropriate to the type of the field if they cannot be made null.

The caller is responsible for setting the desired field values into the row and calling the Store method on the row. If the table represents an object class with subtypes, then it is the caller�s responsibility to set the default subtype code into the row and call the InitDefaultValues method on the row before storing, if that is the desired result. For tables without object behavior, insert cursors offer a more efficient way for inserting new rows.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: createRow in interface ITable

Returns:: A reference to a com.esri.arcgis.geodatabase.IRow
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getRow

public IRow getRow(int oID)
            throws IOException,
                   AutomationException

The row from the database with the specified object ID.

Remarks

The GetRow method returns an existing row object, given its object ID value. The caller can query the returned row object for additional object specific interfaces. The retrieved row may be modified; calling Store on the row object after changing it will trigger messages to related objects and will mark the row for committing to the database.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getRow in interface ITable

Parameters:: oID - The oID (in)
Returns:: A reference to a com.esri.arcgis.geodatabase.IRow
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getRows

public ICursor getRows(Object oids,
                       boolean recycling)
                throws IOException,
                       AutomationException

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

Remarks

The GetRows method returns a cursor that may be used to retrieve a set of rows specified by the input array of object id values. See the description of the Search method to understand the meaning of the recycling parameter. It is far more efficient to retrieve a set of rows using the GetRows method than it is to retrieve each individual row using the GetRow method. The retrieved rows may be modified; Store should be called on the row objects after changing them.

The oids parameter should be passed an integer array. For example:

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

// Get a recycling cursor for the OID array.

int[] oids = new int[] { 10844, 10853, 10871 };

ICursor cursor = table.getRows(oids, true);

Specified by:: getRows in interface ITable

Parameters:: oids - A Variant (in); recycling - The recycling (in)
Returns:: A reference to a com.esri.arcgis.geodatabase.ICursor
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

createRowBuffer

public IRowBuffer createRowBuffer()
                           throws IOException,
                                  AutomationException

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

Remarks

The CreateRowBuffer method creates a new row buffer object in memory and returns it to the caller. No row is created in the database. The returned row buffer does not have an object ID value. The caller can set values into the row buffer and use it as an argument to the InsertRow method on an insert cursor; the latter is obtained by calling the Insert method on the Table.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: createRowBuffer in interface ITable

Returns:: A reference to a com.esri.arcgis.geodatabase.IRowBuffer
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

updateSearchedRows

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

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

Description

This method will edit the rows matching the query filter's constraints. The values in each row will be replaced with the corresponding field's value in the provided row buffer. The fields being edited should be specified in the query filter's SubFields property. If the row buffer contains null values, and the SubFields property is not properly set, the row's values will be overwritten with the row buffer's null values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: updateSearchedRows in interface ITable

Parameters:: queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in); buffer - A reference to a com.esri.arcgis.geodatabase.IRowBuffer (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

deleteSearchedRows

public void deleteSearchedRows(IQueryFilter queryFilter)
                        throws IOException,
                               AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: deleteSearchedRows in interface ITable

Parameters:: queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

rowCount

public int rowCount(IQueryFilter queryFilter)
             throws IOException,
                    AutomationException

The number of Rows selected by the specified query.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: rowCount in interface ITable

Parameters:: queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
Returns:: The numRows
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

ITable_search

public ICursor ITable_search(IQueryFilter queryFilter,
                             boolean recycling)
                      throws IOException,
                             AutomationException

An object cursor that can be used to fetch row objects selected by the specified query.

Product Availability

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

Specified by:: ITable_search in interface ITable

Parameters:: queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in); recycling - The recycling (in)
Returns:: A reference to a com.esri.arcgis.geodatabase.ICursor
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

update

public ICursor update(IQueryFilter queryFilter,
                      boolean recycling)
               throws IOException,
                      AutomationException

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

Remarks

The Update method returns an update cursor that can be used to update or delete rows. It offers somewhat faster performance than multiple calls to Store or Delete on row objects fetched using a non-recycling search cursor for tables storing simple rows and simple features. There is no difference in performance for complex objects and features.

When using cursors within an edit session, they should always be scoped to edit operations. In other words, a cursor should be created after an edit operation has begun and should not be used once that edit operation has been stopped or aborted.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: update in interface ITable

Parameters:: queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in); recycling - The recycling (in)
Returns:: A reference to a com.esri.arcgis.geodatabase.ICursor
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

insert

public ICursor insert(boolean useBuffering)
               throws IOException,
                      AutomationException

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

Remarks

The Insert method returns an insert cursor that can be used to bulk insert rows. It offers significantly faster performance than multiple calls to CreateRow and Store for tables storing simple rows and simple features (that is, for tables whose CLSID is esriGeoDatabase.Row, esriGeoDatabase.Object, or esriGeoDatabase.Feature).

Insert cursors on tables containing complex objects use the CreateRow and Store methods to achieve polymorphism, and there is no difference in performance in these cases.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: insert in interface ITable

Parameters:: useBuffering - The useBuffering (in)
Returns:: A reference to a com.esri.arcgis.geodatabase.ICursor
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

select

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

A selection that contains the object ids selected by the specified query.

Remarks

The Select method returns a selection set that holds either row IDs or row objects from the Table depending on the selection option. Multiple selection sets can be created on the same table. It is up to a client application or object to keep a reference on created selections and use them as appropriate. For example, a FeatureLayer creates and uses selections on a FeatureClass (a type of Table).

The selType parameter determines the type of selection set that will be created: an ID set, a snapshot, or a hybrid. See the ISelectionSet interface for a comparison of the three types.

When calling Select the selectionContainer parameter is no longer required. A null value should be passed as this parameter.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: select in interface ITable

Parameters:: queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in); selType - A com.esri.arcgis.geodatabase.esriSelectionType constant (in); selOption - A com.esri.arcgis.geodatabase.esriSelectionOption constant (in); selectionContainer - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
Returns:: A reference to a com.esri.arcgis.geodatabase.ISelectionSet
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isCanSelect

public boolean isCanSelect()
                    throws IOException,
                           AutomationException

Indicates if the table supports selection.

Remarks

Use CanSelect to determine if you can open a selection set on the table. A situation where CanSelect will be False is a standalone database table without an OID column.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isCanSelect in interface ITableCapabilities

Returns:: The canSelect
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getModelName

public String getModelName()
                    throws IOException,
                           AutomationException

The model name of the field.

Remarks

Returns the model name currently associated with the field or object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getModelName in interface IModelInfo

Returns:: The name
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IObjectClass, IField

setModelName

public void setModelName(String name)
                  throws IOException,
                         AutomationException

The model name of the field.

Remarks

Sets the model name for the field or object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setModelName in interface IModelInfo

Parameters:: name - The name (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IObjectClass, IField

changeSchemaLock

public void changeSchemaLock(int schemaLock)
                      throws IOException,
                             AutomationException

Changes a schema lock.

Remarks

There are two kinds of schema locks: shared and exclusive. Shared schema locks are applied automatically by the geodatabase when accessing a dataset and are removed when all references to the dataset are removed. For this reason, it's not necessary to explicitly apply or remove shared schema locks. There is no limit to the number of shared schema locks a dataset or object can have at any given time.

In contrast to shared schema locks, exclusive schema locks are controlled by the developer or ArcGIS application, such as ArcMap or ArcCatalog. An exclusive lock is used to lock a geodatabase dataset or object from use by others to make the necessary changes to it. An exclusive lock is promoted from a shared lock and demoted back to a shared lock when no longer needed. The presence of additional shared schema locks on a dataset or object prevents an exclusive schema lock from being applied and precludes the ability to make changes to the underlying dataset and its schema while it is in use. Only one exclusive schema lock is allowed per dataset. As opposed to shared schema locks, exclusive schema locks are not applied or removed automatically; it is the responsibility of the developer to apply or remove exclusive schema locks.

Limit the scope of exclusive schema locks to the operation that requires the lock. Gather the necessary information to perform the action, obtain the exclusive lock, make the change, and release the lock. Some examples of operations for which an exclusive schema lock should be obtained include:

Modifications to attribute domains, such as adding or removing values from a coded value domain or changing the range for range domains

Adding or deleting a field from a feature class or object class
Associating a class extension with a feature class
Creating a topology, geometric network, network dataset, terrain, schematic dataset, representation, or cadastral fabric on a set of feature classes
Any use of the IClassSchemaEdit interface
Putting a feature class into and taking it out of load-only mode with the IFeatureClassLoad.LoadOnlyMode method
Managing (creating, deleting, or modifying) spatial and attribute indexes

Once the action requiring an exclusive schema lock is complete, the exclusive schema lock must be demoted to a shared lock. This includes when errors are raised during the schema modification, for example, consider the case where a field is being deleted from a feature class. To delete the field, an exclusive schema lock is obtained. However, on the call to DeleteField, an error is thrown; that is, the field being deleted is a required field, such as the ObjectID field. In the handling of the error, the exclusive schema lock must be demoted to a shared lock before proceeding.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: changeSchemaLock in interface ISchemaLock

Parameters:: schemaLock - A com.esri.arcgis.geodatabase.esriSchemaLock constant (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getCurrentSchemaLocks

public void getCurrentSchemaLocks(IEnumSchemaLockInfo[] schemaLockInfo)
                           throws IOException,
                                  AutomationException

The list of current locks.

Remarks

The ISchemaLockInfo interface is used in concert with ISchemaLock to provide information about a schema lock, for example, whether it is shared or exclusive and for ArcSDE geodatabases, the name of the user who has the lock. Note that there will always be at least one schema lock on the dataset. Also note that by checking the schema locks on a dataset a shared schema lock is applied to the data.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getCurrentSchemaLocks in interface ISchemaLock

Parameters:: schemaLockInfo - A reference to a com.esri.arcgis.geodatabase.IEnumSchemaLockInfo (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getObjectClassID

public int getObjectClassID()
                     throws IOException,
                            AutomationException

The unique ID for the object class.

Description

Returns the unique ID of the object class.

Remarks

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getObjectClassID in interface IObjectClass

Returns:: The objectClassID
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getRelationshipClasses

public IEnumRelationshipClass getRelationshipClasses(int role)
                                              throws IOException,
                                                     AutomationException

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

Product Availability

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

Specified by:: getRelationshipClasses in interface IObjectClass

Parameters:: role - A com.esri.arcgis.geodatabase.esriRelRole constant (in)
Returns:: A reference to a com.esri.arcgis.geodatabase.IEnumRelationshipClass
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getAliasName

public String getAliasName()
                    throws IOException,
                           AutomationException

The alias name of the object class.

Description

Returns the alias name for the object class.

Remarks

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getAliasName in interface IObjectClass

Returns:: The name
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

canBypassStoreMethod

public boolean canBypassStoreMethod()
                             throws IOException,
                                    AutomationException

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

Remarks

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

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: canBypassStoreMethod in interface IObjectClassInfo
Specified by:: canBypassStoreMethod in interface IObjectClassInfo2

Returns:: The canBypassStore
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

canBypassEditSession

public boolean canBypassEditSession()
                             throws IOException,
                                    AutomationException

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

Remarks

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

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

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: canBypassEditSession in interface IObjectClassInfo2

Returns:: The canBypassEditSession
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isHasSubtype

public boolean isHasSubtype()
                     throws IOException,
                            AutomationException

Indicates if the table has subtypes.

Description

HasSubtype property returns a boolean value whether the given object class has subypes or not.

Remarks

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isHasSubtype in interface ISubtypes

Returns:: The hasSubtype
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDefaultSubtypeCode

public int getDefaultSubtypeCode()
                          throws IOException,
                                 AutomationException

The default subtype associated with the class.

Description

DefaultSubtypeCode property sets and returns the default subtype code for the given object class.

Remarks

This property sets or returns the value of the default subtype code for the associated class.

Example:


String aPath = "shape path";

String aName = "shape name";

IWorkspaceFactory shapefileFactory = new ShapefileWorkspaceFactory();

IFeatureWorkspace featureWorkspace = 

new IFeatureWorkspaceProxy(shapefileFactory.openFromFile(aPath,0));

IFeatureClass featureClass = 

new IFeatureClassProxy(featureWorkspace.openFeatureClass(aName));

ISubtypes pSubtypes = new ISubtypesProxy(featureClass);

long lDefCode = pSubtypes.getDefaultSubtypeCode();

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getDefaultSubtypeCode in interface ISubtypes

Returns:: The subtypeCode
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setDefaultSubtypeCode

public void setDefaultSubtypeCode(int subtypeCode)
                           throws IOException,
                                  AutomationException

The default subtype associated with the class.

Description

DefaultSubtypeCode property sets the default subtype code for the given object class.

Example:


String aPath = "shape path";

String aName = "shape name";

IWorkspaceFactory shapefileFactory = new ShapefileWorkspaceFactory();

IFeatureWorkspace featureWorkspace = 

new IFeatureWorkspaceProxy(shapefileFactory.openFromFile(aPath,0));

IFeatureClass featureClass = 

new IFeatureClassProxy(featureWorkspace.openFeatureClass(aName));

ISubtypes pSubtypes = new ISubtypesProxy(featureClass);

long lDefCode = pSubtypes.getDefaultSubtypeCode();

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setDefaultSubtypeCode in interface ISubtypes

Parameters:: subtypeCode - The subtypeCode (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDefaultValue

public Object getDefaultValue(int subtypeCode,
                              String fieldName)
                       throws IOException,
                              AutomationException

The default value for the associated attribute.

Product Availability

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

Specified by:: getDefaultValue in interface ISubtypes

Parameters:: subtypeCode - The subtypeCode (in); fieldName - The fieldName (in)
Returns:: A Variant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setDefaultValue

public void setDefaultValue(int subtypeCode,
                            String fieldName,
                            Object value)
                     throws IOException,
                            AutomationException

The default value for the associated attribute.

Product Availability

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

Specified by:: setDefaultValue in interface ISubtypes

Parameters:: subtypeCode - The subtypeCode (in); fieldName - The fieldName (in); value - A Variant (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDomain

public IDomain getDomain(int subtypeCode,
                         String fieldName)
                  throws IOException,
                         AutomationException

The domain given the subtype and field.

Product Availability

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

Specified by:: getDomain in interface ISubtypes

Parameters:: subtypeCode - The subtypeCode (in); fieldName - The fieldName (in)
Returns:: A reference to a com.esri.arcgis.geodatabase.IDomain
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setDomainByRef

public void setDomainByRef(int subtypeCode,
                           String fieldName,
                           IDomain domain)
                    throws IOException,
                           AutomationException

The domain given the subtype and field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setDomainByRef in interface ISubtypes

Parameters:: subtypeCode - The subtypeCode (in); fieldName - The fieldName (in); domain - A reference to a com.esri.arcgis.geodatabase.IDomain (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSubtypeFieldName

public String getSubtypeFieldName()
                           throws IOException,
                                  AutomationException

The subtype field name.

Remarks

The SubtypeFieldName property is used to either set or return string value for the field that contains the subtypes for this object class. To assign the subtype field, set SubtypeFieldName equal to the name of the field:

Example:

String aPath = "shape path";

String aName = "shape name";

IWorkspaceFactory shapefileFactory = new ShapefileWorkspaceFactory();

IFeatureWorkspace featureWorkspace = 

new IFeatureWorkspaceProxy(shapefileFactory.openFromFile(aPath,0));          

IFeatureClass featureClass = 

new FeatureClassProxy(featureWorkspace.openFeatureClass(aName));

ISubtypes pSubtypes = new ISubtypesProxy(featureClass);

pSubtypes.setSubtypeFieldName("TYPECODE"); 



//The  Subtype field can be  reset by assigning an  empty string to SubtypeFieldName:; 

pSubtypes.setSubtypeFieldName("");

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSubtypeFieldName in interface ISubtypes

Returns:: The fieldName
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSubtypeFieldName

public void setSubtypeFieldName(String fieldName)
                         throws IOException,
                                AutomationException

The subtype field name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setSubtypeFieldName in interface ISubtypes

Parameters:: fieldName - The fieldName (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSubtypeFieldIndex

public int getSubtypeFieldIndex()
                         throws IOException,
                                AutomationException

The subtype field index.

Description

SubtypeFieldIndex property returns the index of the subtype field.

Remarks

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.

Example:

String aPath = "shape path";

String aName = "shape name";

IWorkspaceFactory shapefileFactory = new ShapefileWorkspaceFactory();

IFeatureWorkspace featureWorkspace = 

new IFeatureWorkspaceProxy(shapefileFactory.openFromFile(aPath,0));

IFeatureClass featureClass = 

new IFeatureClassProxy(featureWorkspace.openFeatureClass(aName));

ISubtypes pSubtypes = new ISubtypesProxy(featureClass);

int subFldIndex = pSubtypes.getSubtypeFieldIndex();

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSubtypeFieldIndex in interface ISubtypes

Returns:: The index
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSubtypeName

public String getSubtypeName(int subtypeCode)
                      throws IOException,
                             AutomationException

The subtype name.

Product Availability

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

Specified by:: getSubtypeName in interface ISubtypes

Parameters:: subtypeCode - The subtypeCode (in)
Returns:: The subtypeName
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSubtypes

public IEnumSubtype getSubtypes()
                         throws IOException,
                                AutomationException

The subtypes associated with the class.

Description

Subtypes returns a IEnumSubtype populated with all of the subtypes for the given object class.

Remarks

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSubtypes in interface ISubtypes

Returns:: A reference to a com.esri.arcgis.geodatabase.IEnumSubtype
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

addSubtype

public void addSubtype(int subtypeCode,
                       String subtypeName)
                throws IOException,
                       AutomationException

Adds the subtype to the set of associated subtypes.

Description

AddSubtype adds the subtype to the set of subtypes for the given object class with the subtype code and subtype name given.

Remarks

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: addSubtype in interface ISubtypes

Parameters:: subtypeCode - The subtypeCode (in); subtypeName - The subtypeName (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

deleteSubtype

public void deleteSubtype(int subtypeCode)
                   throws IOException,
                          AutomationException

Deletes the subtype from the set of associated subtypes.

Description

DeleteSubtype takes the subtype code parameter to remove the subtype from the set of subtypes of the given object class.

Remarks

DeleteSubtype will delete a subtype for the associated object class. Calling DeleteSubtype will also remove any reference to that subtype in the geodatabase.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: deleteSubtype in interface ISubtypes

Parameters:: subtypeCode - The subtypeCode (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getRules

public IEnumRule getRules()
                   throws IOException,
                          AutomationException

The rules associated with the class.

Description

Rules is a property that returns a IEnumRule object that contains all of the rules associated with the object class.

Remarks

Property Rules returns a IEnumRule enumerator hydrated with all of the rules associated with the object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getRules in interface IValidation

Returns:: A reference to a com.esri.arcgis.geodatabase.IEnumRule
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getRulesByField

public IEnumRule getRulesByField(String fieldName)
                          throws IOException,
                                 AutomationException

The rules associated with the attribute.

Product Availability

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

Specified by:: getRulesByField in interface IValidation

Parameters:: fieldName - The fieldName (in)
Returns:: A reference to a com.esri.arcgis.geodatabase.IEnumRule
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getRulesBySubtypeCode

public IEnumRule getRulesBySubtypeCode(int subtypeCode)
                                throws IOException,
                                       AutomationException

The rules associated with the subtype.

Product Availability

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

Specified by:: getRulesBySubtypeCode in interface IValidation

Parameters:: subtypeCode - The subtypeCode (in)
Returns:: A reference to a com.esri.arcgis.geodatabase.IEnumRule
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

addRule

public void addRule(IRule rule)
             throws IOException,
                    AutomationException

Adds the rule to the set of associated rules.

Description

This method is deprecated. Use a rule-specific method to add rules (i.e. IClassSchemaEdit.AlterDomain for attribute rules, IGeometricNetwork.AddRule for connectivity rules, IRelationshipClass.AddRelationshipRule for relationship rules).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: addRule in interface IValidation

Parameters:: rule - A reference to a com.esri.arcgis.geodatabase.IRule (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

deleteRule

public void deleteRule(IRule rule)
                throws IOException,
                       AutomationException

Deletes the rule from the set of associated rules.

Description

This method is deprecated. Use a rule-specific method to delete rules (i.e. IClassSchemaEdit.AlterDomain for attribute rules, IGeometricNetwork.DeleteRule for connectivity rules, IRelationshipClass.DeleteRelationshipRule for relationship rules).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: deleteRule in interface IValidation

Parameters:: rule - A reference to a com.esri.arcgis.geodatabase.IRule (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

validate

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

Validates the selection.

Description

This method creates a selection set that contains the underlying class' invalid objects.

A query filter can be provided to validate a portion of the class' objects, but passing a null value will evaluate all of the class' objects.

The Workspace parameter indicates where the selection set is to be created. In most cases, a null value can be used, indicating that the class' workspace be used. If necessary, a scratch workspace may also be used.

Remarks

Validate on a row occurs in five steps:

Validate the subtype
Validate the attribute rules
Validate the network connectivity rules (if network feature)
Validate the relationship rules
Perform custom validation (using optional class extension)

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: validate in interface IValidation

Parameters:: selection - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in); workspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
Returns:: A reference to a com.esri.arcgis.geodatabase.ISelectionSet
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

validateSelection

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

Validates the selection.

Description

This method creates a selection set that contains the underlying class' invalid objects.

A selection set must be passed to the first parameter, indicating that a subset of the class' objects should be evaluated. Unlike the query filter parameter of the Validate method, this parameter requires a valid selection set, and passing a null value will cause the method to fail.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: validateSelection in interface IValidation

Parameters:: selection - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in); workspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
Returns:: A reference to a com.esri.arcgis.geodatabase.ISelectionSet
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

validateSet

public ISet validateSet(ISet selection)
                 throws IOException,
                        AutomationException

Validates the set.

Description

ValidateSet function takes the ISet parameter and validates that set based on the rules associated with the object class. It returns a ISet object containing all of the invalid features that it found in that set.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: validateSet in interface IValidation

Parameters:: selection - A reference to a com.esri.arcgis.system.ISet (in)
Returns:: A reference to a com.esri.arcgis.system.ISet
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

alterRule

public void alterRule(IRule rule)
               throws IOException,
                      AutomationException

Alter the existing validation rule.

Remarks

The AlterRule method is used to change the characteristics of an existing rule. This is currently implemented to change a subset of properties for connectivity rules only. These properties are:

minimum and maximum cardinalities
default junction for junction connectivity rules
default junction classID for edge connectivity rules
default junction subtype code for edge connectivity rules

To alter other properties of a connectivity rule, the rule must be deleted and recreated with the appropriate changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: alterRule in interface IValidation2

Parameters:: rule - A reference to a com.esri.arcgis.geodatabase.IRule (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getMetadata

public IPropertySet getMetadata()
                         throws IOException,
                                AutomationException

The PropertySet containing metadata.

Remarks

The variable to hold the data must be of IPropertySet data type.

The metadata property is frequently used to save, or update, changes to metadata documents that have taken place through methods available on the IPropertySet, IXmlPropertySet, and/or IXmlPropertySet2 interfaces.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getMetadata in interface IMetadata

Returns:: A reference to a com.esri.arcgis.system.IPropertySet
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setMetadata

public void setMetadata(IPropertySet ppPropertySet)
                 throws IOException,
                        AutomationException

The PropertySet containing metadata.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setMetadata in interface IMetadata

Parameters:: ppPropertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

synchronize

public void synchronize(int action,
                        int interval)
                 throws IOException,
                        AutomationException

Updates metadata with the current properties; may create metadata if it doesn't already exist.

Description

The Synchronize method is used to extract metadata properties from an object and write those properties to the metadata .xml. Depending on the value of the esriMetaSyncAction, the Synchronize method may generate a new set of metadata if it doesn't already exist.

Remarks

The following actions will result in synchronization given each of the listed conditions:

Action	Metadata status	Esri/Sync element	Interval parameter
esriMSAAccessed	Doesn't matter	Must not be FALSE	Must be less than actual interval
esriMSAAlways	Doesn't matter	Doesn't matter	Doesn't matter
esriMSACreated	Must not exist	Must not be FALSE	Must be less than actual interval
esriMSANotCreated	Must exist	Must not be FALSE	Must be less than actual interval
esriMSAOverwrite	Doesn't matter	Doesn't matter	Doesn't matter

The difference between esriMSAAlways and esriMSAOverwrite lies in which elements are synchronized. esriMSAAlways will honor the removal or value change of an element's Sync attribute (to disable synchronization), whereas using esriMSAOverwrite is equivalent to setting the IXmlPropertySet2.OverwriteSyncAttribute to true for the metadata's property set, meaning that even elements without a Sync attribute of TRUE will be synchronized.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: synchronize in interface IMetadata

Parameters:: action - A com.esri.arcgis.geodatabase.esriMetadataSyncAction constant (in); interval - The interval (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isCanEditMetadata

public boolean isCanEditMetadata()
                          throws IOException,
                                 AutomationException

Indicates if metadata can be edited.

Remarks

This property is available to those objects that support metadata.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isCanEditMetadata in interface IMetadataEdit

Returns:: The pCanEdit
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws IOException,
                                             AutomationException

The spatial reference of the GeoDataset.

Remarks

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

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSpatialReference in interface IGeoDataset

Returns:: A reference to a com.esri.arcgis.geometry.ISpatialReference
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getExtent

public IEnvelope getExtent()
                    throws IOException,
                           AutomationException

The extent of the GeoDataset.

Remarks

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

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

The red box represents the IGeoDataset extent

If a portion of the features were then deleted and the extent is again requested an envelope with the exact same extents as during the first request would be returned (see image below). This is because the deletion of features does not shrink the extent. However all additions of features outside the red box would increase the envelope returned to encompass the newly added features.

The red box represents the IGeoDataset extent after some of the features have been deleted

If you would like to update the IGeoDataset::Extent property to reflect the current features in your dataset please see IFeatureClassManage::UpdateExtent (also see IFeatureClassLoad). In the image below the extent has been updated and a new envelope is being returned.

The red box represents the IGeoDataset extent after it has been updated

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getExtent in interface IGeoDataset

Returns:: A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isCanAlterSpatialReference

public boolean isCanAlterSpatialReference()
                                   throws IOException,
                                          AutomationException

Indicates if the spatial reference of the dataset can be altered.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isCanAlterSpatialReference in interface IGeoDatasetSchemaEdit

Returns:: The canAlter
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

alterSpatialReference

public void alterSpatialReference(ISpatialReference spatialReference)
                           throws IOException,
                                  AutomationException

Alters the spatial reference of the dataset to match the coordinate system of the input spatial reference, does not reproject the data.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: alterSpatialReference in interface IGeoDatasetSchemaEdit

Parameters:: spatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

generateDiagram

public ISchematicDiagram generateDiagram(String diagramName,
                                         ISchematicDiagramContainer diagramContainer,
                                         IPropertySet propertySet,
                                         ISchematicBuilderContext context,
                                         ITrackCancel cancelTracker)
                                  throws IOException,
                                         AutomationException

Generates a new schematic diagram implemented by the schematic diagram builder.

Product Availability

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

Specified by:: generateDiagram in interface ISchematicBuilder

Parameters:: diagramName - The diagramName (in); diagramContainer - A reference to a com.esri.arcgis.schematic.ISchematicDiagramContainer (in, optional, pass 0 if not required); propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in, optional, pass 0 if not required); context - A reference to a com.esri.arcgis.schematic.ISchematicBuilderContext (in, optional, pass 0 if not required); cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in, optional, pass 0 if not required)
Returns:: A reference to a com.esri.arcgis.schematic.ISchematicDiagram
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

updateDiagram

public void updateDiagram(ISchematicDiagram diagram,
                          IPropertySet propertySet,
                          ISchematicBuilderContext context,
                          ITrackCancel cancelTracker)
                   throws IOException,
                          AutomationException

Refreshs an existing diagram implemented by the schematic diagram builder.

Product Availability

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

Specified by:: updateDiagram in interface ISchematicBuilder

Parameters:: diagram - A reference to a com.esri.arcgis.schematic.ISchematicDiagram (in); propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in, optional, pass 0 if not required); context - A reference to a com.esri.arcgis.schematic.ISchematicBuilderContext (in, optional, pass 0 if not required); cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in, optional, pass 0 if not required)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

gPGenerateDiagram

public ISchematicDiagram gPGenerateDiagram(String diagramName,
                                           ISchematicDiagramContainer diagramContainer,
                                           IEnumGPValue enumGPValue,
                                           String builderOptions,
                                           ITrackCancel cancelTracker,
                                           IGPMessages messages)
                                    throws IOException,
                                           AutomationException

Generates a new schematic diagram from an enum of GP values.

Product Availability

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

Specified by:: gPGenerateDiagram in interface IGPSchematicBuilder

Parameters:: diagramName - The diagramName (in); diagramContainer - A reference to a com.esri.arcgis.schematic.ISchematicDiagramContainer (in); enumGPValue - A reference to a com.esri.arcgis.geodatabase.IEnumGPValue (in, optional, pass 0 if not required); builderOptions - The builderOptions (in, optional, pass 0 if not required); cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in, optional, pass 0 if not required); messages - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in, optional, pass 0 if not required)
Returns:: A reference to a com.esri.arcgis.schematic.ISchematicDiagram
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

gPUpdateDiagram

public void gPUpdateDiagram(ISchematicDiagram diagram,
                            IEnumGPValue enumGPValue,
                            String builderOptions,
                            ITrackCancel cancelTracker,
                            IGPMessages messages)
                     throws IOException,
                            AutomationException

Updates an existing diagram from an enum of GP values.

Product Availability

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

Specified by:: gPUpdateDiagram in interface IGPSchematicBuilder

Parameters:: diagram - A reference to a com.esri.arcgis.schematic.ISchematicDiagram (in); enumGPValue - A reference to a com.esri.arcgis.geodatabase.IEnumGPValue (in, optional, pass 0 if not required); builderOptions - The builderOptions (in, optional, pass 0 if not required); cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in, optional, pass 0 if not required); messages - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in, optional, pass 0 if not required)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSchematicInMemoryDiagrams

public IEnumSchematicInMemoryDiagram getSchematicInMemoryDiagrams()
                                                           throws IOException,
                                                                  AutomationException

Schematic in memory diagrams enumeration within the schematic diagram container.

Product Availability

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

Specified by:: getSchematicInMemoryDiagrams in interface ISchematicInMemoryDiagramContainer

Returns:: A reference to a com.esri.arcgis.schematic.IEnumSchematicInMemoryDiagram
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSchematicInMemoryDiagram

public ISchematicInMemoryDiagram getSchematicInMemoryDiagram(String name)
                                                      throws IOException,
                                                             AutomationException

Schematic in memory diagram referenced by the specified Name.

Product Availability

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

Specified by:: getSchematicInMemoryDiagram in interface ISchematicInMemoryDiagramContainer

Parameters:: name - The name (in)
Returns:: A reference to a com.esri.arcgis.schematic.ISchematicInMemoryDiagram
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSchematicDiagramClasses

public IEnumSchematicDiagramClass getSchematicDiagramClasses()
                                                      throws IOException,
                                                             AutomationException

Schematic diagram classes enumeration within the schematic diagram class container.

Product Availability

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

Specified by:: getSchematicDiagramClasses in interface ISchematicDiagramClassContainer

Returns:: A reference to a com.esri.arcgis.schematic.IEnumSchematicDiagramClass
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSchematicDiagramClass

public ISchematicDiagramClass getSchematicDiagramClass(String name)
                                                throws IOException,
                                                       AutomationException

Schematic diagram class referenced by the specified Name.

Product Availability

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

Specified by:: getSchematicDiagramClass in interface ISchematicDiagramClassContainer

Parameters:: name - The name (in)
Returns:: A reference to a com.esri.arcgis.schematic.ISchematicDiagramClass
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getOrderedSchematicBuilderRules

public IEnumSchematicBuilderRule getOrderedSchematicBuilderRules()
                                                          throws IOException,
                                                                 AutomationException

Schematic ordered builder rules enumeration within the builder rule container.

Product Availability

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

Specified by:: getOrderedSchematicBuilderRules in interface ISchematicBuilderRuleContainer

Returns:: A reference to a com.esri.arcgis.schematic.IEnumSchematicBuilderRule
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: ISchematicBuilderRule.getOrderNumber()

getSchematicBuilderRuleCount

public int getSchematicBuilderRuleCount()
                                 throws IOException,
                                        AutomationException

Number of builder rules within the builder rule container.

Product Availability

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

Specified by:: getSchematicBuilderRuleCount in interface ISchematicBuilderRuleContainer

Returns:: The count
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

addSchematicBuilderRule

public ISchematicBuilderRule addSchematicBuilderRule()
                                              throws IOException,
                                                     AutomationException

Adds a schematic builder rules within the builder rule container.

Product Availability

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

Specified by:: addSchematicBuilderRule in interface ISchematicBuilderRuleContainerEdit

Returns:: A reference to a com.esri.arcgis.schematic.ISchematicBuilderRule
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

insertSchematicBuilderRule

public ISchematicBuilderRule insertSchematicBuilderRule(int orderNumber)
                                                 throws IOException,
                                                        AutomationException

Inserts a schematic builder rules at given order number within the builder rule container.

Product Availability

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

Specified by:: insertSchematicBuilderRule in interface ISchematicBuilderRuleContainerEdit

Parameters:: orderNumber - The orderNumber (in)
Returns:: A reference to a com.esri.arcgis.schematic.ISchematicBuilderRule
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

moveSchematicBuilderRule

public void moveSchematicBuilderRule(ISchematicBuilderRule schematicBuilderRule,
                                     int orderNumber)
                              throws IOException,
                                     AutomationException

Moves a schematic builder rules to given order number within the builder rule container.

Product Availability

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

Specified by:: moveSchematicBuilderRule in interface ISchematicBuilderRuleContainerEdit

Parameters:: schematicBuilderRule - A reference to a com.esri.arcgis.schematic.ISchematicBuilderRule (in); orderNumber - The orderNumber (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSchematicObjectClasses

public IEnumSchematicObjectClass getSchematicObjectClasses()
                                                    throws IOException,
                                                           AutomationException

Schematic object classes enumeration within the schematic object class container.

Product Availability

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

Specified by:: getSchematicObjectClasses in interface ISchematicObjectClassContainer

Returns:: A reference to a com.esri.arcgis.schematic.IEnumSchematicObjectClass
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSchematicObjectClass

public ISchematicObjectClass getSchematicObjectClass(String name)
                                              throws IOException,
                                                     AutomationException

Schematic object class referenced by the specified Name.

Product Availability

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

Specified by:: getSchematicObjectClass in interface ISchematicObjectClassContainer

Parameters:: name - The name (in)
Returns:: A reference to a com.esri.arcgis.schematic.ISchematicObjectClass
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

alterSchematicAttributeCLSID

public void alterSchematicAttributeCLSID(String name,
                                         IUID uID)
                                  throws IOException,
                                         AutomationException

Changes the schematic attribute CLSID.

Product Availability

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

Specified by:: alterSchematicAttributeCLSID in interface ISchematicAttributeDesign

Parameters:: name - The name (in); uID - A reference to a com.esri.arcgis.system.IUID (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSchematicAttributes

public IEnumSchematicAttribute getSchematicAttributes()
                                               throws IOException,
                                                      AutomationException

Schematic attributes enumeration within the schematic attribute container.

Product Availability

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

Specified by:: getSchematicAttributes in interface ISchematicAttributeContainer

Returns:: A reference to a com.esri.arcgis.schematic.IEnumSchematicAttribute
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSchematicAttribute

public ISchematicAttribute getSchematicAttribute(String name,
                                                 boolean recursiveSearch)
                                          throws IOException,
                                                 AutomationException

Retrives recursively or not the schematic attribute referenced by the specified Name.

Product Availability

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

Specified by:: getSchematicAttribute in interface ISchematicAttributeContainer

Parameters:: name - The name (in); recursiveSearch - The recursiveSearch (in, optional, pass false if not required)
Returns:: A reference to a com.esri.arcgis.schematic.ISchematicAttribute
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

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.schematic Class SchematicDiagramClass

Product Availability

SchematicDiagramClass

equals

hashCode

getParent

Product Availability

setParentByRef

Product Availability

getAssociatedSchematicElementClasses

Product Availability

associateSchematicElementClass

Product Availability

dissociateSchematicElementClass

Product Availability

isSchematicElementClassAssociated

Product Availability

getSchematicBuilder

Product Availability

setSchematicBuilderByRef

Product Availability

getSchematicAlgorithm

Product Availability

setSchematicAlgorithmByRef

Product Availability

getSchematicAlgorithms

Product Availability

setSchematicAlgorithmsByRef

Product Availability

getSchematicTraces

Product Availability

setSchematicTracesByRef

Product Availability

loadSchematicInMemoryDiagram

Product Availability

isAlwaysLoadDiagrams

Product Availability

setAlwaysLoadDiagrams

Product Availability

setSchematicLayerTemplate

Product Availability

getSchematicLayerTemplate

Product Availability

setDefaultSchematicNodeClass

Product Availability

getDefaultSchematicNodeClass

Product Availability

createSchematicDiagram

Product Availability

getSchematicDiagrams

Product Availability

getSchematicDiagramByID

Product Availability

getSchematicDiagramByName

Product Availability

getName

Product Availability

setName

Product Availability

getSchematicDataset

Product Availability

getSchematicQueryParameters

Product Availability

setSchematicQueryParameters

Product Availability

getQueryString

Product Availability

setQueryString

Product Availability

getIdentifierFieldNames

Product Availability

setIdentifierFieldNames

Product Availability

getSchematicDataSource

Product Availability

setSchematicDataSourceByRef

Product Availability

delete

Product Availability

createSchematicAttribute

com.esri.arcgis.schematic
Class SchematicDiagramClass