com.esri.arcgis.schematic
Class SchematicDiagram

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

All Implemented Interfaces:

IDataset, IDatasetEditInfo, IGeoDataset, IMetadata, IMetadataEdit, IObject, IRelatedObjectEvents, IRow, IRowBuffer, IRowChanges, IRowCompare, IRowEdit, IRowEvents, ISchemaLock, IValidate, com.esri.arcgis.interop.RemoteObjRef, ISchematicDataSourceManager, ISchematicDiagram, ISchematicDiagramLock, ISchematicElementContainer, java.io.Serializable

public class SchematicDiagram
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IObject, IRow, IRowBuffer, IRowCompare, IRowChanges, IRowEdit, IRowEvents, IDataset, IDatasetEditInfo, IMetadata, IMetadataEdit, ISchemaLock, IRelatedObjectEvents, ISchematicDiagram, ISchematicElementContainer, ISchematicDiagramLock, IGeoDataset, IValidate, ISchematicDataSourceManager

COM Class 'SchematicDiagram'. Generated 3/19/2015 1:20:46 PM from 'C:\ArcGIS\COM\esriSchematic.olb'

Description 'A schematic diagram object.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.geodatabase.IRowCompare

IID, IID7d3e2831_6c5a_11d3_8a98_000000000000, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IRowChanges

IID, IID022f7462_69fa_11d3_9fd0_00c04f6bdd84, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IRowEdit

IID, IID192ada11_33f1_11d3_9f6a_00c04f6bdf0c, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IRowEvents

IID, IID8c387320_12c6_11d2_aad1_00c04fa37b81, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IDataset

IID, IID2d04c042_7766_11d0_b77d_00805f7ced21, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IDatasetEditInfo

IID, IID234c31c1_9740_11d1_89e2_006097aff44e, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IMetadata

IID, IID5de04a82_24e4_11d3_a641_0008c7d3ae50, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IMetadataEdit

IID, IID97fdb978_62a4_49c5_8252_b07837b33ee9, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.ISchemaLock

IID, IIDdca648e5_0fbb_11d3_80a5_00c04f686238, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IRelatedObjectEvents

IID, IID22b0069a_8895_11d2_8a0d_006097aff44e, xxDummy

Fields inherited from interface com.esri.arcgis.schematic.ISchematicDiagram

IID, IIDbc0ef326_bbe0_4fe5_af19_9b721c39cd73, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IObject

IID1afcdb34_ac09_11d2_8a1e_006097aff44e

Fields inherited from interface com.esri.arcgis.schematic.ISchematicElementContainer

IID, IID5d6055b2_6ded_4458_9df9_4a42004a01d1, xxDummy

Fields inherited from interface com.esri.arcgis.schematic.ISchematicDiagramLock

IID, IIDfe236081_8c6b_4e60_bf6d_484292cbf05d, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IValidate

IID, IID80e4ff2c_475d_11d2_9932_0000f80372b4, xxDummy

Fields inherited from interface com.esri.arcgis.schematic.ISchematicDataSourceManager

IID, IIDcefdc10b_983d_40a4_aab8_86bae257e8ac, xxDummy

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.
boolean	canCopy() True if this dataset can be copied.
boolean	canDelete() True if this dataset can be deleted.
boolean	canRename() True if this dataset can be renamed.
void	changeSchemaLock(int schemaLock) Changes a schema lock.
IDataset	copy(java.lang.String copyName, IWorkspace copyWorkspace) Copies this dataset to a new dataset with the specified name.
void	delete() Deletes the row.
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.
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.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.util.Date	getLastModificationDate() Last modification date of the schematic diagram.
java.util.Date	getLastUpdateDate() Last updating date of the schematic diagram.
IPropertySet	getMetadata() The PropertySet containing metadata.
java.lang.String	getModifiedBy() Name of the user that modified the schematic diagram.
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.String	getUpdatedBy() Name of the last user that updated the schematic diagram.
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	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 otherRow) 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	isLocked() Indicates if the diagram is locked or not.
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() An after event that is fired when a custom object is changed.
void	onDelete() An after event that is fired when a custom object is deleted.
void	onInitialize() An after event that is fired when a custom object is initialized.
void	onNew() An after event that is fired when a custom object is Stored for the first time.
void	onValidate() 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	release() Release a SchematicDiagram.
void	rename(java.lang.String name) Renames this Dataset.
void	replaceDataSource(java.lang.String initialDataSourceName, java.lang.String replacingDataSourceName, ITrackCancel trackCancel) Replaces a schematic diagram referenced data sources.
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	setLastModificationDate(java.util.Date date) Last modification date of the schematic diagram.
void	setLastUpdateDate(java.util.Date date) Last updating date of the schematic diagram.
void	setMetadata(IPropertySet propertySet) The PropertySet containing metadata.
void	setModifiedBy(java.lang.String name) Name of the user that modified the schematic diagram.
void	setName(java.lang.String name) Name of the schematic diagram.
void	setSchematicDiagramContainerByRef(ISchematicDiagramContainer diagramContainer) Schematic diagram container related to the schematic diagram.
void	setUpdatedBy(java.lang.String name) Name of the last user that updated 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

Throws:

java.io.IOException - if there are interop problems SchematicDiagram theSchematicDiagram = (SchematicDiagram) obj;

Method Detail

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a SchematicDiagram.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

esri_getClass

public IObjectClass esri_getClass()
                           throws java.io.IOException,
                                  AutomationException

The Object Class for the row.

Specified by:

esri_getClass in interface IObject

Returns:

A reference to a com.esri.arcgis.geodatabase.IObjectClass

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasOID

public boolean isHasOID()
                 throws java.io.IOException,
                        AutomationException

Indicates if the row has an OID.

Specified by:

isHasOID in interface IRow

Returns:

The hasOID

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOID

public int getOID()
           throws java.io.IOException,
                  AutomationException

The OID for the row.

Specified by:

getOID in interface IRow

Returns:

The oID

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTable

public ITable getTable()
                throws java.io.IOException,
                       AutomationException

The Table for the row.

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

Stores the row.

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

Deletes the row.

Specified by:

delete in interface IDataset

Specified by:

delete in interface IRow

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValue

public java.lang.Object getValue(int index)
                          throws java.io.IOException,
                                 AutomationException

The value of the field with the specified index.

Specified by:

getValue in interface IRowBuffer

Parameters:

index - The index (in)

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setValue

public void setValue(int index,
                     java.lang.Object value)
              throws java.io.IOException,
                     AutomationException

The value of the field with the specified index.

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

The fields Collection for this row buffer.

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 otherRow)
                throws java.io.IOException,
                       AutomationException

Indicates if the rows (which may be from two different versions) are the same (oid + values).

Specified by:

isEqual in interface IRowCompare

Parameters:

otherRow - 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

Indicates whether the value of the field at the specified index has changed since the last call to Store on the Row object.

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

The value of the field at the specified index immediately after the last call to Store on the Row object.

Specified by:

getOriginalValue in interface IRowChanges

Parameters:

index - The index (in)

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteSet

public void deleteSet(ISet rows)
               throws java.io.IOException,
                      AutomationException

Deletes the set of rows.

Specified by:

deleteSet in interface IRowEdit

Parameters:

rows - A reference to a com.esri.arcgis.system.ISet (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onChanged

public void onChanged()
               throws java.io.IOException,
                      AutomationException

An after event that is fired when a custom object is changed.

Specified by:

onChanged in interface IRowEvents

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onDelete

public void onDelete()
              throws java.io.IOException,
                     AutomationException

An after event that is fired when a custom object is deleted.

Specified by:

onDelete in interface IRowEvents

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onInitialize

public void onInitialize()
                  throws java.io.IOException,
                         AutomationException

An after event that is fired when a custom object is initialized.

Specified by:

onInitialize in interface IRowEvents

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onNew

public void onNew()
           throws java.io.IOException,
                  AutomationException

An after event that is fired when a custom object is Stored for the first time.

Specified by:

onNew in interface IRowEvents

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onValidate

public void onValidate()
                throws java.io.IOException,
                       AutomationException

An after event that is fired when a custom object is validated.

Specified by:

onValidate in interface IRowEvents

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

The name of the Dataset.

Specified by:

getName in interface IDataset

Specified by:

getName in interface ISchematicDiagram

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFullName

public IName getFullName()
                  throws java.io.IOException,
                         AutomationException

The associated name object.

Specified by:

getFullName in interface IDataset

Returns:

A reference to a com.esri.arcgis.system.IName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBrowseName

public java.lang.String getBrowseName()
                               throws java.io.IOException,
                                      AutomationException

The browse name of the dataset.

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

The browse name of the dataset.

Specified by:

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

getType

public int getType()
            throws java.io.IOException,
                   AutomationException

The type of the Dataset.

Specified by:

getType in interface IDataset

Returns:

A com.esri.arcgis.geodatabase.esriDatasetType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCategory

public java.lang.String getCategory()
                             throws java.io.IOException,
                                    AutomationException

The category of the dataset.

Specified by:

getCategory in interface IDataset

Returns:

The category

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSubsets

public IEnumDataset getSubsets()
                        throws java.io.IOException,
                               AutomationException

Datasets contained within this dataset.

Specified by:

getSubsets in interface IDataset

Returns:

A reference to a com.esri.arcgis.geodatabase.IEnumDataset

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWorkspace

public IWorkspace getWorkspace()
                        throws java.io.IOException,
                               AutomationException

The workspace containing 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

The set of properties for the dataset.

Specified by:

getPropertySet in interface IDataset

Specified by:

getPropertySet in interface ISchematicDiagram

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canCopy

public boolean canCopy()
                throws java.io.IOException,
                       AutomationException

True if this dataset can be copied.

Specified by:

canCopy in interface IDataset

Returns:

The canCopy

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

copy

public IDataset copy(java.lang.String copyName,
                     IWorkspace copyWorkspace)
              throws java.io.IOException,
                     AutomationException

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

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canDelete

public boolean canDelete()
                  throws java.io.IOException,
                         AutomationException

True if this dataset can be deleted.

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

True if this dataset can be renamed.

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

Renames this Dataset.

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

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

Specified by:

isCanEdit in interface IDatasetEditInfo

Returns:

The canEdit

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

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

Specified by:

isCanUndo in interface IDatasetEditInfo

Returns:

The canUndo

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

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

Specified by:

isCanRedo in interface IDatasetEditInfo

Returns:

The canUndo

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMetadata

public IPropertySet getMetadata()
                         throws java.io.IOException,
                                AutomationException

The PropertySet containing metadata.

Specified by:

getMetadata in interface IMetadata

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMetadata

public void setMetadata(IPropertySet propertySet)
                 throws java.io.IOException,
                        AutomationException

The PropertySet containing metadata.

Specified by:

setMetadata in interface IMetadata

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.

synchronize

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

Updates metadata with the current properties; may create 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

Indicates if metadata can be edited.

Specified by:

isCanEditMetadata in interface IMetadataEdit

Returns:

The canEdit

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

changeSchemaLock

public void changeSchemaLock(int schemaLock)
                      throws java.io.IOException,
                             AutomationException

Changes a schema lock.

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

The list of current locks.

Specified by:

getCurrentSchemaLocks in interface ISchemaLock

Parameters:

schemaLockInfo - A reference to a com.esri.arcgis.geodatabase.IEnumSchemaLockInfo (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

relatedObjectChanged

public void relatedObjectChanged(IRelationshipClass relationshipClass,
                                 IObject objectThatChanged)
                          throws java.io.IOException,
                                 AutomationException

Notifies this object that a related object 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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

relatedObjectMoved

public void relatedObjectMoved(IRelationshipClass relationshipClass,
                               IObject objectThatChanged,
                               ILine moveVector)
                        throws java.io.IOException,
                               AutomationException

Notifies this object that a related object 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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

relatedObjectSetMoved

public void relatedObjectSetMoved(IRelationshipClass relationshipClass,
                                  ISet objectsThatNeedToChange,
                                  ISet objectsThatChanged,
                                  ILine moveVector)
                           throws java.io.IOException,
                                  AutomationException

Notifies this object that a set of objects with relationships to the input set of objects moved.

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

Notifies this object that a related object 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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

relatedObjectSetRotated

public void relatedObjectSetRotated(IRelationshipClass relationshipClass,
                                    ISet objectsThatNeedToChange,
                                    ISet objectsThatChanged,
                                    IPoint origin,
                                    double angle)
                             throws java.io.IOException,
                                    AutomationException

Notifies this object that a set of objects with relationships to the input set of objects rotated.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicDiagramClass

public ISchematicDiagramClass getSchematicDiagramClass()
                                                throws java.io.IOException,
                                                       AutomationException

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicDiagramContainer

public ISchematicDiagramContainer getSchematicDiagramContainer()
                                                        throws java.io.IOException,
                                                               AutomationException

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

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

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

Creation date of the schematic diagram.

Specified by:

getCreationDate in interface ISchematicDiagram

Returns:

The date

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCreationDate

public void setCreationDate(java.util.Date date)
                     throws java.io.IOException,
                            AutomationException

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

Last updating date of the schematic diagram.

Specified by:

getLastUpdateDate in interface ISchematicDiagram

Returns:

The date

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLastUpdateDate

public void setLastUpdateDate(java.util.Date date)
                       throws java.io.IOException,
                              AutomationException

Last updating date of the schematic diagram.

Specified by:

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

getVersion

public java.lang.String getVersion()
                            throws java.io.IOException,
                                   AutomationException

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

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

Name of the schematic diagram creator.

Specified by:

getCreator in interface ISchematicDiagram

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCreator

public void setCreator(java.lang.String name)
                throws java.io.IOException,
                       AutomationException

Name of the schematic diagram creator.

Specified by:

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

getUpdatedBy

public java.lang.String getUpdatedBy()
                              throws java.io.IOException,
                                     AutomationException

Name of the last user that updated the schematic diagram.

Specified by:

getUpdatedBy in interface ISchematicDiagram

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUpdatedBy

public void setUpdatedBy(java.lang.String name)
                  throws java.io.IOException,
                         AutomationException

Name of the last user that updated the schematic diagram.

Specified by:

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

getBuilderPropertySet

public IPropertySet getBuilderPropertySet()
                                   throws java.io.IOException,
                                          AutomationException

Builder PropertySet related to the schematic diagram.

Specified by:

getBuilderPropertySet in interface ISchematicDiagram

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

alterBuilderPropertySet

public void alterBuilderPropertySet(IPropertySet propertySet)
                             throws java.io.IOException,
                                    AutomationException

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

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.

getLastModificationDate

public java.util.Date getLastModificationDate()
                                       throws java.io.IOException,
                                              AutomationException

Last modification date of the schematic diagram.

Specified by:

getLastModificationDate in interface ISchematicDiagram

Returns:

The date

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLastModificationDate

public void setLastModificationDate(java.util.Date date)
                             throws java.io.IOException,
                                    AutomationException

Last modification date of the schematic diagram.

Specified by:

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

getModifiedBy

public java.lang.String getModifiedBy()
                               throws java.io.IOException,
                                      AutomationException

Name of the user that modified the schematic diagram.

Specified by:

getModifiedBy in interface ISchematicDiagram

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setModifiedBy

public void setModifiedBy(java.lang.String name)
                   throws java.io.IOException,
                          AutomationException

Name of the user that modified the schematic diagram.

Specified by:

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

getSchematicElements

public IEnumSchematicElement getSchematicElements()
                                           throws java.io.IOException,
                                                  AutomationException

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

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicElementByName

public ISchematicElement getSchematicElementByName(int type,
                                                   java.lang.String name)
                                            throws java.io.IOException,
                                                   AutomationException

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isLocked

public boolean isLocked()
                 throws java.io.IOException,
                        AutomationException

Indicates if the diagram is locked or not.

Specified by:

isLocked in interface ISchematicDiagramLock

Returns:

The isLocked

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws java.io.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:

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

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.

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.

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.

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:

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

Returns all invalid fields.

Specified by:

getInvalidFields in interface IValidate

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.

getInvalidRules

public IEnumRule getInvalidRules()
                          throws java.io.IOException,
                                 AutomationException

The set of all invalid rules.

Specified by:

getInvalidRules in interface IValidate

Returns:

A reference to a com.esri.arcgis.geodatabase.IEnumRule

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInvalidRulesByField

public IEnumRule getInvalidRulesByField(java.lang.String fieldName)
                                 throws java.io.IOException,
                                        AutomationException

The set of all invalid rules for the specified field.

Specified by:

getInvalidRulesByField in interface IValidate

Parameters:

fieldName - The fieldName (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IEnumRule

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

validate

public boolean validate(java.lang.String[] errorMessage)
                 throws java.io.IOException,
                        AutomationException

Validates the row.

Specified by:

validate in interface IValidate

Parameters:

errorMessage - The errorMessage (out: use single element array)

Returns:

The isValid

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

replaceDataSource

public void replaceDataSource(java.lang.String initialDataSourceName,
                              java.lang.String replacingDataSourceName,
                              ITrackCancel trackCancel)
                       throws java.io.IOException,
                              AutomationException

Replaces a schematic diagram referenced data sources.

Specified by:

replaceDataSource in interface ISchematicDataSourceManager

Parameters:

initialDataSourceName - The initialDataSourceName (in)

replacingDataSourceName - The replacingDataSourceName (in)

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in, optional, pass 0 if not required)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.