com.esri.arcgis.schematic
Class SchematicWorkspace

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, ISchematicDatabaseRelease, ISchematicWorkspace, Serializable

public class SchematicWorkspace
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISchematicWorkspace, ISchematicDatabaseRelease

Schematic Workspace Object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

SchematicWorkspace(Object obj)
Construct a SchematicWorkspace using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

ISchematicDataset	createSchematicDataset(String name, ISpatialReference spatialRef, String configKeyword) Creates a new schematic dataset.
boolean	equals(Object o) Compare this object with another
int	getBugfixVersion() Schematic database bugfix version number.
IName	getFullName() Schematic workspace full name.
int	getMajorVersion() Schematic database major version number.
int	getMinorVersion() Schematic database minor version number.
ISchematicDataset	getSchematicDatasetByID(int iD) Schematic dataset referenced by the specified ID.
ISchematicDataset	getSchematicDatasetByName(String name) Schematic dataset referenced by the specified Name.
IEnumSchematicDatasetName	getSchematicDatasetNames() List of the schematic dataset names within the current schematic workspace.
IEnumSchematicDataset	getSchematicDatasets() List of the schematic datasets within the current schematic workspace.
IWorkspace	getWorkspace() Current workspace.
int	hashCode() the hashcode for this object
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.
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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

SchematicWorkspace

public SchematicWorkspace(Object obj)
                   throws IOException

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

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

Throws:

IOException - if there are interop problems SchematicWorkspace theSchematicWorkspace = (SchematicWorkspace) obj;

Method Detail

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getWorkspace

public IWorkspace getWorkspace()
                        throws IOException,
                               AutomationException

Current workspace.

Product Availability

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

Specified by:

getWorkspace in interface ISchematicWorkspace

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFullName

public IName getFullName()
                  throws IOException,
                         AutomationException

Schematic workspace full name.

Product Availability

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

Specified by:

getFullName in interface ISchematicWorkspace

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicDatasetNames

public IEnumSchematicDatasetName getSchematicDatasetNames()
                                                   throws IOException,
                                                          AutomationException

List of the schematic dataset names within the current schematic workspace.

Product Availability

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

Specified by:

getSchematicDatasetNames in interface ISchematicWorkspace

Returns:

A reference to a com.esri.arcgis.schematic.IEnumSchematicDatasetName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicWorkspace.getSchematicDatasets()

getSchematicDatasets

public IEnumSchematicDataset getSchematicDatasets()
                                           throws IOException,
                                                  AutomationException

List of the schematic datasets within the current schematic workspace.

Product Availability

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

Specified by:

getSchematicDatasets in interface ISchematicWorkspace

Returns:

A reference to a com.esri.arcgis.schematic.IEnumSchematicDataset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicWorkspace.getSchematicDatasetNames()

getSchematicDatasetByID

public ISchematicDataset getSchematicDatasetByID(int iD)
                                          throws IOException,
                                                 AutomationException

Schematic dataset referenced by the specified ID.

Product Availability

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

Specified by:

getSchematicDatasetByID in interface ISchematicWorkspace

Parameters:

iD - The iD (in)

Returns:

A reference to a com.esri.arcgis.schematic.ISchematicDataset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicDatasetByName

public ISchematicDataset getSchematicDatasetByName(String name)
                                            throws IOException,
                                                   AutomationException

Schematic dataset referenced by the specified Name.

Product Availability

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

Specified by:

getSchematicDatasetByName in interface ISchematicWorkspace

Parameters:

name - The name (in)

Returns:

A reference to a com.esri.arcgis.schematic.ISchematicDataset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createSchematicDataset

public ISchematicDataset createSchematicDataset(String name,
                                                ISpatialReference spatialRef,
                                                String configKeyword)
                                         throws IOException,
                                                AutomationException

Creates a new schematic dataset.

Product Availability

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

Specified by:

createSchematicDataset in interface ISchematicWorkspace

Parameters:

name - The name (in)

spatialRef - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

configKeyword - The configKeyword (in, optional, pass null if not required)

Returns:

A reference to a com.esri.arcgis.schematic.ISchematicDataset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCanUpgrade

public boolean isCanUpgrade()
                     throws IOException,
                            AutomationException

Indicates if the schematic database can be upgraded with this interface. If not, then another utility must be used to upgrade it.

Product Availability

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

Specified by:

isCanUpgrade in interface ISchematicDatabaseRelease

Returns:

The canUpgrade

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicDatabaseRelease.upgrade()

isCurrentRelease

public boolean isCurrentRelease()
                         throws IOException,
                                AutomationException

Indicates if the schematic database is at the current release level.

Product Availability

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

Specified by:

isCurrentRelease in interface ISchematicDatabaseRelease

Returns:

The isCurrent

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMajorVersion

public int getMajorVersion()
                    throws IOException,
                           AutomationException

Schematic database major version number.

Product Availability

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

Specified by:

getMajorVersion in interface ISchematicDatabaseRelease

Returns:

The versionNumber

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicDatabaseRelease.getMinorVersion()

getMinorVersion

public int getMinorVersion()
                    throws IOException,
                           AutomationException

Schematic database minor version number.

Product Availability

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

Specified by:

getMinorVersion in interface ISchematicDatabaseRelease

Returns:

The versionNumber

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicDatabaseRelease.getMajorVersion()

getBugfixVersion

public int getBugfixVersion()
                     throws IOException,
                            AutomationException

Schematic database bugfix version number.

Product Availability

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

Specified by:

getBugfixVersion in interface ISchematicDatabaseRelease

Returns:

The versionNumber

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

upgrade

public void upgrade()
             throws IOException,
                    AutomationException

Upgrades the schematic database to the current release version level.

Product Availability

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

Specified by:

upgrade in interface ISchematicDatabaseRelease

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicDatabaseRelease.isCanUpgrade()