Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.schematic
Class SchematicRulesHelper

java.lang.Object
  extended by com.esri.arcgis.schematic.SchematicRulesHelper
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, ISchematicRulesHelper, java.io.Serializable
public class SchematicRulesHelper
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ISchematicRulesHelper

COM Class 'SchematicRulesHelper'. Generated 3/19/2015 1:20:46 PM from 'C:\ArcGIS\COM\esriSchematic.olb'

Description '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 =

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.esri.arcgis.schematic.ISchematicRulesHelper
IID, IIDe385bc7f_6a5c_4b7e_a8b4_560936776522, xxDummy
 
Constructor Summary
SchematicRulesHelper()
          Constructs a SchematicRulesHelper using ArcGIS Engine.
SchematicRulesHelper(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SchematicRulesHelper theSchematicRulesHelper = (SchematicRulesHelper) obj;
 
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.
 boolean equals(java.lang.Object o)
          Compare this object with another
 int findDataSourceID(IWorkspace workspace, boolean autoCreate)
          Obtain or create the datasource id of the input workspace.
static java.lang.String getClsid()
          getClsid.
 IEnumSchematicInMemoryFeature getDisplayedIncidentLinks(ISchematicInMemoryFeatureNode inMemoryNode, int endPointType)
          Hide a schematic feature.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 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 release()
          Release a SchematicRulesHelper.
 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
 

Constructor Detail

SchematicRulesHelper

public SchematicRulesHelper()
                     throws java.io.IOException,
                            java.net.UnknownHostException
Constructs a SchematicRulesHelper using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

SchematicRulesHelper

public SchematicRulesHelper(java.lang.Object obj)
                     throws java.io.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:
java.io.IOException - if there are interop problems
Method Detail

getClsid

public static java.lang.String getClsid()
getClsid.

equals

public boolean equals(java.lang.Object o)
Compare this object with another

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a SchematicRulesHelper.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

getRelationController

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

Specified by:
getRelationController in interface ISchematicRulesHelper
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

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

Specified by:
isKeepVertices in interface ISchematicRulesHelper
Returns:
The keepVertices
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setKeepVertices

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

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

initHelper

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

Specified by:
initHelper in interface ISchematicRulesHelper
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

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

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

alterNode

public 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.

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

alterNodeOnLink

public 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.

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

alterLink

public 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.

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

reportAssociations

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

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:
java.io.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 java.io.IOException,
                            AutomationException
Report the relations of first schematic feature to the second schematic feature.

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

setLinkPoints

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

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

getLinkPoints

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

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

getNodePoint

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

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

getDisplayedIncidentLinks

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

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

hideFeature

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

Specified by:
hideFeature in interface ISchematicRulesHelper
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.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD