com.esri.arcgis.schematic
Class SchematicLinker

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, ISchematicLinker, ISchematicObjectLinker, ISchematicObjectLinkerEdit, Serializable

public class SchematicLinker
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISchematicLinker, ISchematicObjectLinker, ISchematicObjectLinkerEdit

Schematic linker object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

SchematicLinker()
Constructs a SchematicLinker using ArcGIS Engine.

SchematicLinker(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SchematicLinker theSchematicLinker = (SchematicLinker) obj;

Method Summary

void	associate(INgElement ngElement, IObject object) Associates the specified graphic element with the specified object.
void	dissociate(INgElement ngElement, IObject object) Dissociate the specified graphic element with the specified object.
boolean	equals(Object o) Compare this object with another
INgElements	findNgElementsFromObject(IObject object) Retrieves the set of schematic elements associated with the specified feature.
INgElements	findNgElementsInLayerFromObject(IObject object, ILayer layer) Retrieves the set of schematic elements associated with the specified feature from the specified schematic layer.
INgElements	findNgElementsInLayerFromObjects(IEnumObject enumObject, ILayer layer, ITrackCancel cancelTracker) Retrieves the set of schematic elements associated with the specified set of objects from the specified schematic layer.
IEnumObject	findObjectsFromNgElement(INgElement ngElement) Retrieves the set of objects associated with the specified schematic element.
IEnumObject	findObjectsFromNgElements(INgElements ngElements, ITrackCancel cancelTracker) Retrieves the set of objects associated with the specified set of schematic elements.
static String	getClsid() getClsid.
int	hashCode() the hashcode for this object
void	loadSchematicAssociations(ISchematicDiagram diagram) Loads the schematic associations for the specified schematic diagram in memory.
void	reportAssociations(INgElement fromNgElement, INgElement toNgElement) Reports the associations defined for the specified 'FromNgElement' graphic element onto the specified 'ToNgElement' graphic element.

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

SchematicLinker

public SchematicLinker()
                throws IOException,
                       UnknownHostException

Constructs a SchematicLinker using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

SchematicLinker

public SchematicLinker(Object obj)
                throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SchematicLinker theSchematicLinker = (SchematicLinker) obj;

Construct a SchematicLinker using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to SchematicLinker.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

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

loadSchematicAssociations

public void loadSchematicAssociations(ISchematicDiagram diagram)
                               throws IOException,
                                      AutomationException

Loads the schematic associations for the specified schematic diagram in memory.

Product Availability

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

Specified by:

loadSchematicAssociations in interface ISchematicLinker

Parameters:

diagram - A reference to a com.esri.arcgis.schematic.ISchematicDiagram (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findObjectsFromNgElement

public IEnumObject findObjectsFromNgElement(INgElement ngElement)
                                     throws IOException,
                                            AutomationException

Retrieves the set of objects associated with the specified schematic element.

Product Availability

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

Specified by:

findObjectsFromNgElement in interface ISchematicObjectLinker

Parameters:

ngElement - A reference to a com.esri.arcgis.schematic.INgElement (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findObjectsFromNgElements

public IEnumObject findObjectsFromNgElements(INgElements ngElements,
                                             ITrackCancel cancelTracker)
                                      throws IOException,
                                             AutomationException

Retrieves the set of objects associated with the specified set of schematic elements.

Product Availability

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

Specified by:

findObjectsFromNgElements in interface ISchematicObjectLinker

Parameters:

ngElements - A reference to a com.esri.arcgis.schematic.INgElements (in)

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findNgElementsFromObject

public INgElements findNgElementsFromObject(IObject object)
                                     throws IOException,
                                            AutomationException

Retrieves the set of schematic elements associated with the specified feature.

Product Availability

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

Specified by:

findNgElementsFromObject in interface ISchematicObjectLinker

Parameters:

object - A reference to a com.esri.arcgis.geodatabase.IObject (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findNgElementsInLayerFromObject

public INgElements findNgElementsInLayerFromObject(IObject object,
                                                   ILayer layer)
                                            throws IOException,
                                                   AutomationException

Retrieves the set of schematic elements associated with the specified feature from the specified schematic layer.

Product Availability

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

Specified by:

findNgElementsInLayerFromObject in interface ISchematicObjectLinker

Parameters:

object - A reference to a com.esri.arcgis.geodatabase.IObject (in)

layer - A reference to a com.esri.arcgis.carto.ILayer (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findNgElementsInLayerFromObjects

public INgElements findNgElementsInLayerFromObjects(IEnumObject enumObject,
                                                    ILayer layer,
                                                    ITrackCancel cancelTracker)
                                             throws IOException,
                                                    AutomationException

Retrieves the set of schematic elements associated with the specified set of objects from the specified schematic layer.

Product Availability

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

Specified by:

findNgElementsInLayerFromObjects in interface ISchematicObjectLinker

Parameters:

enumObject - A reference to a com.esri.arcgis.geodatabase.IEnumObject (in)

layer - A reference to a com.esri.arcgis.carto.ILayer (in)

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reportAssociations

public void reportAssociations(INgElement fromNgElement,
                               INgElement toNgElement)
                        throws IOException,
                               AutomationException

Reports the associations defined for the specified 'FromNgElement' graphic element onto the specified 'ToNgElement' graphic element.

Product Availability

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

Specified by:

reportAssociations in interface ISchematicObjectLinkerEdit

Parameters:

fromNgElement - A reference to a com.esri.arcgis.schematic.INgElement (in)

toNgElement - A reference to a com.esri.arcgis.schematic.INgElement (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

associate

public void associate(INgElement ngElement,
                      IObject object)
               throws IOException,
                      AutomationException

Associates the specified graphic element with the specified object.

Product Availability

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

Specified by:

associate in interface ISchematicObjectLinkerEdit

Parameters:

ngElement - A reference to a com.esri.arcgis.schematic.INgElement (in)

object - A reference to a com.esri.arcgis.geodatabase.IObject (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

dissociate

public void dissociate(INgElement ngElement,
                       IObject object)
                throws IOException,
                       AutomationException

Dissociate the specified graphic element with the specified object.

Product Availability

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

Specified by:

dissociate in interface ISchematicObjectLinkerEdit

Parameters:

ngElement - A reference to a com.esri.arcgis.schematic.INgElement (in)

object - A reference to a com.esri.arcgis.geodatabase.IObject (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.