com.esri.arcgis.schematic
Interface ISchematicRulesHelper

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
ISchematicRulesHelperProxy, SchematicRulesHelper

public interface ISchematicRulesHelper
extends java.io.Serializable

COM Interface 'ISchematicRulesHelper'. Generated 3/19/2015 1:21:00 PM from 'C:\ArcGIS\COM\esriSchematic.olb'

Description: 'Provides access to members that manage the schematic rule helper.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =


Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IIDe385bc7f_6a5c_4b7e_a8b4_560936776522
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 ISchematicInMemoryFeature alterLink(ISchematicInMemoryFeatureClass inMemoryFeatureClass, java.lang.String name, IObject object, IGeometry geometry, int dataSourceID, int objectSubID, java.lang.String fromName, java.lang.String toName, int flowDirection, int fromPort, int toPort)
          Modify or create a Link.
 ISchematicInMemoryFeature alterNode(ISchematicInMemoryFeatureClass inMemoryFeatureClass, java.lang.String name, IObject object, IGeometry geometry, int dataSourceID, int objectSubID)
          Modify or create a Node.
 ISchematicInMemoryFeature alterNodeOnLink(ISchematicInMemoryFeatureClass inMemoryFeatureClass, java.lang.String name, IObject object, IGeometry geometry, int dataSourceID, int objectSubID, java.lang.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.
 

Field Detail

IIDe385bc7f_6a5c_4b7e_a8b4_560936776522

static final int IIDe385bc7f_6a5c_4b7e_a8b4_560936776522
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

getRelationController

ISchematicRelationController getRelationController()
                                                   throws java.io.IOException,
                                                          AutomationException
Obtain the Relation Controller from the rules helper.

Returns:
A reference to a com.esri.arcgis.schematic.ISchematicRelationController
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isKeepVertices

boolean isKeepVertices()
                       throws java.io.IOException,
                              AutomationException
Indicates if the Schematic Rules Helper keeps the links vertices.

Returns:
The keepVertices
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setKeepVertices

void setKeepVertices(boolean keepVertices)
                     throws java.io.IOException,
                            AutomationException
Indicates if the Schematic Rules Helper keeps the links vertices.

Parameters:
keepVertices - The keepVertices (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

initHelper

void initHelper(ISchematicInMemoryDiagram inMemoryDiagram)
                throws java.io.IOException,
                       AutomationException
Initialize the helper with the input schematic diagram.

Parameters:
inMemoryDiagram - A reference to a com.esri.arcgis.schematic.ISchematicInMemoryDiagram (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findDataSourceID

int findDataSourceID(IWorkspace workspace,
                     boolean autoCreate)
                     throws java.io.IOException,
                            AutomationException
Obtain or create the datasource id of the input workspace.

Parameters:
workspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
autoCreate - The autoCreate (in)
Returns:
The dataSourceID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

alterNode

ISchematicInMemoryFeature alterNode(ISchematicInMemoryFeatureClass inMemoryFeatureClass,
                                    java.lang.String name,
                                    IObject object,
                                    IGeometry geometry,
                                    int dataSourceID,
                                    int objectSubID)
                                    throws java.io.IOException,
                                           AutomationException
Modify or create a Node.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

alterNodeOnLink

ISchematicInMemoryFeature alterNodeOnLink(ISchematicInMemoryFeatureClass inMemoryFeatureClass,
                                          java.lang.String name,
                                          IObject object,
                                          IGeometry geometry,
                                          int dataSourceID,
                                          int objectSubID,
                                          java.lang.String refLinkName,
                                          double distance,
                                          boolean asRatio)
                                          throws java.io.IOException,
                                                 AutomationException
Modify or create a NodeOnLink.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

alterLink

ISchematicInMemoryFeature alterLink(ISchematicInMemoryFeatureClass inMemoryFeatureClass,
                                    java.lang.String name,
                                    IObject object,
                                    IGeometry geometry,
                                    int dataSourceID,
                                    int objectSubID,
                                    java.lang.String fromName,
                                    java.lang.String toName,
                                    int flowDirection,
                                    int fromPort,
                                    int toPort)
                                    throws java.io.IOException,
                                           AutomationException
Modify or create a Link.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

reportAssociations

void reportAssociations(ISchematicInMemoryFeature fromInMemoryFeature,
                        ISchematicInMemoryFeature toInMemoryFeature)
                        throws java.io.IOException,
                               AutomationException
Report the associations of first schematic feature to the second schematic feature.

Parameters:
fromInMemoryFeature - A reference to a com.esri.arcgis.schematic.ISchematicInMemoryFeature (in)
toInMemoryFeature - A reference to a com.esri.arcgis.schematic.ISchematicInMemoryFeature (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

reportRelations

void reportRelations(ISchematicInMemoryFeature fromInMemoryFeature,
                     ISchematicInMemoryFeature toInMemoryFeature,
                     boolean recursif)
                     throws java.io.IOException,
                            AutomationException
Report the relations of first schematic feature to the second schematic feature.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLinkPoints

void setLinkPoints(ISchematicInMemoryFeatureLink inMemoryFeatureLink,
                   IPolyline polyline)
                   throws java.io.IOException,
                          AutomationException
Defines the vertices of the input schematic link.

Parameters:
inMemoryFeatureLink - A reference to a com.esri.arcgis.schematic.ISchematicInMemoryFeatureLink (in)
polyline - A reference to a com.esri.arcgis.geometry.IPolyline (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLinkPoints

IPolyline getLinkPoints(ISchematicInMemoryFeatureLink inMemoryFeatureLink,
                        boolean reverseOrder)
                        throws java.io.IOException,
                               AutomationException
Obtains the vertices of the input schematic link.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNodePoint

IPoint getNodePoint(ISchematicInMemoryFeatureNode inMemoryFeatureNode)
                    throws java.io.IOException,
                           AutomationException
Obtains the position of the input schematic node.

Parameters:
inMemoryFeatureNode - A reference to a com.esri.arcgis.schematic.ISchematicInMemoryFeatureNode (in)
Returns:
A reference to a com.esri.arcgis.geometry.IPoint
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDisplayedIncidentLinks

IEnumSchematicInMemoryFeature getDisplayedIncidentLinks(ISchematicInMemoryFeatureNode inMemoryNode,
                                                        int endPointType)
                                                        throws java.io.IOException,
                                                               AutomationException
Hide a schematic feature.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

hideFeature

void hideFeature(ISchematicInMemoryFeature inMemoryFeature)
                 throws java.io.IOException,
                        AutomationException
Hide a schematic feature.

Parameters:
inMemoryFeature - A reference to a com.esri.arcgis.schematic.ISchematicInMemoryFeature (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.