com.esri.arcgis.schematic
Class SchematicDataSource

java.lang.Object
  extended by com.esri.arcgis.schematic.SchematicDataSource
All Implemented Interfaces:
IWorkspaceHelper, com.esri.arcgis.interop.RemoteObjRef, ISchematicDataSource, Serializable

public class SchematicDataSource
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISchematicDataSource, IWorkspaceHelper

Schematic Datasource Object.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
SchematicDataSource(Object obj)
          Construct a SchematicDataSource using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 void alter(IUID cLSID, IMemoryBlobStream connectionBlob)
          Changes the schematic datasource with the new specified CLSID and the new specified connection definition.
 void delete()
          Deletes the schematic datasource.
 boolean equals(Object o)
          Compare this object with another
 IUID getCLSID()
          CLSID of the schematic datasource.
 IMemoryBlobStream getConnectionBlob()
          Blob stream that allows to connect to schematic datasource.
 int getID()
          ID of the schematic datasource.
 String getLabel()
          Label of the schematic datasource.
 String getName()
          Name of the schematic datasource.
 ISchematicDataset getSchematicDataset()
          Schematic dataset related to the schematic datasource.
 IWorkspace getWorkspace()
          The workspace for this workspace helper.
 int hashCode()
          the hashcode for this object
 void setLabel(String label)
          Label of the schematic datasource.
 void setName(String name)
          Name of the schematic datasource.
 
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

SchematicDataSource

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

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

Throws:
IOException - if there are interop problems SchematicDataSource theSchematicDataSource = (SchematicDataSource) 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

getSchematicDataset

public ISchematicDataset getSchematicDataset()
                                      throws IOException,
                                             AutomationException
Schematic dataset related to the schematic datasource.

Product Availability

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

Specified by:
getSchematicDataset in interface ISchematicDataSource
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.

getID

public int getID()
          throws IOException,
                 AutomationException
ID of the schematic datasource.

Product Availability

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

Specified by:
getID in interface ISchematicDataSource
Returns:
The iD
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ISchematicDataSource.getCLSID(), ISchematicDataSource.getLabel(), ISchematicDataSource.getName()

getName

public String getName()
               throws IOException,
                      AutomationException
Name of the schematic datasource.

Product Availability

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

Specified by:
getName in interface ISchematicDataSource
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ISchematicDataSource.getCLSID(), ISchematicDataSource.getLabel(), ISchematicDataSource.getID()

setName

public void setName(String name)
             throws IOException,
                    AutomationException
Name of the schematic datasource.

Product Availability

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

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

getLabel

public String getLabel()
                throws IOException,
                       AutomationException
Label of the schematic datasource.

Product Availability

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

Specified by:
getLabel in interface ISchematicDataSource
Returns:
The label
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ISchematicDataSource.getCLSID(), ISchematicDataSource.getID(), ISchematicDataSource.getName()

setLabel

public void setLabel(String label)
              throws IOException,
                     AutomationException
Label of the schematic datasource.

Product Availability

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

Specified by:
setLabel in interface ISchematicDataSource
Parameters:
label - The label (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCLSID

public IUID getCLSID()
              throws IOException,
                     AutomationException
CLSID of the schematic datasource.

Product Availability

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

Specified by:
getCLSID in interface ISchematicDataSource
Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ISchematicDataSource.getLabel(), ISchematicDataSource.getID(), ISchematicDataSource.getName()

getConnectionBlob

public IMemoryBlobStream getConnectionBlob()
                                    throws IOException,
                                           AutomationException
Blob stream that allows to connect to schematic datasource.

Product Availability

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

Specified by:
getConnectionBlob in interface ISchematicDataSource
Returns:
A reference to a com.esri.arcgis.system.IMemoryBlobStream
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

alter

public void alter(IUID cLSID,
                  IMemoryBlobStream connectionBlob)
           throws IOException,
                  AutomationException
Changes the schematic datasource with the new specified CLSID and the new specified connection definition.

Product Availability

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

Specified by:
alter in interface ISchematicDataSource
Parameters:
cLSID - A reference to a com.esri.arcgis.system.IUID (in)
connectionBlob - A reference to a com.esri.arcgis.system.IMemoryBlobStream (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

delete

public void delete()
            throws IOException,
                   AutomationException
Deletes the schematic datasource.

Product Availability

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

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

getWorkspace

public IWorkspace getWorkspace()
                        throws IOException,
                               AutomationException
The workspace for this workspace helper.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getWorkspace in interface IWorkspaceHelper
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.