com.esri.arcgis.schematic
Class SchematicDataSource

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

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

Schematic data source 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 alterSchematicConnection(ISchematicConnection schematicConnection)
          Changes the schematic connection of the schematic data source.
 ISchematicRecordset createSchematicRecordsetFromQuery(String queryString)
          Creates a schematic recorset from a query.
 ISchematicRecordset createSchematicRecordsetFromTable(String tableName)
          Creates a schematic recorset from a table name.
 void delete()
          Deletes the schematic data source.
 boolean equals(Object o)
          Compare this object with another
 IEnumSchematicDiagram findRelatedDiagrams()
          Finds the schematic diagrams which use the schematic data source.
 int getID()
          ID of the schematic data source.
 String getName()
          Name of the schematic data source.
 Object getObject()
          Object associated to the schematic data source.
 ISchematicConnection getSchematicConnection()
          Schematic connection associated to the schematic data source.
 ISchematicDataset getSchematicDataset()
          Schematic dataset the schematic data source belongs to.
 String[] getTableNames(boolean includeSystemTable)
          Names of the tables the schematic data source can access to.
 int hashCode()
          the hashcode for this object
 boolean hasRelatedDiagrams()
          Indicates whether or not some schematic diagrams use the schematic data source.
 boolean isUnused()
          Indicates whether or not the schematic data source is unused.
 void setName(String name)
          Name of the schematic data source.
 void setObjectByRef(Object object)
          Object associated to the schematic data source.
 
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

getName

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

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, ISchematicDataSource.getID()

setName

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

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.

getObject

public Object getObject()
                 throws IOException,
                        AutomationException
Object associated to the schematic data source.

Product Availability

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

Specified by:
getObject in interface ISchematicDataSource
Returns:
A reference to another Object (IUnknown)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setObjectByRef

public void setObjectByRef(Object object)
                    throws IOException,
                           AutomationException
Object associated to the schematic data source.

Product Availability

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

Specified by:
setObjectByRef in interface ISchematicDataSource
Parameters:
object - A reference to another Object (IUnknown) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicConnection

public ISchematicConnection getSchematicConnection()
                                            throws IOException,
                                                   AutomationException
Schematic connection associated to the schematic data source.

Product Availability

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

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

getSchematicDataset

public ISchematicDataset getSchematicDataset()
                                      throws IOException,
                                             AutomationException
Schematic dataset the schematic data source belongs to.

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 data source.

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, ISchematicDataSource.getName()

delete

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

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.

getTableNames

public String[] getTableNames(boolean includeSystemTable)
                       throws IOException,
                              AutomationException
Names of the tables the schematic data source can access to.

Product Availability

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

Specified by:
getTableNames in interface ISchematicDataSourceDesign
Parameters:
includeSystemTable - The includeSystemTable (in, optional, pass false if not required)
Returns:
The names
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createSchematicRecordsetFromTable

public ISchematicRecordset createSchematicRecordsetFromTable(String tableName)
                                                      throws IOException,
                                                             AutomationException
Creates a schematic recorset from a table name.

Product Availability

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

Specified by:
createSchematicRecordsetFromTable in interface ISchematicDataSourceDesign
Parameters:
tableName - The tableName (in)
Returns:
A reference to a com.esri.arcgis.schematic.ISchematicRecordset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createSchematicRecordsetFromQuery

public ISchematicRecordset createSchematicRecordsetFromQuery(String queryString)
                                                      throws IOException,
                                                             AutomationException
Creates a schematic recorset from a query.

Product Availability

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

Specified by:
createSchematicRecordsetFromQuery in interface ISchematicDataSourceDesign
Parameters:
queryString - The queryString (in)
Returns:
A reference to a com.esri.arcgis.schematic.ISchematicRecordset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findRelatedDiagrams

public IEnumSchematicDiagram findRelatedDiagrams()
                                          throws IOException,
                                                 AutomationException
Finds the schematic diagrams which use the schematic data source.

Product Availability

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

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

hasRelatedDiagrams

public boolean hasRelatedDiagrams()
                           throws IOException,
                                  AutomationException
Indicates whether or not some schematic diagrams use the schematic data source.

Product Availability

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

Specified by:
hasRelatedDiagrams in interface ISchematicDataSourceDesign
Returns:
The hasRelatedDiagrams
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUnused

public boolean isUnused()
                 throws IOException,
                        AutomationException
Indicates whether or not the schematic data source is unused.

Product Availability

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

Specified by:
isUnused in interface ISchematicDataSourceDesign
Returns:
The isUnused
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

alterSchematicConnection

public void alterSchematicConnection(ISchematicConnection schematicConnection)
                              throws IOException,
                                     AutomationException
Changes the schematic connection of the schematic data source.

Product Availability

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

Specified by:
alterSchematicConnection in interface ISchematicDataSourceDesign
Parameters:
schematicConnection - A reference to a com.esri.arcgis.schematic.ISchematicConnection (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.