com.esri.arcgis.schematic
Class SchematicAlgoSmartTree

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

public class SchematicAlgoSmartTree
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISchematicAlgoSmartTree, ISchematicAlgorithm

Smart Tree schematic algorithm object.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
SchematicAlgoSmartTree()
          Constructs a SchematicAlgoSmartTree using ArcGIS Engine.
SchematicAlgoSmartTree(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SchematicAlgoSmartTree theSchematicAlgoSmartTree = (SchematicAlgoSmartTree) 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 getBreakPoint()
          Number comprised between 0 and 1 that defines the relative position of the break point on the last segment of the links; that is on the link segment that is paralleled to the tree direction.
static String getClsid()
          getClsid.
 int getDirection()
          Smart tree structure direction.
 double getDistanceAlongTheDirection()
          Spacing between the nodes that display along the smart tree direction; that is, spacing between a node belonging to the (n) hierarchical level and a node belonging to the (n+1) hierarchical level.
 double getDistancePerpendicularToDirection()
          Spacing between the nodes that display perpendicularly to the smart tree direction and that belong to the same subtree level; that is, spacing between the nodes that belong to the same hierarchical level in the same subtree.
 String getLabel()
          The label of the algorithm.
 IPropertySet getPropertySet()
          The property set of the algorithm contains a collection of its parameters and their values.
 ISchematicDiagramClassName getSchematicDiagramClassName()
          The diagram class object used to initialize the algorithm.
 double getSubtreeSeparation()
          Spacing between two neighbor subtrees; that is, spacing between the nodes that display perpendicularly to the smart tree direction and that belong to two different subtrees.
 int hashCode()
          the hashcode for this object
 boolean isAbsoluteParameters()
          Indicates if the values set for the spacing parameters must be interpreted as absolute units.
 boolean isAvailable()
          Indicates if the algorithm is currently available.
 boolean isEnabled(ISchematicLayer schematicLayer)
          Indicates if the algorithm is currently enabled.
 boolean isOrthogonalDisplay()
          Indicates if the links must display with right angles.
 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 setAbsoluteParameters(boolean pVal)
          Indicates if the values set for the spacing parameters must be interpreted as absolute units.
 void setAvailable(boolean available)
          Indicates if the algorithm is currently available.
 void setBreakPoint(double pVal)
          Number comprised between 0 and 1 that defines the relative position of the break point on the last segment of the links; that is on the link segment that is paralleled to the tree direction.
 void setDirection(int pVal)
          Smart tree structure direction.
 void setDistanceAlongTheDirection(double pVal)
          Spacing between the nodes that display along the smart tree direction; that is, spacing between a node belonging to the (n) hierarchical level and a node belonging to the (n+1) hierarchical level.
 void setDistancePerpendicularToDirection(double pVal)
          Spacing between the nodes that display perpendicularly to the smart tree direction and that belong to the same subtree level; that is, spacing between the nodes that belong to the same hierarchical level in the same subtree.
 void setLabel(String label)
          The label of the algorithm.
 void setOrthogonalDisplay(boolean pVal)
          Indicates if the links must display with right angles.
 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 setSchematicDiagramClassNameByRef(ISchematicDiagramClassName schematicDiagramClassName)
          The diagram class object used to initialize the algorithm.
 void setSubtreeSeparation(double pVal)
          Spacing between two neighbor subtrees; that is, spacing between the nodes that display perpendicularly to the smart tree direction and that belong to two different subtrees.
 
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

SchematicAlgoSmartTree

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

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

SchematicAlgoSmartTree

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

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

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

getDistanceAlongTheDirection

public double getDistanceAlongTheDirection()
                                    throws IOException,
                                           AutomationException
Spacing between the nodes that display along the smart tree direction; that is, spacing between a node belonging to the (n) hierarchical level and a node belonging to the (n+1) hierarchical level.

Product Availability

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

Specified by:
getDistanceAlongTheDirection in interface ISchematicAlgoSmartTree
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ISchematicAlgoSmartTree.getSubtreeSeparation(), ISchematicAlgoSmartTree.getDistancePerpendicularToDirection()

setDistanceAlongTheDirection

public void setDistanceAlongTheDirection(double pVal)
                                  throws IOException,
                                         AutomationException
Spacing between the nodes that display along the smart tree direction; that is, spacing between a node belonging to the (n) hierarchical level and a node belonging to the (n+1) hierarchical level.

Product Availability

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

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

getDistancePerpendicularToDirection

public double getDistancePerpendicularToDirection()
                                           throws IOException,
                                                  AutomationException
Spacing between the nodes that display perpendicularly to the smart tree direction and that belong to the same subtree level; that is, spacing between the nodes that belong to the same hierarchical level in the same subtree.

Product Availability

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

Specified by:
getDistancePerpendicularToDirection in interface ISchematicAlgoSmartTree
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ISchematicAlgoSmartTree.getSubtreeSeparation(), ISchematicAlgoSmartTree.getDistanceAlongTheDirection()

setDistancePerpendicularToDirection

public void setDistancePerpendicularToDirection(double pVal)
                                         throws IOException,
                                                AutomationException
Spacing between the nodes that display perpendicularly to the smart tree direction and that belong to the same subtree level; that is, spacing between the nodes that belong to the same hierarchical level in the same subtree.

Product Availability

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

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

getSubtreeSeparation

public double getSubtreeSeparation()
                            throws IOException,
                                   AutomationException
Spacing between two neighbor subtrees; that is, spacing between the nodes that display perpendicularly to the smart tree direction and that belong to two different subtrees.

Product Availability

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

Specified by:
getSubtreeSeparation in interface ISchematicAlgoSmartTree
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ISchematicAlgoSmartTree.getDistancePerpendicularToDirection()

setSubtreeSeparation

public void setSubtreeSeparation(double pVal)
                          throws IOException,
                                 AutomationException
Spacing between two neighbor subtrees; that is, spacing between the nodes that display perpendicularly to the smart tree direction and that belong to two different subtrees.

Product Availability

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

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

getDirection

public int getDirection()
                 throws IOException,
                        AutomationException
Smart tree structure direction.

Product Availability

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

Specified by:
getDirection in interface ISchematicAlgoSmartTree
Returns:
A com.esri.arcgis.schematic.esriSchematicAlgoDirection constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDirection

public void setDirection(int pVal)
                  throws IOException,
                         AutomationException
Smart tree structure direction.

Product Availability

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

Specified by:
setDirection in interface ISchematicAlgoSmartTree
Parameters:
pVal - A com.esri.arcgis.schematic.esriSchematicAlgoDirection constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBreakPoint

public double getBreakPoint()
                     throws IOException,
                            AutomationException
Number comprised between 0 and 1 that defines the relative position of the break point on the last segment of the links; that is on the link segment that is paralleled to the tree direction.

Description

With a BreakPoint property value of 0, this segment length is the longest and it displays with a right angle. With a BreakPoint property value of 1, this segment doesn’t exist; each link directly connects its two extremity nodes without intermediate point.

Product Availability

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

Specified by:
getBreakPoint in interface ISchematicAlgoSmartTree
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ISchematicAlgoSmartTree.isOrthogonalDisplay()

setBreakPoint

public void setBreakPoint(double pVal)
                   throws IOException,
                          AutomationException
Number comprised between 0 and 1 that defines the relative position of the break point on the last segment of the links; that is on the link segment that is paralleled to the tree direction.

Product Availability

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

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

isOrthogonalDisplay

public boolean isOrthogonalDisplay()
                            throws IOException,
                                   AutomationException
Indicates if the links must display with right angles.

Product Availability

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

Specified by:
isOrthogonalDisplay in interface ISchematicAlgoSmartTree
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ISchematicAlgoSmartTree.getBreakPoint()

setOrthogonalDisplay

public void setOrthogonalDisplay(boolean pVal)
                          throws IOException,
                                 AutomationException
Indicates if the links must display with right angles.

Product Availability

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

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

isAbsoluteParameters

public boolean isAbsoluteParameters()
                             throws IOException,
                                    AutomationException
Indicates if the values set for the spacing parameters must be interpreted as absolute units.

Description

When the AbsoluteParameters is false, the distance parameters are interpreted as relative units to the average of the current symbols sizes used to represent the schematic nodes in the diagram; that is, for instance, when the DistanceAlongTheDirection property value is 2, the distance that separates two nodes belonging to the (n) and the (n+1) hierarchical levels corresponds to the average size of two symbols placed side by side

Product Availability

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

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

setAbsoluteParameters

public void setAbsoluteParameters(boolean pVal)
                           throws IOException,
                                  AutomationException
Indicates if the values set for the spacing parameters must be interpreted as absolute units.

Product Availability

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

Specified by:
setAbsoluteParameters in interface ISchematicAlgoSmartTree
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.