com.esri.arcgis.schematic
Class SchematicAlgoPartialOverlappingLinks

java.lang.Object
  extended by com.esri.arcgis.schematic.SchematicAlgoPartialOverlappingLinks
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, ISchematicAlgoPartialOverlappingLinks, ISchematicAlgorithm, Serializable

public class SchematicAlgoPartialOverlappingLinks
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISchematicAlgoPartialOverlappingLinks, ISchematicAlgorithm

Partial Overlapping Links schematic algorithm object.

Description

This object is new at ArcGIS 9.3.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
SchematicAlgoPartialOverlappingLinks()
          Constructs a SchematicAlgoPartialOverlappingLinks using ArcGIS Engine.
SchematicAlgoPartialOverlappingLinks(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SchematicAlgoPartialOverlappingLinks theSchematicAlgoPartialOverlappingLinks = (SchematicAlgoPartialOverlappingLinks) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
 void execute(ISchematicLayer schematicLayer, ITrackCancel cancelTracker)
          Execute the schematic algorithm.
 String getAlgorithmCLSID()
          The CLSID of the algorithm.
 double getAttractNodeLinkFactor()
          Parameter value used to quickly decrease the schematic link displacement between link and node when they are connected together.
 double getAttractNodesFactor()
          Parameter value used to quickly decrease the schematic nodes displacement between a node and its original position.
 double getBufferWidth()
          BufferZone width will be used to find links that overlap.
static String getClsid()
          getClsid.
 double getGapDistance()
          Distance between the partial links that are overlapping so that they are separated.
 String getLabel()
          The label of the algorithm.
 int getNumberOfIterations()
          Number of Partial Overlapping Links schematic algorithm iterations executed before the final result is shown.
 IPropertySet getPropertySet()
          The property set of the algorithm contains a collection of its parameters and their values.
 double getRepelLinksFactor()
          Parameter value used to quickly increase the schematic links displacement for links that are very close.
 double getRepelNodeLinkFactor()
          Parameter value used to quickly increase the schematic link displacement between link and node when they are not connected together.
 double getRepelNodesFactor()
          Parameter value used to quickly increase the schematic nodes displacement for nodes that are very close.
 ISchematicDiagramClassName getSchematicDiagramClassName()
          The diagram class object used to initialize the algorithm.
 int hashCode()
          the hashcode for this object
 boolean isAvailable()
          Indicates if the algorithm is currently available.
 boolean isEnabled(ISchematicLayer schematicLayer)
          Indicates if the algorithm is currently enabled.
 boolean isGeneralizeResult()
          Indicates if resulting geometries are generalized.
 boolean isLeftRightHint()
          Indicates if relative left or right positions between links is kept as much as possible.
 boolean isOverridable()
          Indicates if the algorithm properties page is editable from ArcMap; that is, enabling the Layout Properties button in ArcMap.
 boolean isUseEndNode()
          Indicates if the algorithm use end nodes.
 boolean isUseRootNode()
          Indicates if the algorithm use root nodes.
 void setAttractNodeLinkFactor(double dAttractNodeLinkFactor)
          Parameter value used to quickly decrease the schematic link displacement between link and node when they are connected together.
 void setAttractNodesFactor(double dAttractNodesFactor)
          Parameter value used to quickly decrease the schematic nodes displacement between a node and its original position.
 void setAvailable(boolean available)
          Indicates if the algorithm is currently available.
 void setBufferWidth(double dBufferWidth)
          BufferZone width will be used to find links that overlap.
 void setGapDistance(double dGapDistance)
          Distance between the partial links that are overlapping so that they are separated.
 void setGeneralizeResult(boolean pVal)
          Indicates if resulting geometries are generalized.
 void setLabel(String label)
          The label of the algorithm.
 void setLeftRightHint(boolean pVal)
          Indicates if relative left or right positions between links is kept as much as possible.
 void setNumberOfIterations(int pVal)
          Number of Partial Overlapping Links schematic algorithm iterations executed before the final result is shown.
 void setOverridable(boolean pOverridable)
          Indicates if the algorithm properties page is editable from ArcMap; that is, enabling the Layout Properties button in ArcMap.
 void setPropertySet(IPropertySet propertySet)
          The property set of the algorithm contains a collection of its parameters and their values.
 void setRepelLinksFactor(double dRepelLinksFactor)
          Parameter value used to quickly increase the schematic links displacement for links that are very close.
 void setRepelNodeLinkFactor(double dRepelNodeLinkFactor)
          Parameter value used to quickly increase the schematic link displacement between link and node when they are not connected together.
 void setRepelNodesFactor(double dRepelNodesFactor)
          Parameter value used to quickly increase the schematic nodes displacement for nodes that are very close.
 void setSchematicDiagramClassNameByRef(ISchematicDiagramClassName schematicDiagramClassName)
          The diagram class object used to initialize the algorithm.
 
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

SchematicAlgoPartialOverlappingLinks

public SchematicAlgoPartialOverlappingLinks()
                                     throws IOException,
                                            UnknownHostException
Constructs a SchematicAlgoPartialOverlappingLinks using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

SchematicAlgoPartialOverlappingLinks

public SchematicAlgoPartialOverlappingLinks(Object obj)
                                     throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SchematicAlgoPartialOverlappingLinks theSchematicAlgoPartialOverlappingLinks = (SchematicAlgoPartialOverlappingLinks) obj;

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

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

setBufferWidth

public void setBufferWidth(double dBufferWidth)
                    throws IOException,
                           AutomationException
BufferZone width will be used to find links that overlap.

Product Availability

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

Specified by:
setBufferWidth in interface ISchematicAlgoPartialOverlappingLinks
Parameters:
dBufferWidth - The dBufferWidth (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBufferWidth

public double getBufferWidth()
                      throws IOException,
                             AutomationException
BufferZone width will be used to find links that overlap.

Product Availability

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

Specified by:
getBufferWidth in interface ISchematicAlgoPartialOverlappingLinks
Returns:
The dBufferWidth
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGapDistance

public void setGapDistance(double dGapDistance)
                    throws IOException,
                           AutomationException
Distance between the partial links that are overlapping so that they are separated.

Product Availability

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

Specified by:
setGapDistance in interface ISchematicAlgoPartialOverlappingLinks
Parameters:
dGapDistance - The dGapDistance (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGapDistance

public double getGapDistance()
                      throws IOException,
                             AutomationException
Distance between the partial links that are overlapping so that they are separated.

Product Availability

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

Specified by:
getGapDistance in interface ISchematicAlgoPartialOverlappingLinks
Returns:
The dGapDistance
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRepelNodesFactor

public void setRepelNodesFactor(double dRepelNodesFactor)
                         throws IOException,
                                AutomationException
Parameter value used to quickly increase the schematic nodes displacement for nodes that are very close.

Product Availability

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

Specified by:
setRepelNodesFactor in interface ISchematicAlgoPartialOverlappingLinks
Parameters:
dRepelNodesFactor - The dRepelNodesFactor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRepelNodesFactor

public double getRepelNodesFactor()
                           throws IOException,
                                  AutomationException
Parameter value used to quickly increase the schematic nodes displacement for nodes that are very close.

Product Availability

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

Specified by:
getRepelNodesFactor in interface ISchematicAlgoPartialOverlappingLinks
Returns:
The dRepelNodesFactor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRepelLinksFactor

public void setRepelLinksFactor(double dRepelLinksFactor)
                         throws IOException,
                                AutomationException
Parameter value used to quickly increase the schematic links displacement for links that are very close.

Product Availability

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

Specified by:
setRepelLinksFactor in interface ISchematicAlgoPartialOverlappingLinks
Parameters:
dRepelLinksFactor - The dRepelLinksFactor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRepelLinksFactor

public double getRepelLinksFactor()
                           throws IOException,
                                  AutomationException
Parameter value used to quickly increase the schematic links displacement for links that are very close.

Product Availability

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

Specified by:
getRepelLinksFactor in interface ISchematicAlgoPartialOverlappingLinks
Returns:
The dRepelLinksFactor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRepelNodeLinkFactor

public void setRepelNodeLinkFactor(double dRepelNodeLinkFactor)
                            throws IOException,
                                   AutomationException
Parameter value used to quickly increase the schematic link displacement between link and node when they are not connected together.

Product Availability

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

Specified by:
setRepelNodeLinkFactor in interface ISchematicAlgoPartialOverlappingLinks
Parameters:
dRepelNodeLinkFactor - The dRepelNodeLinkFactor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRepelNodeLinkFactor

public double getRepelNodeLinkFactor()
                              throws IOException,
                                     AutomationException
Parameter value used to quickly increase the schematic link displacement between link and node when they are not connected together.

Product Availability

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

Specified by:
getRepelNodeLinkFactor in interface ISchematicAlgoPartialOverlappingLinks
Returns:
The dRepelNodeLinkFactor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAttractNodeLinkFactor

public void setAttractNodeLinkFactor(double dAttractNodeLinkFactor)
                              throws IOException,
                                     AutomationException
Parameter value used to quickly decrease the schematic link displacement between link and node when they are connected together.

Product Availability

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

Specified by:
setAttractNodeLinkFactor in interface ISchematicAlgoPartialOverlappingLinks
Parameters:
dAttractNodeLinkFactor - The dAttractNodeLinkFactor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAttractNodeLinkFactor

public double getAttractNodeLinkFactor()
                                throws IOException,
                                       AutomationException
Parameter value used to quickly decrease the schematic link displacement between link and node when they are connected together.

Product Availability

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

Specified by:
getAttractNodeLinkFactor in interface ISchematicAlgoPartialOverlappingLinks
Returns:
The dAttractNodeLinkFactor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAttractNodesFactor

public void setAttractNodesFactor(double dAttractNodesFactor)
                           throws IOException,
                                  AutomationException
Parameter value used to quickly decrease the schematic nodes displacement between a node and its original position.

Product Availability

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

Specified by:
setAttractNodesFactor in interface ISchematicAlgoPartialOverlappingLinks
Parameters:
dAttractNodesFactor - The dAttractNodesFactor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAttractNodesFactor

public double getAttractNodesFactor()
                             throws IOException,
                                    AutomationException
Parameter value used to quickly decrease the schematic nodes displacement between a node and its original position.

Product Availability

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

Specified by:
getAttractNodesFactor in interface ISchematicAlgoPartialOverlappingLinks
Returns:
The dAttractNodesFactor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNumberOfIterations

public int getNumberOfIterations()
                          throws IOException,
                                 AutomationException
Number of Partial Overlapping Links schematic algorithm iterations executed before the final result is shown.

Product Availability

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

Specified by:
getNumberOfIterations in interface ISchematicAlgoPartialOverlappingLinks
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNumberOfIterations

public void setNumberOfIterations(int pVal)
                           throws IOException,
                                  AutomationException
Number of Partial Overlapping Links schematic algorithm iterations executed before the final result is shown.

Product Availability

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

Specified by:
setNumberOfIterations in interface ISchematicAlgoPartialOverlappingLinks
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isLeftRightHint

public boolean isLeftRightHint()
                        throws IOException,
                               AutomationException
Indicates if relative left or right positions between links is kept as much as possible.

Product Availability

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

Specified by:
isLeftRightHint in interface ISchematicAlgoPartialOverlappingLinks
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLeftRightHint

public void setLeftRightHint(boolean pVal)
                      throws IOException,
                             AutomationException
Indicates if relative left or right positions between links is kept as much as possible.

Product Availability

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

Specified by:
setLeftRightHint in interface ISchematicAlgoPartialOverlappingLinks
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isGeneralizeResult

public boolean isGeneralizeResult()
                           throws IOException,
                                  AutomationException
Indicates if resulting geometries are generalized.

Product Availability

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

Specified by:
isGeneralizeResult in interface ISchematicAlgoPartialOverlappingLinks
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGeneralizeResult

public void setGeneralizeResult(boolean pVal)
                         throws IOException,
                                AutomationException
Indicates if resulting geometries are generalized.

Product Availability

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

Specified by:
setGeneralizeResult in interface ISchematicAlgoPartialOverlappingLinks
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEnabled

public boolean isEnabled(ISchematicLayer schematicLayer)
                  throws IOException,
                         AutomationException
Indicates if the algorithm is currently enabled.

Product Availability

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

Specified by:
isEnabled in interface ISchematicAlgorithm
Parameters:
schematicLayer - A reference to a com.esri.arcgis.schematic.ISchematicLayer (in, optional, pass 0 if not required)
Returns:
The enabled
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAvailable

public boolean isAvailable()
                    throws IOException,
                           AutomationException
Indicates if the algorithm is currently available.

Product Availability

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

Specified by:
isAvailable in interface ISchematicAlgorithm
Returns:
The available
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAvailable

public void setAvailable(boolean available)
                  throws IOException,
                         AutomationException
Indicates if the algorithm is currently available.

Product Availability

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

Specified by:
setAvailable in interface ISchematicAlgorithm
Parameters:
available - The available (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isOverridable

public boolean isOverridable()
                      throws IOException,
                             AutomationException
Indicates if the algorithm properties page is editable from ArcMap; that is, enabling the Layout Properties button in ArcMap.

Product Availability

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

Specified by:
isOverridable in interface ISchematicAlgorithm
Returns:
The pOverridable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOverridable

public void setOverridable(boolean pOverridable)
                    throws IOException,
                           AutomationException
Indicates if the algorithm properties page is editable from ArcMap; that is, enabling the Layout Properties button in ArcMap.

Product Availability

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

Specified by:
setOverridable in interface ISchematicAlgorithm
Parameters:
pOverridable - The pOverridable (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicDiagramClassName

public ISchematicDiagramClassName getSchematicDiagramClassName()
                                                        throws IOException,
                                                               AutomationException
The diagram class object used to initialize the algorithm.

Product Availability

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

Specified by:
getSchematicDiagramClassName in interface ISchematicAlgorithm
Returns:
A reference to a com.esri.arcgis.schematic.ISchematicDiagramClassName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSchematicDiagramClassNameByRef

public void setSchematicDiagramClassNameByRef(ISchematicDiagramClassName schematicDiagramClassName)
                                       throws IOException,
                                              AutomationException
The diagram class object used to initialize the algorithm.

Product Availability

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

Specified by:
setSchematicDiagramClassNameByRef in interface ISchematicAlgorithm
Parameters:
schematicDiagramClassName - A reference to a com.esri.arcgis.schematic.ISchematicDiagramClassName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabel

public String getLabel()
                throws IOException,
                       AutomationException
The label of the algorithm.

Product Availability

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

Specified by:
getLabel in interface ISchematicAlgorithm
Returns:
The label
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabel

public void setLabel(String label)
              throws IOException,
                     AutomationException
The label of the algorithm.

Product Availability

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

Specified by:
setLabel in interface ISchematicAlgorithm
Parameters:
label - The label (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseRootNode

public boolean isUseRootNode()
                      throws IOException,
                             AutomationException
Indicates if the algorithm use root nodes.

Product Availability

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

Specified by:
isUseRootNode in interface ISchematicAlgorithm
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseEndNode

public boolean isUseEndNode()
                     throws IOException,
                            AutomationException
Indicates if the algorithm use end nodes.

Product Availability

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

Specified by:
isUseEndNode in interface ISchematicAlgorithm
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPropertySet

public IPropertySet getPropertySet()
                            throws IOException,
                                   AutomationException
The property set of the algorithm contains a collection of its parameters and their values.

Product Availability

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

Specified by:
getPropertySet in interface ISchematicAlgorithm
Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPropertySet

public void setPropertySet(IPropertySet propertySet)
                    throws IOException,
                           AutomationException
The property set of the algorithm contains a collection of its parameters and their values.

Product Availability

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

Specified by:
setPropertySet in interface ISchematicAlgorithm
Parameters:
propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAlgorithmCLSID

public String getAlgorithmCLSID()
                         throws IOException,
                                AutomationException
The CLSID of the algorithm.

Product Availability

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

Specified by:
getAlgorithmCLSID in interface ISchematicAlgorithm
Returns:
The bstrCLSID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

execute

public void execute(ISchematicLayer schematicLayer,
                    ITrackCancel cancelTracker)
             throws IOException,
                    AutomationException
Execute the schematic algorithm.

Product Availability

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

Specified by:
execute in interface ISchematicAlgorithm
Parameters:
schematicLayer - A reference to a com.esri.arcgis.schematic.ISchematicLayer (in, optional, pass 0 if not required)
cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in, optional, pass 0 if not required)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.