com.esri.arcgis.schematic
Class SchematicDataset

java.lang.Object
  extended by com.esri.arcgis.schematic.SchematicDataset
All Implemented Interfaces:
IDataset, IDatasetEditInfo, IMetadata, IMetadataEdit, ISchemaLock, com.esri.arcgis.interop.RemoteObjRef, ISchematicDatabaseRelease, ISchematicDataset, ISchematicDatasetDesign, ISchematicDatasetImport, ISchematicDatasetLock, ISchematicDataSourceContainer, ISchematicDiagramClassContainer, ISchematicDiagramContainer, ISchematicElementClassContainer, ISchematicFolderContainer, java.io.Serializable

public class SchematicDataset
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ISchematicDataset, IDataset, IMetadata, IMetadataEdit, ISchemaLock, ISchematicDatasetLock, ISchematicFolderContainer, ISchematicDiagramContainer, IDatasetEditInfo, ISchematicDatabaseRelease, ISchematicDatasetImport, ISchematicDatasetDesign, ISchematicDataSourceContainer, ISchematicElementClassContainer, ISchematicDiagramClassContainer

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

Description 'Provides access to members that manage the schematic dataset.' 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.schematic.ISchematicDataset
IID, IID20bab3e3_38dd_44a7_aa4a_450bf978a541, 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.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.schematic.ISchematicDatasetLock
IID, IIDc29dcb51_cb90_4b31_ad50_703f8d89a58f, xxDummy
 
Fields inherited from interface com.esri.arcgis.schematic.ISchematicFolderContainer
IID, IID41fd8da6_930d_49b8_91bb_1217ee77c6c2, xxDummy
 
Fields inherited from interface com.esri.arcgis.schematic.ISchematicDiagramContainer
IID, IID441ed561_78df_4bdf_821d_6e72fc82742b, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IDatasetEditInfo
IID, IID234c31c1_9740_11d1_89e2_006097aff44e, xxDummy
 
Fields inherited from interface com.esri.arcgis.schematic.ISchematicDatabaseRelease
IID, IIDd4187c5b_e7fd_4947_bb6d_dba833a9f33e, xxDummy
 
Fields inherited from interface com.esri.arcgis.schematic.ISchematicDatasetImport
IID, IIDbda9bac4_5a6a_4086_a434_d0f2c0e55d4b, xxDummy
 
Fields inherited from interface com.esri.arcgis.schematic.ISchematicDatasetDesign
IID, IIDc842adcd_c6ff_4139_a811_97212c801feb, xxDummy
 
Fields inherited from interface com.esri.arcgis.schematic.ISchematicDataSourceContainer
IID, IID06b8ba4a_afaf_456f_8c64_99609466a8a8, xxDummy
 
Fields inherited from interface com.esri.arcgis.schematic.ISchematicElementClassContainer
IID, IID4230a0cc_f3d2_4c90_87fd_e38bf4bf376d, xxDummy
 
Fields inherited from interface com.esri.arcgis.schematic.ISchematicDiagramClassContainer
IID, IID577fd095_257f_45b1_8e94_cae217e5a162, xxDummy
 
Constructor Summary
SchematicDataset(java.lang.Object obj)
          Construct a SchematicDataset using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 void addISchematicAlgorithmEventsListener(ISchematicAlgorithmEvents theListener)
          addISchematicAlgorithmEventsListener.
 void addISchematicDatasetEventsListener(ISchematicDatasetEvents theListener)
          addISchematicDatasetEventsListener.
 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.
 ISchematicDataSource createSchematicDataSource(java.lang.String name, ISchematicConnection schematicConnection)
          Creates a new schematic data source inside the schematic dataset.
 ISchematicDiagramClass createSchematicDiagramClass(java.lang.String name)
          Creates a new schematic diagram class inside the schematic dataset.
 ISchematicElementClass createSchematicElementClass(java.lang.String name, int type)
          Creates a new schematic element class inside the schematic dataset.
 ISchematicFolder createSchematicFolder(java.lang.String name)
          Creates a new schematic folder in the schematic dataset.
 void delete()
          Deletes this dataset.
 boolean equals(java.lang.Object o)
          Compare this object with another
 IEnumSchematicDataSource findUnusedDataSources(ITrackCancel cancelTracker)
          Retrieves the unused schematic data sources inside the schematic dataset.
 java.lang.String getBrowseName()
          The browse name of the dataset.
 int getBugfixVersion()
          Schematic database bugfix version number.
 java.lang.String getCategory()
          The category of the dataset.
 java.lang.String getCurrentLock()
          Schematic Dataset Lock status.
 void getCurrentSchemaLocks(IEnumSchemaLockInfo[] schemaLockInfo)
          The list of current locks.
 ISchematicDataSource getDefaultSchematicDataSource()
          Cuurent schematic data source.
 IName getFullName()
          The associated name object.
 int getID()
          ID of the schematic dataset.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 int getMajorVersion()
          Schematic database major version number.
 IPropertySet getMetadata()
          The PropertySet containing metadata.
 int getMinorVersion()
          Schematic database minor version number.
 java.lang.String getName()
          The name of the Dataset.
 IPropertySet getPropertySet()
          The set of properties for the dataset.
 ISchematicDataSource getSchematicDataSource(java.lang.String name)
          Schematic data source referenced by the specified Name.
 IEnumSchematicDataSource getSchematicDataSources()
          Schematic data sources enumeration within the schematic data source container.
 ISchematicDiagram getSchematicDiagramByID(ISchematicDiagramClass schematicDiagramClass, int iD)
          Schematic diagram referenced by the specified ID.
 ISchematicDiagram getSchematicDiagramByName(ISchematicDiagramClass schematicDiagramClass, java.lang.String name)
          Schematic diagram referenced by the specified Name.
 ISchematicDiagramClass getSchematicDiagramClass(java.lang.String name)
          Schematic diagram class referenced by the specified Name.
 IEnumSchematicDiagramClass getSchematicDiagramClasses()
          Schematic diagram classes enumeration within the schematic diagram class container.
 IEnumSchematicDiagram getSchematicDiagrams()
          Schematic diagrams enumeration within the schematic dataset or schematic folder container.
 ISchematicElementClass getSchematicElementClass(java.lang.String name)
          Schematic diagram class referenced by the specified Name.
 IEnumSchematicElementClass getSchematicElementClasses()
          Schematic element classes enumeration within the schematic element class container.
 ISchematicFolder getSchematicFolderByID(int iD)
          Schematic folder referenced by the specified ID.
 ISchematicFolder getSchematicFolderByName(java.lang.String name)
          Schematic folder referenced by the specified Name.
 IEnumSchematicFolder getSchematicFolders()
          Schematic folders enumeration within the schematic dataset or the schematic folder container.
 IEnumSchematicInMemoryDiagram getSchematicInMemoryDiagrams()
          Opened schematic in memory diagrams of the schematic dataset.
 ISchematicWorkspace getSchematicWorkspace()
          Schematic workspace related to the schematic dataset.
 IEnumDataset getSubsets()
          Datasets contained within this dataset.
 int getType()
          The type of the Dataset.
 IWorkspace getWorkspace()
          The workspace containing this dataset.
 int hashCode()
          the hashcode for this object
 void importFeatureLayer(IFeatureLayer featureLayer, ISchematicDiagramClass schematicDiagramClass, boolean symbology, boolean overwriteSymbols, boolean staticStorage)
          Imports a feature layer and associates the created schematic element class to the specified schematic diagram class.
 void importObjectClass(IObjectClass objectClass, ISchematicDiagramClass schematicDiagramClass, boolean forceType, int type)
          Imports an object class and associates the created schematic element class to the specified schematic diagram class.
 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 isCanUpgrade()
          Indicates if the schematic database can be upgraded with this interface.
 boolean isCurrentRelease()
          Indicates if the schematic database is at the current release level.
 boolean isDesignMode()
          Indicates if the schematic dataset design mode is activated.
 boolean isHasChanged()
          Indicates if the schematic dataset has changed.
 void release()
          Release a SchematicDataset.
 void removeISchematicAlgorithmEventsListener(ISchematicAlgorithmEvents theListener)
          removeISchematicAlgorithmEventsListener.
 void removeISchematicDatasetEventsListener(ISchematicDatasetEvents theListener)
          removeISchematicDatasetEventsListener.
 void rename(java.lang.String name)
          Renames this Dataset.
 void save(int saveVersion, boolean canDeleteNonEmptyTables)
          Saves the schematic dataset.
 void setBrowseName(java.lang.String name)
          The browse name of the dataset.
 void setCurrentLock(java.lang.String lockInfo)
          Schematic Dataset Lock status.
 void setDesignMode(boolean designMode)
          Indicates if the schematic dataset design mode is activated.
 void setHasChanged(boolean hasChanged)
          Indicates if the schematic dataset has changed.
 void setMetadata(IPropertySet propertySet)
          The PropertySet containing metadata.
 void synchronize(int action, int interval)
          Updates metadata with the current properties; may create metadata if it doesn't already exist.
 void upgrade()
          Upgrades the schematic database to the current release version level.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SchematicDataset

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

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

Throws:
java.io.IOException - if there are interop problems SchematicDataset theSchematicDataset = (SchematicDataset) 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

addISchematicDatasetEventsListener

public void addISchematicDatasetEventsListener(ISchematicDatasetEvents theListener)
                                        throws java.io.IOException
addISchematicDatasetEventsListener. Listen to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.schematic.ISchematicDatasetEvents interface.
Throws:
java.io.IOException - If there are communications problems.

removeISchematicDatasetEventsListener

public void removeISchematicDatasetEventsListener(ISchematicDatasetEvents theListener)
                                           throws java.io.IOException
removeISchematicDatasetEventsListener. Stop listening to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.schematic.ISchematicDatasetEvents interface.
Throws:
java.io.IOException - If there are communications problems.

addISchematicAlgorithmEventsListener

public void addISchematicAlgorithmEventsListener(ISchematicAlgorithmEvents theListener)
                                          throws java.io.IOException
addISchematicAlgorithmEventsListener. Listen to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.schematic.ISchematicAlgorithmEvents interface.
Throws:
java.io.IOException - If there are communications problems.

removeISchematicAlgorithmEventsListener

public void removeISchematicAlgorithmEventsListener(ISchematicAlgorithmEvents theListener)
                                             throws java.io.IOException
removeISchematicAlgorithmEventsListener. Stop listening to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.schematic.ISchematicAlgorithmEvents interface.
Throws:
java.io.IOException - If there are communications problems.

release

public void release()
Release a SchematicDataset.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

getID

public int getID()
          throws java.io.IOException,
                 AutomationException
ID of the schematic dataset.

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

getSchematicWorkspace

public ISchematicWorkspace getSchematicWorkspace()
                                          throws java.io.IOException,
                                                 AutomationException
Schematic workspace related to the schematic dataset.

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

isHasChanged

public boolean isHasChanged()
                     throws java.io.IOException,
                            AutomationException
Indicates if the schematic dataset has changed.

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

setHasChanged

public void setHasChanged(boolean hasChanged)
                   throws java.io.IOException,
                          AutomationException
Indicates if the schematic dataset has changed.

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

save

public void save(int saveVersion,
                 boolean canDeleteNonEmptyTables)
          throws java.io.IOException,
                 AutomationException
Saves the schematic dataset.

Specified by:
save in interface ISchematicDataset
Parameters:
saveVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)
canDeleteNonEmptyTables - The canDeleteNonEmptyTables (in, optional, pass false if not required)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicInMemoryDiagrams

public IEnumSchematicInMemoryDiagram getSchematicInMemoryDiagrams()
                                                           throws java.io.IOException,
                                                                  AutomationException
Opened schematic in memory diagrams of the schematic dataset.

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

createSchematicDiagramClass

public ISchematicDiagramClass createSchematicDiagramClass(java.lang.String name)
                                                   throws java.io.IOException,
                                                          AutomationException
Creates a new schematic diagram class inside the schematic dataset.

Specified by:
createSchematicDiagramClass in interface ISchematicDataset
Parameters:
name - The name (in)
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.

createSchematicElementClass

public ISchematicElementClass createSchematicElementClass(java.lang.String name,
                                                          int type)
                                                   throws java.io.IOException,
                                                          AutomationException
Creates a new schematic element class inside the schematic dataset.

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

createSchematicDataSource

public ISchematicDataSource createSchematicDataSource(java.lang.String name,
                                                      ISchematicConnection schematicConnection)
                                               throws java.io.IOException,
                                                      AutomationException
Creates a new schematic data source inside the schematic dataset.

Specified by:
createSchematicDataSource in interface ISchematicDataset
Parameters:
name - The name (in)
schematicConnection - A reference to a com.esri.arcgis.schematic.ISchematicConnection (in)
Returns:
A reference to a com.esri.arcgis.schematic.ISchematicDataSource
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createSchematicFolder

public ISchematicFolder createSchematicFolder(java.lang.String name)
                                       throws java.io.IOException,
                                              AutomationException
Creates a new schematic folder in the schematic dataset.

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

getDefaultSchematicDataSource

public ISchematicDataSource getDefaultSchematicDataSource()
                                                   throws java.io.IOException,
                                                          AutomationException
Cuurent schematic data source.

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

isDesignMode

public boolean isDesignMode()
                     throws java.io.IOException,
                            AutomationException
Indicates if the schematic dataset design mode is activated.

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

setDesignMode

public void setDesignMode(boolean designMode)
                   throws java.io.IOException,
                          AutomationException
Indicates if the schematic dataset design mode is activated.

Specified by:
setDesignMode in interface ISchematicDataset
Parameters:
designMode - The designMode (in)
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
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
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.

delete

public void delete()
            throws java.io.IOException,
                   AutomationException
Deletes this dataset.

Specified by:
delete in interface IDataset
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.

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.

setCurrentLock

public void setCurrentLock(java.lang.String lockInfo)
                    throws java.io.IOException,
                           AutomationException
Schematic Dataset Lock status.

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

getCurrentLock

public java.lang.String getCurrentLock()
                                throws java.io.IOException,
                                       AutomationException
Schematic Dataset Lock status.

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

getSchematicFolders

public IEnumSchematicFolder getSchematicFolders()
                                         throws java.io.IOException,
                                                AutomationException
Schematic folders enumeration within the schematic dataset or the schematic folder container.

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

getSchematicFolderByID

public ISchematicFolder getSchematicFolderByID(int iD)
                                        throws java.io.IOException,
                                               AutomationException
Schematic folder referenced by the specified ID.

Specified by:
getSchematicFolderByID in interface ISchematicFolderContainer
Parameters:
iD - The iD (in)
Returns:
A reference to a com.esri.arcgis.schematic.ISchematicFolder
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicFolderByName

public ISchematicFolder getSchematicFolderByName(java.lang.String name)
                                          throws java.io.IOException,
                                                 AutomationException
Schematic folder referenced by the specified Name.

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

getSchematicDiagrams

public IEnumSchematicDiagram getSchematicDiagrams()
                                           throws java.io.IOException,
                                                  AutomationException
Schematic diagrams enumeration within the schematic dataset or schematic folder container.

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

getSchematicDiagramByID

public ISchematicDiagram getSchematicDiagramByID(ISchematicDiagramClass schematicDiagramClass,
                                                 int iD)
                                          throws java.io.IOException,
                                                 AutomationException
Schematic diagram referenced by the specified ID.

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

getSchematicDiagramByName

public ISchematicDiagram getSchematicDiagramByName(ISchematicDiagramClass schematicDiagramClass,
                                                   java.lang.String name)
                                            throws java.io.IOException,
                                                   AutomationException
Schematic diagram referenced by the specified Name.

Specified by:
getSchematicDiagramByName in interface ISchematicDiagramContainer
Parameters:
schematicDiagramClass - A reference to a com.esri.arcgis.schematic.ISchematicDiagramClass (in)
name - The name (in)
Returns:
A reference to a com.esri.arcgis.schematic.ISchematicDiagram
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.

isCanUpgrade

public boolean isCanUpgrade()
                     throws java.io.IOException,
                            AutomationException
Indicates if the schematic database can be upgraded with this interface. If not, then another utility must be used to upgrade it.

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

isCurrentRelease

public boolean isCurrentRelease()
                         throws java.io.IOException,
                                AutomationException
Indicates if the schematic database is at the current release level.

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

getMajorVersion

public int getMajorVersion()
                    throws java.io.IOException,
                           AutomationException
Schematic database major version number.

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

getMinorVersion

public int getMinorVersion()
                    throws java.io.IOException,
                           AutomationException
Schematic database minor version number.

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

getBugfixVersion

public int getBugfixVersion()
                     throws java.io.IOException,
                            AutomationException
Schematic database bugfix version number.

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

upgrade

public void upgrade()
             throws java.io.IOException,
                    AutomationException
Upgrades the schematic database to the current release version level.

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

importObjectClass

public void importObjectClass(IObjectClass objectClass,
                              ISchematicDiagramClass schematicDiagramClass,
                              boolean forceType,
                              int type)
                       throws java.io.IOException,
                              AutomationException
Imports an object class and associates the created schematic element class to the specified schematic diagram class.

Specified by:
importObjectClass in interface ISchematicDatasetImport
Parameters:
objectClass - A reference to a com.esri.arcgis.geodatabase.IObjectClass (in)
schematicDiagramClass - A reference to a com.esri.arcgis.schematic.ISchematicDiagramClass (in)
forceType - The forceType (in)
type - A com.esri.arcgis.schematic.esriSchematicElementType constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

importFeatureLayer

public void importFeatureLayer(IFeatureLayer featureLayer,
                               ISchematicDiagramClass schematicDiagramClass,
                               boolean symbology,
                               boolean overwriteSymbols,
                               boolean staticStorage)
                        throws java.io.IOException,
                               AutomationException
Imports a feature layer and associates the created schematic element class to the specified schematic diagram class.

Specified by:
importFeatureLayer in interface ISchematicDatasetImport
Parameters:
featureLayer - A reference to a com.esri.arcgis.carto.IFeatureLayer (in)
schematicDiagramClass - A reference to a com.esri.arcgis.schematic.ISchematicDiagramClass (in)
symbology - The symbology (in)
overwriteSymbols - The overwriteSymbols (in)
staticStorage - The staticStorage (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findUnusedDataSources

public IEnumSchematicDataSource findUnusedDataSources(ITrackCancel cancelTracker)
                                               throws java.io.IOException,
                                                      AutomationException
Retrieves the unused schematic data sources inside the schematic dataset.

Specified by:
findUnusedDataSources in interface ISchematicDatasetDesign
Parameters:
cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Returns:
A reference to a com.esri.arcgis.schematic.IEnumSchematicDataSource
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicDataSources

public IEnumSchematicDataSource getSchematicDataSources()
                                                 throws java.io.IOException,
                                                        AutomationException
Schematic data sources enumeration within the schematic data source container.

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

getSchematicDataSource

public ISchematicDataSource getSchematicDataSource(java.lang.String name)
                                            throws java.io.IOException,
                                                   AutomationException
Schematic data source referenced by the specified Name.

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

getSchematicElementClasses

public IEnumSchematicElementClass getSchematicElementClasses()
                                                      throws java.io.IOException,
                                                             AutomationException
Schematic element classes enumeration within the schematic element class container.

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

getSchematicElementClass

public ISchematicElementClass getSchematicElementClass(java.lang.String name)
                                                throws java.io.IOException,
                                                       AutomationException
Schematic diagram class referenced by the specified Name.

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

getSchematicDiagramClasses

public IEnumSchematicDiagramClass getSchematicDiagramClasses()
                                                      throws java.io.IOException,
                                                             AutomationException
Schematic diagram classes enumeration within the schematic diagram class container.

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

getSchematicDiagramClass

public ISchematicDiagramClass getSchematicDiagramClass(java.lang.String name)
                                                throws java.io.IOException,
                                                       AutomationException
Schematic diagram class referenced by the specified Name.

Specified by:
getSchematicDiagramClass in interface ISchematicDiagramClassContainer
Parameters:
name - The name (in)
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.