com.esri.arcgis.schematic
Class SchematicRulesHelper

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, ISchematicRulesHelper, Serializable

public class SchematicRulesHelper
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISchematicRulesHelper

Schematic rule helper.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

SchematicRulesHelper()
Constructs a SchematicRulesHelper using ArcGIS Engine.

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

Method Summary

ISchematicInMemoryFeature	alterLink(ISchematicInMemoryFeatureClass inMemoryFeatureClass, String name, IObject object, IGeometry geometry, int dataSourceID, int objectSubID, String fromName, String toName, int flowDirection, int fromPort, int toPort) Modify or create a Link.
ISchematicInMemoryFeature	alterNode(ISchematicInMemoryFeatureClass inMemoryFeatureClass, String name, IObject object, IGeometry geometry, int dataSourceID, int objectSubID) Modify or create a Node.
ISchematicInMemoryFeature	alterNodeOnLink(ISchematicInMemoryFeatureClass inMemoryFeatureClass, String name, IObject object, IGeometry geometry, int dataSourceID, int objectSubID, String refLinkName, double distance, boolean asRatio) Modify or create a NodeOnLink.
boolean	equals(Object o) Compare this object with another
int	findDataSourceID(IWorkspace workspace, boolean autoCreate) Obtain or create the datasource id of the input workspace.
static String	getClsid() getClsid.
IEnumSchematicInMemoryFeature	getDisplayedIncidentLinks(ISchematicInMemoryFeatureNode inMemoryNode, int endPointType) Hide a schematic feature.
IPolyline	getLinkPoints(ISchematicInMemoryFeatureLink inMemoryFeatureLink, boolean reverseOrder) Obtains the vertices of the input schematic link.
IPoint	getNodePoint(ISchematicInMemoryFeatureNode inMemoryFeatureNode) Obtains the position of the input schematic node.
ISchematicRelationController	getRelationController() Obtain the Relation Controller from the rules helper.
int	hashCode() the hashcode for this object
void	hideFeature(ISchematicInMemoryFeature inMemoryFeature) Hide a schematic feature.
void	initHelper(ISchematicInMemoryDiagram inMemoryDiagram) Initialize the helper with the input schematic diagram.
boolean	isKeepVertices() Indicates if the Schematic Rules Helper keeps the links vertices.
void	reportAssociations(ISchematicInMemoryFeature fromInMemoryFeature, ISchematicInMemoryFeature toInMemoryFeature) Report the associations of first schematic feature to the second schematic feature.
void	reportRelations(ISchematicInMemoryFeature fromInMemoryFeature, ISchematicInMemoryFeature toInMemoryFeature, boolean recursif) Report the relations of first schematic feature to the second schematic feature.
void	setKeepVertices(boolean keepVertices) Indicates if the Schematic Rules Helper keeps the links vertices.
void	setLinkPoints(ISchematicInMemoryFeatureLink inMemoryFeatureLink, IPolyline polyline) Defines the vertices of the input schematic link.

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

SchematicRulesHelper

public SchematicRulesHelper()
                     throws IOException,
                            UnknownHostException

Constructs a SchematicRulesHelper using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

SchematicRulesHelper

public SchematicRulesHelper(Object obj)
                     throws IOException

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

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

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

getRelationController

public ISchematicRelationController getRelationController()
                                                   throws IOException,
                                                          AutomationException

Obtain the Relation Controller from the rules helper.

Product Availability

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

Specified by:

getRelationController in interface ISchematicRulesHelper

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isKeepVertices

public boolean isKeepVertices()
                       throws IOException,
                              AutomationException

Indicates if the Schematic Rules Helper keeps the links vertices.

Product Availability

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

Specified by:

isKeepVertices in interface ISchematicRulesHelper

Returns:

The keepVertices

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setKeepVertices

public void setKeepVertices(boolean keepVertices)
                     throws IOException,
                            AutomationException

Indicates if the Schematic Rules Helper keeps the links vertices.

Product Availability

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

Specified by:

setKeepVertices in interface ISchematicRulesHelper

Parameters:

keepVertices - The keepVertices (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

initHelper

public void initHelper(ISchematicInMemoryDiagram inMemoryDiagram)
                throws IOException,
                       AutomationException

Initialize the helper with the input schematic diagram.

Product Availability

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

Specified by:

initHelper in interface ISchematicRulesHelper

Parameters:

inMemoryDiagram - A reference to a com.esri.arcgis.schematic.ISchematicInMemoryDiagram (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findDataSourceID

public int findDataSourceID(IWorkspace workspace,
                            boolean autoCreate)
                     throws IOException,
                            AutomationException

Obtain or create the datasource id of the input workspace.

Product Availability

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

Specified by:

findDataSourceID in interface ISchematicRulesHelper

Parameters:

workspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)

autoCreate - The autoCreate (in)

Returns:

The dataSourceID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

alterNode

public ISchematicInMemoryFeature alterNode(ISchematicInMemoryFeatureClass inMemoryFeatureClass,
                                           String name,
                                           IObject object,
                                           IGeometry geometry,
                                           int dataSourceID,
                                           int objectSubID)
                                    throws IOException,
                                           AutomationException

Modify or create a Node.

Product Availability

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

Specified by:

alterNode in interface ISchematicRulesHelper

Parameters:

inMemoryFeatureClass - A reference to a com.esri.arcgis.schematic.ISchematicInMemoryFeatureClass (in)

name - The name (in)

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

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

dataSourceID - The dataSourceID (in)

objectSubID - The objectSubID (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

alterNodeOnLink

public ISchematicInMemoryFeature alterNodeOnLink(ISchematicInMemoryFeatureClass inMemoryFeatureClass,
                                                 String name,
                                                 IObject object,
                                                 IGeometry geometry,
                                                 int dataSourceID,
                                                 int objectSubID,
                                                 String refLinkName,
                                                 double distance,
                                                 boolean asRatio)
                                          throws IOException,
                                                 AutomationException

Modify or create a NodeOnLink.

Product Availability

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

Specified by:

alterNodeOnLink in interface ISchematicRulesHelper

Parameters:

inMemoryFeatureClass - A reference to a com.esri.arcgis.schematic.ISchematicInMemoryFeatureClass (in)

name - The name (in)

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

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

dataSourceID - The dataSourceID (in)

objectSubID - The objectSubID (in)

refLinkName - The refLinkName (in)

distance - The distance (in)

asRatio - The asRatio (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

alterLink

public ISchematicInMemoryFeature alterLink(ISchematicInMemoryFeatureClass inMemoryFeatureClass,
                                           String name,
                                           IObject object,
                                           IGeometry geometry,
                                           int dataSourceID,
                                           int objectSubID,
                                           String fromName,
                                           String toName,
                                           int flowDirection,
                                           int fromPort,
                                           int toPort)
                                    throws IOException,
                                           AutomationException

Modify or create a Link.

Product Availability

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

Specified by:

alterLink in interface ISchematicRulesHelper

Parameters:

inMemoryFeatureClass - A reference to a com.esri.arcgis.schematic.ISchematicInMemoryFeatureClass (in)

name - The name (in)

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

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

dataSourceID - The dataSourceID (in)

objectSubID - The objectSubID (in)

fromName - The fromName (in)

toName - The toName (in)

flowDirection - A com.esri.arcgis.geodatabase.esriFlowDirection constant (in)

fromPort - The fromPort (in)

toPort - The toPort (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reportAssociations

public void reportAssociations(ISchematicInMemoryFeature fromInMemoryFeature,
                               ISchematicInMemoryFeature toInMemoryFeature)
                        throws IOException,
                               AutomationException

Report the associations of first schematic feature to the second schematic feature.

Product Availability

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

Specified by:

reportAssociations in interface ISchematicRulesHelper

Parameters:

fromInMemoryFeature - A reference to a com.esri.arcgis.schematic.ISchematicInMemoryFeature (in)

toInMemoryFeature - A reference to a com.esri.arcgis.schematic.ISchematicInMemoryFeature (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reportRelations

public void reportRelations(ISchematicInMemoryFeature fromInMemoryFeature,
                            ISchematicInMemoryFeature toInMemoryFeature,
                            boolean recursif)
                     throws IOException,
                            AutomationException

Report the relations of first schematic feature to the second schematic feature.

Product Availability

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

Specified by:

reportRelations in interface ISchematicRulesHelper

Parameters:

fromInMemoryFeature - A reference to a com.esri.arcgis.schematic.ISchematicInMemoryFeature (in)

toInMemoryFeature - A reference to a com.esri.arcgis.schematic.ISchematicInMemoryFeature (in)

recursif - The recursif (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLinkPoints

public void setLinkPoints(ISchematicInMemoryFeatureLink inMemoryFeatureLink,
                          IPolyline polyline)
                   throws IOException,
                          AutomationException

Defines the vertices of the input schematic link.

Product Availability

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

Specified by:

setLinkPoints in interface ISchematicRulesHelper

Parameters:

inMemoryFeatureLink - A reference to a com.esri.arcgis.schematic.ISchematicInMemoryFeatureLink (in)

polyline - A reference to a com.esri.arcgis.geometry.IPolyline (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLinkPoints

public IPolyline getLinkPoints(ISchematicInMemoryFeatureLink inMemoryFeatureLink,
                               boolean reverseOrder)
                        throws IOException,
                               AutomationException

Obtains the vertices of the input schematic link.

Product Availability

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

Specified by:

getLinkPoints in interface ISchematicRulesHelper

Parameters:

inMemoryFeatureLink - A reference to a com.esri.arcgis.schematic.ISchematicInMemoryFeatureLink (in)

reverseOrder - The reverseOrder (in)

Returns:

A reference to a com.esri.arcgis.geometry.IPolyline

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNodePoint

public IPoint getNodePoint(ISchematicInMemoryFeatureNode inMemoryFeatureNode)
                    throws IOException,
                           AutomationException

Obtains the position of the input schematic node.

Product Availability

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

Specified by:

getNodePoint in interface ISchematicRulesHelper

Parameters:

inMemoryFeatureNode - A reference to a com.esri.arcgis.schematic.ISchematicInMemoryFeatureNode (in)

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayedIncidentLinks

public IEnumSchematicInMemoryFeature getDisplayedIncidentLinks(ISchematicInMemoryFeatureNode inMemoryNode,
                                                               int endPointType)
                                                        throws IOException,
                                                               AutomationException

Hide a schematic feature.

Product Availability

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

Specified by:

getDisplayedIncidentLinks in interface ISchematicRulesHelper

Parameters:

inMemoryNode - A reference to a com.esri.arcgis.schematic.ISchematicInMemoryFeatureNode (in)

endPointType - A com.esri.arcgis.schematic.esriSchematicEndPointType constant (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hideFeature

public void hideFeature(ISchematicInMemoryFeature inMemoryFeature)
                 throws IOException,
                        AutomationException

Hide a schematic feature.

Product Availability

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

Specified by:

hideFeature in interface ISchematicRulesHelper

Parameters:

inMemoryFeature - A reference to a com.esri.arcgis.schematic.ISchematicInMemoryFeature (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.