com.esri.arcgis.schematic
Class SchematicDiagram

java.lang.Object
  extended bycom.esri.arcgis.schematic.SchematicDiagram
All Implemented Interfaces:
java.util.EventListener, IDataset, IDatasetEditInfo, IGeoDataset, IGeoDatasetSchemaEdit, IMetadata, IMetadataEdit, IObject, IRelatedObjectEvents, IRow, IRowBuffer, IRowChanges, IRowCompare, IRowEdit, IRowEvents, ISchemaLock, ISchematicDiagram, ISchematicElementContainer, ISchematicElementContainerEdit, IValidate, java.io.Serializable

public class SchematicDiagram
extends java.lang.Object
implements IObject, IRow, IRowBuffer, IRowCompare, IRowChanges, IRowEdit, IRowEvents, IDataset, IDatasetEditInfo, IMetadata, IMetadataEdit, ISchemaLock, IRelatedObjectEvents, ISchematicDiagram, ISchematicElementContainer, ISchematicElementContainerEdit, IGeoDataset, IGeoDatasetSchemaEdit, IValidate

Schematic diagram object.

See Also:
Serialized Form

Constructor Summary
SchematicDiagram(java.lang.Object obj)
          Construct a SchematicDiagram using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 void alterBuilderPropertySet(IPropertySet propertySet)
          Changes the builder PropertySet related to the schematic diagram with the new specified builder PropertySet.
 void alterPropertySet(IPropertySet propertySet)
          Changes the Schematic diagram PropertySet with the new specified diagram PropertySet.
 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.
 boolean canCopy()
          True if this dataset can be copied.
 boolean canDelete()
          True if this dataset can be deleted.
 boolean canDeleteSchematicElements()
          Indicates if schematic elements can be deleted within the container.
 boolean canRename()
          True if this dataset can be renamed.
 void changeSchemaLock(int schemaLock)
          Changes a schema lock.
 IDataset copy(java.lang.String copyName, IWorkspace copyWorkspace)
          Copies this dataset to a new dataset with the specified name.
 void delete()
          Deletes the row.
 void deleteSchematicElement(INgElement ngElement)
          Delete a schematic element within the container.
 void deleteSet(ISet rows)
          Deletes the set of rows.
 boolean equals(java.lang.Object o)
          Compare this object with another
 IObjectClass esri_getClass()
          The Object Class for the row.
 IDataset getAsIDataset()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IDatasetEditInfo getAsIDatasetEditInfo()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IGeoDataset getAsIGeoDataset()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IGeoDatasetSchemaEdit getAsIGeoDatasetSchemaEdit()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IMetadata getAsIMetadata()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IMetadataEdit getAsIMetadataEdit()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IObject getAsIObject()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IRelatedObjectEvents getAsIRelatedObjectEvents()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IRow getAsIRow()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IRowBuffer getAsIRowBuffer()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IRowChanges getAsIRowChanges()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IRowCompare getAsIRowCompare()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IRowEdit getAsIRowEdit()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IRowEvents getAsIRowEvents()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 ISchemaLock getAsISchemaLock()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 ISchematicDiagram getAsISchematicDiagram()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 ISchematicElementContainer getAsISchematicElementContainer()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 ISchematicElementContainerEdit getAsISchematicElementContainerEdit()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IValidate getAsIValidate()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 java.lang.String getBrowseName()
          The browse name of the dataset.
 IPropertySet getBuilderPropertySet()
          Builder PropertySet related to the schematic diagram.
 java.lang.String getCategory()
          The category of the dataset.
 java.util.Date getCreationDate()
          Creation date of the schematic diagram.
 java.lang.String getCreator()
          Name of the schematic diagram creator.
 void getCurrentSchemaLocks(IEnumSchemaLockInfo[] schemaLockInfo)
          The list of current locks.
 IEnvelope getExtent()
          The extent of the GeoDataset.
 IFields getFields()
          The fields Collection for this row buffer.
 IName getFullName()
          The associated name object.
 IFields getInvalidFields()
          Returns all invalid fields.
 IEnumRule getInvalidRules()
          The set of all invalid rules.
 IEnumRule getInvalidRulesByField(java.lang.String fieldName)
          The set of all invalid rules for the specified field.
 java.lang.String getLastUpdateBy()
          Name of the last user that updated the schematic diagram.
 java.util.Date getLastUpdateDate()
          Last updating date of the schematic diagram.
 IPropertySet getMetadata()
          The PropertySet containing metadata.
 java.lang.String getName()
          The name of the Dataset.
 int getOID()
          The OID for the row.
 java.lang.Object getOriginalValue(int index)
          The value of the field at the specified index immediately after the last call to Store on the Row object.
 IPropertySet getPropertySet()
          The set of properties for the dataset.
 ISchematicDiagramClass getSchematicDiagramClass()
          Schematic diagram class related to the schematic diagram.
 ISchematicDiagramContainer getSchematicDiagramContainer()
          Schematic diagram container related to the schematic diagram.
 ISchematicElement getSchematicElementByName(int type, java.lang.String name)
          Schematic element referenced by the specified Name and related to specified element type.
 IEnumSchematicElement getSchematicElements()
          Schematic elements enumeration within the container.
 IEnumSchematicElement getSchematicElementsByType(int type)
          Schematic elements referenced by the specified element type.
 ISpatialReference getSpatialReference()
          The spatial reference of the GeoDataset.
 IEnumDataset getSubsets()
          Datasets contained within this dataset.
 ITable getTable()
          The Table for the row.
 int getType()
          The type of the Dataset.
 java.lang.Object getValue(int index)
          The value of the field with the specified index.
 java.lang.String getVersion()
          Version of the database used to create the schematic diagram.
 IWorkspace getWorkspace()
          The workspace containing this dataset.
 int hashCode()
          the hashcode for this object
 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 isCanUndo()
          True if the dataset supports edit sessions with the ability to undo individual edit operations.
 boolean isEqual(IRow pOtherRow)
          Indicates if the rows (which may be from two different versions) are the same (oid + values).
 boolean isHasOID()
          Indicates if the row has an OID.
 boolean isValueChanged(int index)
          Indicates whether the value of the field at the specified index has changed since the last call to Store on the Row object.
 void onChanged(IRowEventsOnChangedEvent theEvent)
          An after event that is fired when a custom object is changed.
 void onDelete(IRowEventsOnDeleteEvent theEvent)
          An after event that is fired when a custom object is deleted.
 void onInitialize(IRowEventsOnInitializeEvent theEvent)
          An after event that is fired when a custom object is initialized.
 void onNew(IRowEventsOnNewEvent theEvent)
          An after event that is fired when a custom object is Stored for the first time.
 void onValidate(IRowEventsOnValidateEvent theEvent)
          An after event that is fired when a custom object is validated.
 void relatedObjectChanged(IRelationshipClass relationshipClass, IObject objectThatChanged)
          Notifies this object that a related object changed.
 void relatedObjectMoved(IRelationshipClass relationshipClass, IObject objectThatChanged, ILine moveVector)
          Notifies this object that a related object moved.
 void relatedObjectRotated(IRelationshipClass relationshipClass, IObject objectThatChanged, IPoint origin, double angle)
          Notifies this object that a related object rotated.
 void relatedObjectSetMoved(IRelationshipClass relationshipClass, ISet objectsThatNeedToChange, ISet objectsThatChanged, ILine moveVector)
          Notifies this object that a set of objects with relationships to the input set of objects moved.
 void relatedObjectSetRotated(IRelationshipClass relationshipClass, ISet objectsThatNeedToChange, ISet objectsThatChanged, IPoint origin, double angle)
          Notifies this object that a set of objects with relationships to the input set of objects rotated.
 void rename(java.lang.String name)
          Renames this Dataset.
 void setBrowseName(java.lang.String name)
          The browse name of the dataset.
 void setCreationDate(java.util.Date date)
          Creation date of the schematic diagram.
 void setCreator(java.lang.String name)
          Name of the schematic diagram creator.
 void setLastUpdateBy(java.lang.String name)
          Name of the last user that updated the schematic diagram.
 void setLastUpdateDate(java.util.Date date)
          Last updating date of the schematic diagram.
 void setMetadata(IPropertySet ppPropertySet)
          The PropertySet containing metadata.
 void setName(java.lang.String name)
          Name of the schematic diagram.
 void setSchematicDiagramContainerByRef(ISchematicDiagramContainer diagramContainer)
          Schematic diagram container related to the schematic diagram.
 void setValue(int index, java.lang.Object value)
          The value of the field with the specified index.
 void setVersion(java.lang.String versionName)
          Version of the database used to create the schematic diagram.
 void store()
          Stores the row.
 void synchronize(int action, int interval)
          Updates metadata with the current properties; may create metadata if it doesn't already exist.
 boolean validate(java.lang.String[] errorMessage)
          Validates the row.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SchematicDiagram

public SchematicDiagram(java.lang.Object obj)
                 throws java.io.IOException
Construct a SchematicDiagram using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to SchematicDiagram.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
SchematicDiagram o = (SchematicDiagram)obj; // will not work

SchematicDiagram o = new SchematicDiagram(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server SchematicDiagram theSchematicDiagram = (SchematicDiagram) obj;

Throws:
java.io.IOException - if there are interop problems
Method Detail

getAsIObject

public IObject getAsIObject()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIRow

public IRow getAsIRow()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIRowBuffer

public IRowBuffer getAsIRowBuffer()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIRowCompare

public IRowCompare getAsIRowCompare()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIRowChanges

public IRowChanges getAsIRowChanges()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIRowEdit

public IRowEdit getAsIRowEdit()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIRowEvents

public IRowEvents getAsIRowEvents()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIDataset

public IDataset getAsIDataset()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIDatasetEditInfo

public IDatasetEditInfo getAsIDatasetEditInfo()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIMetadata

public IMetadata getAsIMetadata()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIMetadataEdit

public IMetadataEdit getAsIMetadataEdit()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsISchemaLock

public ISchemaLock getAsISchemaLock()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIRelatedObjectEvents

public IRelatedObjectEvents getAsIRelatedObjectEvents()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsISchematicDiagram

public ISchematicDiagram getAsISchematicDiagram()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsISchematicElementContainer

public ISchematicElementContainer getAsISchematicElementContainer()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsISchematicElementContainerEdit

public ISchematicElementContainerEdit getAsISchematicElementContainerEdit()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIGeoDataset

public IGeoDataset getAsIGeoDataset()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIGeoDatasetSchemaEdit

public IGeoDatasetSchemaEdit getAsIGeoDatasetSchemaEdit()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIValidate

public IValidate getAsIValidate()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


equals

public boolean equals(java.lang.Object o)
Compare this object with another


hashCode

public int hashCode()
the hashcode for this object


esri_getClass

public IObjectClass esri_getClass()
                           throws java.io.IOException,
                                  AutomationException
Description copied from interface: IObject
The Object Class for the row.

Specified by:
esri_getClass in interface IObject
Returns:
A reference to a com.esri.arcgis.geodatabase.IObjectClass
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

isHasOID

public boolean isHasOID()
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: IRow
Indicates if the row has an OID.

Supported Platforms

Windows, Solaris, Linux

Remarks

If the table has been registered with the geodatabase it will have unique Object ID, automatically created by the register tool, and the HasOID property will be set to True. Tables not registered with the geodatabase will not have an OID column and the HasOID property will be set to False.  See the IClassSchemaEdit::RegisterAsObjectClass method for more information.

Specified by:
isHasOID in interface IRow
Returns:
The hasOID
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getOID

public int getOID()
           throws java.io.IOException,
                  AutomationException
Description copied from interface: IRow
The OID for the row.

Supported Platforms

Windows, Solaris, Linux

Description

Gets the OID for a row in a table that has a unique Object ID, such as tables registered with the geodatabase.

Specified by:
getOID in interface IRow
Returns:
The oID
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getTable

public ITable getTable()
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IRow
The Table for the row.

Supported Platforms

Windows, Solaris, Linux

Description

Returns a pointer to the table the row belongs to.

Specified by:
getTable in interface IRow
Returns:
A reference to a com.esri.arcgis.geodatabase.ITable
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

store

public void store()
           throws java.io.IOException,
                  AutomationException
Description copied from interface: IRow
Stores the row.

Supported Platforms

Windows, Solaris, Linux

Remarks

The Store method is called by an application once it has modified the values of a Row. Once Store is called on a Row object, all subsequent queries within the same edit session, using the Geodatabase API, will reflect the modified state of the Row object.

All edits to features that participate in a Topology or Geometric Network must be performed within an edit session and bracketed within an edit operation.

Calling the Store method triggers the following actions:

- The IRowEvents::OnChanged is called for the row being stored. The OnNew is called if this is a newly created row being stored for the first time. A custom row object can implement the OnChanged method and take some special action when it is called - for example; update a special column in the row

- The IRelatedObjectEvents::RelatedObjectChanged method is called for related objects in a related object class if the table for this row is an object class that participates in relationship classes with notification

Store should not be used for batch operations, such as updates or inserts.  For performing a number of inserts or updates using cursors, refer to the ITable::Insert, ITable::Update, ITable::UpdateSearchedRows , IFeatureClass::Update andIFeatureClass::Insert.  If an insert or update cursor is used on non-simple features (such as network features), the cursor will revert to using Store.

It is not necessary to explicitly call Connect on network features, this is handled polymorphically when Store is called on the feature. This is also the case with features in a Topology, Dirty Area creation is handled internally when Store is called.

Store should not be called inside of edit events, such as OnCreateFeature, OnChangeFeature or OnDeleteFeature.  Even if you are modifying the geometry or other field values, Store will be called once the event is complete.

Specified by:
store in interface IRow
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

delete

public void delete()
            throws java.io.IOException,
                   AutomationException
Description copied from interface: IRow
Deletes the row.

Supported Platforms

Windows, Solaris, Linux

Remarks

All edits to features that participate in a Topology or Geometric Network must be performed within an edit session and bracketed within an edit operation.

Specified by:
delete in interface IRow
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getValue

public java.lang.Object getValue(int index)
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IRowBuffer
The value of the field with the specified index.

Supported Platforms

Windows, Solaris, Linux

Remarks

The Index parameter is a zero based index.

Specified by:
getValue in interface IRowBuffer
Parameters:
index - The index (in)
Returns:
A Variant
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setValue

public void setValue(int index,
                     java.lang.Object value)
              throws java.io.IOException,
                     AutomationException
Description copied from interface: IRowBuffer
The value of the field with the specified index.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setValue in interface IRowBuffer
Parameters:
index - The index (in)
value - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFields

public IFields getFields()
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IRowBuffer
The fields Collection for this row buffer.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getFields in interface IRowBuffer
Returns:
A reference to a com.esri.arcgis.geodatabase.IFields
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IRow pOtherRow)
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IRowCompare
Indicates if the rows (which may be from two different versions) are the same (oid + values).

Specified by:
isEqual in interface IRowCompare
Parameters:
pOtherRow - A reference to a com.esri.arcgis.geodatabase.IRow (in)
Returns:
The isEqual
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isValueChanged

public boolean isValueChanged(int index)
                       throws java.io.IOException,
                              AutomationException
Description copied from interface: IRowChanges
Indicates whether the value of the field at the specified index has changed since the last call to Store on the Row object.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isValueChanged in interface IRowChanges
Parameters:
index - The index (in)
Returns:
The changed
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOriginalValue

public java.lang.Object getOriginalValue(int index)
                                  throws java.io.IOException,
                                         AutomationException
Description copied from interface: IRowChanges
The value of the field at the specified index immediately after the last call to Store on the Row object.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getOriginalValue in interface IRowChanges
Parameters:
index - The index (in)
Returns:
A Variant
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

deleteSet

public void deleteSet(ISet rows)
               throws java.io.IOException,
                      AutomationException
Description copied from interface: IRowEdit
Deletes the set of rows.

Supported Platforms

Windows, Solaris, Linux

Remarks

All edits to features that participate in a Topology or Geometric Network must be performed within an edit session and bracketed within an edit operation.

Specified by:
deleteSet in interface IRowEdit
Parameters:
rows - A reference to a com.esri.arcgis.system.ISet (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

onChanged

public void onChanged(IRowEventsOnChangedEvent theEvent)
               throws java.io.IOException,
                      AutomationException
Description copied from interface: IRowEvents
An after event that is fired when a custom object is changed.

Supported Platforms

Windows, Solaris, Linux

Remarks

The OnChanged method is called by the geodatabase when an application program calls Store on an existing Row object.

Specified by:
onChanged in interface IRowEvents
Parameters:
theEvent - The event
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

onDelete

public void onDelete(IRowEventsOnDeleteEvent theEvent)
              throws java.io.IOException,
                     AutomationException
Description copied from interface: IRowEvents
An after event that is fired when a custom object is deleted.

Supported Platforms

Windows, Solaris, Linux

Remarks

The OnDelete method is called by the geodatabase when an application program calls Delete on a Row object.

Specified by:
onDelete in interface IRowEvents
Parameters:
theEvent - The event
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

onInitialize

public void onInitialize(IRowEventsOnInitializeEvent theEvent)
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IRowEvents
An after event that is fired when a custom object is initialized.

Supported Platforms

Windows, Solaris, Linux

Remarks

The OnInitialize method is called by the geodatabase after hydrating a cocreated Row object with its state (its set of field values) but before handing the Row to an application program. This is an opportunity for the Row object to initialize further state and derived member variables.

Specified by:
onInitialize in interface IRowEvents
Parameters:
theEvent - The event
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onNew

public void onNew(IRowEventsOnNewEvent theEvent)
           throws java.io.IOException,
                  AutomationException
Description copied from interface: IRowEvents
An after event that is fired when a custom object is Stored for the first time.

Supported Platforms

Windows, Solaris, Linux

Remarks

The OnNew method is called by the geodatabase when an application program calls Store on a newly created Row object.

Specified by:
onNew in interface IRowEvents
Parameters:
theEvent - The event
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onValidate

public void onValidate(IRowEventsOnValidateEvent theEvent)
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IRowEvents
An after event that is fired when a custom object is validated.

Supported Platforms

Windows, Solaris, Linux

Description

OnValidate maintains information about particular functionality...

Specified by:
onValidate in interface IRowEvents
Parameters:
theEvent - The event
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
Description copied from interface: IDataset
The name of the Dataset.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getName in interface IDataset
Returns:
The name
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getFullName

public IName getFullName()
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IDataset
The associated name object.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
getFullName in interface IDataset
Returns:
A reference to a com.esri.arcgis.system.IName
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getBrowseName

public java.lang.String getBrowseName()
                               throws java.io.IOException,
                                      AutomationException
Description copied from interface: IDataset
The browse name of the dataset.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

Specified by:
getBrowseName in interface IDataset
Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBrowseName

public void setBrowseName(java.lang.String name)
                   throws java.io.IOException,
                          AutomationException
Description copied from interface: IDataset
The browse name of the dataset.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setBrowseName in interface IDataset
Parameters:
name - The name (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getType

public int getType()
            throws java.io.IOException,
                   AutomationException
Description copied from interface: IDataset
The type of the Dataset.

Supported Platforms

Windows, Solaris, Linux

Remarks

The Type property returns the enumerated type for the dataset, such as esriDTTable or esriDTFeatureDataset.

Specified by:
getType in interface IDataset
Returns:
A com.esri.arcgis.geodatabase.esriDatasetType constant
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getCategory

public java.lang.String getCategory()
                             throws java.io.IOException,
                                    AutomationException
Description copied from interface: IDataset
The category of the dataset.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
getCategory in interface IDataset
Returns:
The category
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getSubsets

public IEnumDataset getSubsets()
                        throws java.io.IOException,
                               AutomationException
Description copied from interface: IDataset
Datasets contained within this dataset.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
getSubsets in interface IDataset
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumDataset
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getWorkspace

public IWorkspace getWorkspace()
                        throws java.io.IOException,
                               AutomationException
Description copied from interface: IDataset
The workspace containing this dataset.

Supported Platforms

Windows, Solaris, Linux

Description

The Workspace property returns the containing workspace for this dataset.

Specified by:
getWorkspace in interface IDataset
Returns:
A reference to a com.esri.arcgis.geodatabase.IWorkspace
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPropertySet

public IPropertySet getPropertySet()
                            throws java.io.IOException,
                                   AutomationException
Description copied from interface: IDataset
The set of properties for the dataset.

Supported Platforms

Windows, Solaris, Linux

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.

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.

Specified by:
getPropertySet in interface IDataset
Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

canCopy

public boolean canCopy()
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IDataset
True if this dataset can be copied.

Supported Platforms

Windows, Solaris, Linux

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:

Specified by:
canCopy in interface IDataset
Returns:
The canCopy
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

copy

public IDataset copy(java.lang.String copyName,
                     IWorkspace copyWorkspace)
              throws java.io.IOException,
                     AutomationException
Description copied from interface: IDataset
Copies this dataset to a new dataset with the specified name.

Supported Platforms

Windows, Solaris, Linux

Remarks

IDataset::Copy does not support the copying of Graph objects such as a Geometric Network.

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:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
See Also:
GeoDBDataTransfer

canDelete

public boolean canDelete()
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IDataset
True if this dataset can be deleted.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
canDelete in interface IDataset
Returns:
The canDelete
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canRename

public boolean canRename()
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IDataset
True if this dataset can be renamed.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
canRename in interface IDataset
Returns:
The canRename
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

rename

public void rename(java.lang.String name)
            throws java.io.IOException,
                   AutomationException
Description copied from interface: IDataset
Renames this Dataset.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
rename in interface IDataset
Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanEdit

public boolean isCanEdit()
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IDatasetEditInfo
True if the dataset supports edit sessions with the ability to discard edits on save.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
isCanEdit in interface IDatasetEditInfo
Returns:
The pCanEdit
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanUndo

public boolean isCanUndo()
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IDatasetEditInfo
True if the dataset supports edit sessions with the ability to undo individual edit operations.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isCanUndo in interface IDatasetEditInfo
Returns:
The pCanUndo
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanRedo

public boolean isCanRedo()
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IDatasetEditInfo
True if the dataset supports edit sessions with the ability to redo undone operations.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isCanRedo in interface IDatasetEditInfo
Returns:
The pCanUndo
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getMetadata

public IPropertySet getMetadata()
                         throws java.io.IOException,
                                AutomationException
Description copied from interface: IMetadata
The PropertySet containing metadata.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
getMetadata in interface IMetadata
Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setMetadata

public void setMetadata(IPropertySet ppPropertySet)
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: IMetadata
The PropertySet containing metadata.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setMetadata in interface IMetadata
Parameters:
ppPropertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

synchronize

public void synchronize(int action,
                        int interval)
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: IMetadata
Updates metadata with the current properties; may create metadata if it doesn't already exist.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
synchronize in interface IMetadata
Parameters:
action - A com.esri.arcgis.geodatabase.esriMetadataSyncAction constant (in)
interval - The interval (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanEditMetadata

public boolean isCanEditMetadata()
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IMetadataEdit
Indicates if metadata can be edited.

Supported Platforms

Windows, Solaris, Linux

Remarks

This property is available to those objects that support metadata.

Specified by:
isCanEditMetadata in interface IMetadataEdit
Returns:
The pCanEdit
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

changeSchemaLock

public void changeSchemaLock(int schemaLock)
                      throws java.io.IOException,
                             AutomationException
Description copied from interface: ISchemaLock
Changes a schema lock.

Supported Platforms

Windows, Solaris, Linux

Specified by:
changeSchemaLock in interface ISchemaLock
Parameters:
schemaLock - A com.esri.arcgis.geodatabase.esriSchemaLock constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCurrentSchemaLocks

public void getCurrentSchemaLocks(IEnumSchemaLockInfo[] schemaLockInfo)
                           throws java.io.IOException,
                                  AutomationException
Description copied from interface: ISchemaLock
The list of current locks.

Supported Platforms

Windows, Solaris, Linux

Remarks

Returns an enumeration of the schema locks currently on the dataset.  Not that there will always be at least one schema lock on the dataset.  By checking the schema locks on a dataset a shared schema lock is applied to the data.

Specified by:
getCurrentSchemaLocks in interface ISchemaLock
Parameters:
schemaLockInfo - A reference to a com.esri.arcgis.geodatabase.IEnumSchemaLockInfo (out: use single element array)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

relatedObjectChanged

public void relatedObjectChanged(IRelationshipClass relationshipClass,
                                 IObject objectThatChanged)
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IRelatedObjectEvents
Notifies this object that a related object changed.

Supported Platforms

Windows, Solaris, Linux

Remarks

The RelatedObjectChanged method is called when a related object has changed.

Specified by:
relatedObjectChanged in interface IRelatedObjectEvents
Parameters:
relationshipClass - A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)
objectThatChanged - A reference to a com.esri.arcgis.geodatabase.IObject (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

relatedObjectMoved

public void relatedObjectMoved(IRelationshipClass relationshipClass,
                               IObject objectThatChanged,
                               ILine moveVector)
                        throws java.io.IOException,
                               AutomationException
Description copied from interface: IRelatedObjectEvents
Notifies this object that a related object moved.

Supported Platforms

Windows, Solaris, Linux

Remarks

The RelatedObjectMoved method is called when a related object has moved.

Specified by:
relatedObjectMoved in interface IRelatedObjectEvents
Parameters:
relationshipClass - A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)
objectThatChanged - A reference to a com.esri.arcgis.geodatabase.IObject (in)
moveVector - A reference to a com.esri.arcgis.geometry.ILine (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

relatedObjectSetMoved

public void relatedObjectSetMoved(IRelationshipClass relationshipClass,
                                  ISet objectsThatNeedToChange,
                                  ISet objectsThatChanged,
                                  ILine moveVector)
                           throws java.io.IOException,
                                  AutomationException
Description copied from interface: IRelatedObjectEvents
Notifies this object that a set of objects with relationships to the input set of objects moved.

Supported Platforms

Windows, Solaris, Linux

Remarks

The RelatedObjectSetMoved method is called when a set of objects in the related object class has moved. The objectsThatChanged argument represents the set of objects in the related object classes that have moved.

The objectsThatNeedToChange argument represents the set of objects in the object class of this object that are related to the objects that moved. This object is itself a member of the objectsThatNeedToChange.

Specified by:
relatedObjectSetMoved in interface IRelatedObjectEvents
Parameters:
relationshipClass - A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)
objectsThatNeedToChange - A reference to a com.esri.arcgis.system.ISet (in)
objectsThatChanged - A reference to a com.esri.arcgis.system.ISet (in)
moveVector - A reference to a com.esri.arcgis.geometry.ILine (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

relatedObjectRotated

public void relatedObjectRotated(IRelationshipClass relationshipClass,
                                 IObject objectThatChanged,
                                 IPoint origin,
                                 double angle)
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IRelatedObjectEvents
Notifies this object that a related object rotated.

Supported Platforms

Windows, Solaris, Linux

Remarks

The RelatedObjectRotated method is called when a related object has rotated.

Specified by:
relatedObjectRotated in interface IRelatedObjectEvents
Parameters:
relationshipClass - A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)
objectThatChanged - A reference to a com.esri.arcgis.geodatabase.IObject (in)
origin - A reference to a com.esri.arcgis.geometry.IPoint (in)
angle - The angle (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

relatedObjectSetRotated

public void relatedObjectSetRotated(IRelationshipClass relationshipClass,
                                    ISet objectsThatNeedToChange,
                                    ISet objectsThatChanged,
                                    IPoint origin,
                                    double angle)
                             throws java.io.IOException,
                                    AutomationException
Description copied from interface: IRelatedObjectEvents
Notifies this object that a set of objects with relationships to the input set of objects rotated.

Supported Platforms

Windows, Solaris, Linux

Remarks

The RelatedObjectSetRotated method is called when a set of objects in the related object class has moved. Its arguments are similar to the arguments for RelatedObjectSetMoved.

Specified by:
relatedObjectSetRotated in interface IRelatedObjectEvents
Parameters:
relationshipClass - A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)
objectsThatNeedToChange - A reference to a com.esri.arcgis.system.ISet (in)
objectsThatChanged - A reference to a com.esri.arcgis.system.ISet (in)
origin - A reference to a com.esri.arcgis.geometry.IPoint (in)
angle - The angle (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getSchematicDiagramClass

public ISchematicDiagramClass getSchematicDiagramClass()
                                                throws java.io.IOException,
                                                       AutomationException
Description copied from interface: ISchematicDiagram
Schematic diagram class related to the schematic diagram.

Specified by:
getSchematicDiagramClass in interface ISchematicDiagram
Returns:
A reference to a com.esri.arcgis.schematic.ISchematicDiagramClass
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getSchematicDiagramContainer

public ISchematicDiagramContainer getSchematicDiagramContainer()
                                                        throws java.io.IOException,
                                                               AutomationException
Description copied from interface: ISchematicDiagram
Schematic diagram container related to the schematic diagram. That is, the schematic folder or the schematic dataset for the schematic diagram storage.

Specified by:
getSchematicDiagramContainer in interface ISchematicDiagram
Returns:
A reference to a com.esri.arcgis.schematic.ISchematicDiagramContainer
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSchematicDiagramContainerByRef

public void setSchematicDiagramContainerByRef(ISchematicDiagramContainer diagramContainer)
                                       throws java.io.IOException,
                                              AutomationException
Description copied from interface: ISchematicDiagram
Schematic diagram container related to the schematic diagram. That is, the schematic folder or the schematic dataset for the schematic diagram storage.

Specified by:
setSchematicDiagramContainerByRef in interface ISchematicDiagram
Parameters:
diagramContainer - A reference to a com.esri.arcgis.schematic.ISchematicDiagramContainer (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setName

public void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException
Description copied from interface: ISchematicDiagram
Name of the schematic diagram.

Specified by:
setName in interface ISchematicDiagram
Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCreationDate

public java.util.Date getCreationDate()
                               throws java.io.IOException,
                                      AutomationException
Description copied from interface: ISchematicDiagram
Creation date of the schematic diagram.

Specified by:
getCreationDate in interface ISchematicDiagram
Returns:
The date
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setCreationDate

public void setCreationDate(java.util.Date date)
                     throws java.io.IOException,
                            AutomationException
Description copied from interface: ISchematicDiagram
Creation date of the schematic diagram.

Specified by:
setCreationDate in interface ISchematicDiagram
Parameters:
date - The date (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLastUpdateDate

public java.util.Date getLastUpdateDate()
                                 throws java.io.IOException,
                                        AutomationException
Description copied from interface: ISchematicDiagram
Last updating date of the schematic diagram.

Specified by:
getLastUpdateDate in interface ISchematicDiagram
Returns:
The date
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setLastUpdateDate

public void setLastUpdateDate(java.util.Date date)
                       throws java.io.IOException,
                              AutomationException
Description copied from interface: ISchematicDiagram
Last updating date of the schematic diagram.

Specified by:
setLastUpdateDate in interface ISchematicDiagram
Parameters:
date - The date (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getVersion

public java.lang.String getVersion()
                            throws java.io.IOException,
                                   AutomationException
Description copied from interface: ISchematicDiagram
Version of the database used to create the schematic diagram.

Specified by:
getVersion in interface ISchematicDiagram
Returns:
The versionName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setVersion

public void setVersion(java.lang.String versionName)
                throws java.io.IOException,
                       AutomationException
Description copied from interface: ISchematicDiagram
Version of the database used to create the schematic diagram.

Specified by:
setVersion in interface ISchematicDiagram
Parameters:
versionName - The versionName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCreator

public java.lang.String getCreator()
                            throws java.io.IOException,
                                   AutomationException
Description copied from interface: ISchematicDiagram
Name of the schematic diagram creator.

Specified by:
getCreator in interface ISchematicDiagram
Returns:
The name
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setCreator

public void setCreator(java.lang.String name)
                throws java.io.IOException,
                       AutomationException
Description copied from interface: ISchematicDiagram
Name of the schematic diagram creator.

Specified by:
setCreator in interface ISchematicDiagram
Parameters:
name - The name (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getLastUpdateBy

public java.lang.String getLastUpdateBy()
                                 throws java.io.IOException,
                                        AutomationException
Description copied from interface: ISchematicDiagram
Name of the last user that updated the schematic diagram.

Specified by:
getLastUpdateBy in interface ISchematicDiagram
Returns:
The name
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setLastUpdateBy

public void setLastUpdateBy(java.lang.String name)
                     throws java.io.IOException,
                            AutomationException
Description copied from interface: ISchematicDiagram
Name of the last user that updated the schematic diagram.

Specified by:
setLastUpdateBy in interface ISchematicDiagram
Parameters:
name - The name (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getBuilderPropertySet

public IPropertySet getBuilderPropertySet()
                                   throws java.io.IOException,
                                          AutomationException
Description copied from interface: ISchematicDiagram
Builder PropertySet related to the schematic diagram.

Specified by:
getBuilderPropertySet in interface ISchematicDiagram
Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

alterBuilderPropertySet

public void alterBuilderPropertySet(IPropertySet propertySet)
                             throws java.io.IOException,
                                    AutomationException
Description copied from interface: ISchematicDiagram
Changes the builder PropertySet related to the schematic diagram with the new specified builder PropertySet.

Specified by:
alterBuilderPropertySet in interface ISchematicDiagram
Parameters:
propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

alterPropertySet

public void alterPropertySet(IPropertySet propertySet)
                      throws java.io.IOException,
                             AutomationException
Description copied from interface: ISchematicDiagram
Changes the Schematic diagram PropertySet with the new specified diagram PropertySet.

Specified by:
alterPropertySet in interface ISchematicDiagram
Parameters:
propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicElements

public IEnumSchematicElement getSchematicElements()
                                           throws java.io.IOException,
                                                  AutomationException
Description copied from interface: ISchematicElementContainer
Schematic elements enumeration within the container.

Specified by:
getSchematicElements in interface ISchematicElementContainer
Returns:
A reference to a com.esri.arcgis.schematic.IEnumSchematicElement
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicElementsByType

public IEnumSchematicElement getSchematicElementsByType(int type)
                                                 throws java.io.IOException,
                                                        AutomationException
Description copied from interface: ISchematicElementContainer
Schematic elements referenced by the specified element type.

Specified by:
getSchematicElementsByType in interface ISchematicElementContainer
Parameters:
type - A com.esri.arcgis.schematic.esriSchematicElementType constant (in)
Returns:
A reference to a com.esri.arcgis.schematic.IEnumSchematicElement
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getSchematicElementByName

public ISchematicElement getSchematicElementByName(int type,
                                                   java.lang.String name)
                                            throws java.io.IOException,
                                                   AutomationException
Description copied from interface: ISchematicElementContainer
Schematic element referenced by the specified Name and related to specified element type.

Specified by:
getSchematicElementByName in interface ISchematicElementContainer
Parameters:
type - A com.esri.arcgis.schematic.esriSchematicElementType constant (in)
name - The name (in)
Returns:
A reference to a com.esri.arcgis.schematic.ISchematicElement
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

canDeleteSchematicElements

public boolean canDeleteSchematicElements()
                                   throws java.io.IOException,
                                          AutomationException
Description copied from interface: ISchematicElementContainerEdit
Indicates if schematic elements can be deleted within the container.

Specified by:
canDeleteSchematicElements in interface ISchematicElementContainerEdit
Returns:
The canDelete
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteSchematicElement

public void deleteSchematicElement(INgElement ngElement)
                            throws java.io.IOException,
                                   AutomationException
Description copied from interface: ISchematicElementContainerEdit
Delete a schematic element within the container.

Specified by:
deleteSchematicElement in interface ISchematicElementContainerEdit
Parameters:
ngElement - A reference to a com.esri.arcgis.schematic.INgElement (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws java.io.IOException,
                                             AutomationException
Description copied from interface: IGeoDataset
The spatial reference of the GeoDataset.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
getSpatialReference in interface IGeoDataset
Returns:
A reference to a com.esri.arcgis.geometry.ISpatialReference
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtent

public IEnvelope getExtent()
                    throws java.io.IOException,
                           AutomationException
Description copied from interface: IGeoDataset
The extent of the GeoDataset.

Supported Platforms

Windows, Solaris, Linux

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.

 

Specified by:
getExtent in interface IGeoDataset
Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

isCanAlterSpatialReference

public boolean isCanAlterSpatialReference()
                                   throws java.io.IOException,
                                          AutomationException
Description copied from interface: IGeoDatasetSchemaEdit
Indicates if the spatial reference of the dataset can be altered.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isCanAlterSpatialReference in interface IGeoDatasetSchemaEdit
Returns:
The canAlter
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

alterSpatialReference

public void alterSpatialReference(ISpatialReference spatialReference)
                           throws java.io.IOException,
                                  AutomationException
Description copied from interface: IGeoDatasetSchemaEdit
Alters the spatial reference of the dataset to match the coordinate system of the input spatial reference, does not reproject the data.

Supported Platforms

Windows, Solaris, Linux

Specified by:
alterSpatialReference in interface IGeoDatasetSchemaEdit
Parameters:
spatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getInvalidFields

public IFields getInvalidFields()
                         throws java.io.IOException,
                                AutomationException
Description copied from interface: IValidate
Returns all invalid fields.

Supported Platforms

Windows, Solaris, Linux

Description

GetInvalidFields function returns a IFields object containing the invalid fields of the given Row object.

Specified by:
getInvalidFields in interface IValidate
Returns:
A reference to a com.esri.arcgis.geodatabase.IFields
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getInvalidRules

public IEnumRule getInvalidRules()
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IValidate
The set of all invalid rules.

Supported Platforms

Windows, Solaris, Linux

Description

GetInvalidRules function returns a IEnumRule object containing all of the invalid rules associated with the given row object.

Specified by:
getInvalidRules in interface IValidate
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumRule
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getInvalidRulesByField

public IEnumRule getInvalidRulesByField(java.lang.String fieldName)
                                 throws java.io.IOException,
                                        AutomationException
Description copied from interface: IValidate
The set of all invalid rules for the specified field.

Supported Platforms

Windows, Solaris, Linux

Description

GetInvalidRulesByField function returns a IEnumRule object that contains all of the invalid rules associated with the FieldName parameter for the given row object.

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

validate

public boolean validate(java.lang.String[] errorMessage)
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: IValidate
Validates the row.

Supported Platforms

Windows, Solaris, Linux

Description

Validate function validates the given row and returns a boolean value of TRUE if the row is valid and FALSE if its not.

Remarks

Validate on a row occurs in five steps:

  1. Validate the subtype

  2. Validate the attribute rules

  3. Validate the network connectivity rules (if network feature)

  4. Validate the relationship rules

  5. 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.

Specified by:
validate in interface IValidate
Parameters:
errorMessage - The errorMessage (out: use single element array)
Returns:
The isValid
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.