com.esri.arcgis.schematic
Interface ISchematicRulesHelper

All Superinterfaces:

Serializable

All Known Implementing Classes:

SchematicRulesHelper

public interface ISchematicRulesHelper
extends Serializable

Provides access to members that manage the schematic rule helper.

Product Availability

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

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.
int	findDataSourceID(IWorkspace workspace, boolean autoCreate) Obtain or create the datasource id of the input workspace.
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.
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.

Method Detail

getRelationController

ISchematicRelationController getRelationController()
                                                   throws IOException,
                                                          AutomationException

Obtain the Relation Controller from the rules helper.

Product Availability

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

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

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.

Returns:

The keepVertices

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setKeepVertices

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.

Parameters:

keepVertices - The keepVertices (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

initHelper

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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

Hide a schematic feature.

Product Availability

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

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

void hideFeature(ISchematicInMemoryFeature inMemoryFeature)
                 throws IOException,
                        AutomationException

Hide a schematic feature.

Product Availability

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

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.