com.esri.arcgis.schematic
Class SchematicAlgoSmartTree

java.lang.Object
  com.esri.arcgis.schematic.SchematicAlgoSmartTree

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, ISchematicAlgorithm, ISchematicAlgoSmartTree, ISchematicJSONParameters, java.io.Serializable

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

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

Description 'Smart Tree schematic algorithm object.' 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.ISchematicAlgoSmartTree

IID, IID1a959572_a8ce_4445_acb1_4097b612134f, xxDummy

Fields inherited from interface com.esri.arcgis.schematic.ISchematicAlgorithm

IIDbef20014_837c_4387_83ba_8523b7897a36

Fields inherited from interface com.esri.arcgis.schematic.ISchematicJSONParameters

IID, IID4e9abfed_ac35_4913_8c46_79714a59d2fc, xxDummy

Constructor Summary

SchematicAlgoSmartTree()
Constructs a SchematicAlgoSmartTree using ArcGIS Engine.

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

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
void	execute(ISchematicLayer schematicLayer, ITrackCancel cancelTracker) Execute the schematic algorithm.
java.lang.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 java.lang.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.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
IJSONArray	getJSONParametersArray() JSON parameters array.
java.lang.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	release() Release a SchematicAlgoSmartTree.
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	setJSONParametersObject(IJSONObject rhs1) JSON parameters object.
void	setLabel(java.lang.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

Constructor Detail

SchematicAlgoSmartTree

public SchematicAlgoSmartTree()
                       throws java.io.IOException,
                              java.net.UnknownHostException

Constructs a SchematicAlgoSmartTree using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

SchematicAlgoSmartTree

public SchematicAlgoSmartTree(java.lang.Object obj)
                       throws java.io.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:

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

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getDistanceAlongTheDirection

public double getDistanceAlongTheDirection()
                                    throws java.io.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.

Specified by:

getDistanceAlongTheDirection in interface ISchematicAlgoSmartTree

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDistanceAlongTheDirection

public void setDistanceAlongTheDirection(double pVal)
                                  throws java.io.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.

Specified by:

setDistanceAlongTheDirection in interface ISchematicAlgoSmartTree

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDistancePerpendicularToDirection

public double getDistancePerpendicularToDirection()
                                           throws java.io.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.

Specified by:

getDistancePerpendicularToDirection in interface ISchematicAlgoSmartTree

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDistancePerpendicularToDirection

public void setDistancePerpendicularToDirection(double pVal)
                                         throws java.io.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.

Specified by:

setDistancePerpendicularToDirection in interface ISchematicAlgoSmartTree

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSubtreeSeparation

public double getSubtreeSeparation()
                            throws java.io.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.

Specified by:

getSubtreeSeparation in interface ISchematicAlgoSmartTree

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSubtreeSeparation

public void setSubtreeSeparation(double pVal)
                          throws java.io.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.

Specified by:

setSubtreeSeparation in interface ISchematicAlgoSmartTree

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDirection

public int getDirection()
                 throws java.io.IOException,
                        AutomationException

Smart tree structure direction.

Specified by:

getDirection in interface ISchematicAlgoSmartTree

Returns:

A com.esri.arcgis.schematic.esriSchematicAlgoDirection constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDirection

public void setDirection(int pVal)
                  throws java.io.IOException,
                         AutomationException

Smart tree structure direction.

Specified by:

setDirection in interface ISchematicAlgoSmartTree

Parameters:

pVal - A com.esri.arcgis.schematic.esriSchematicAlgoDirection constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBreakPoint

public double getBreakPoint()
                     throws java.io.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.

Specified by:

getBreakPoint in interface ISchematicAlgoSmartTree

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBreakPoint

public void setBreakPoint(double pVal)
                   throws java.io.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.

Specified by:

setBreakPoint in interface ISchematicAlgoSmartTree

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isOrthogonalDisplay

public boolean isOrthogonalDisplay()
                            throws java.io.IOException,
                                   AutomationException

Indicates if the links must display with right angles.

Specified by:

isOrthogonalDisplay in interface ISchematicAlgoSmartTree

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOrthogonalDisplay

public void setOrthogonalDisplay(boolean pVal)
                          throws java.io.IOException,
                                 AutomationException

Indicates if the links must display with right angles.

Specified by:

setOrthogonalDisplay in interface ISchematicAlgoSmartTree

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAbsoluteParameters

public boolean isAbsoluteParameters()
                             throws java.io.IOException,
                                    AutomationException

Indicates if the values set for the spacing parameters must be interpreted as absolute units.

Specified by:

isAbsoluteParameters in interface ISchematicAlgoSmartTree

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAbsoluteParameters

public void setAbsoluteParameters(boolean pVal)
                           throws java.io.IOException,
                                  AutomationException

Indicates if the values set for the spacing parameters must be interpreted as absolute units.

Specified by:

setAbsoluteParameters in interface ISchematicAlgoSmartTree

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnabled

public boolean isEnabled(ISchematicLayer schematicLayer)
                  throws java.io.IOException,
                         AutomationException

Indicates if the algorithm is currently enabled.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAvailable

public boolean isAvailable()
                    throws java.io.IOException,
                           AutomationException

Indicates if the algorithm is currently available.

Specified by:

isAvailable in interface ISchematicAlgorithm

Returns:

The available

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAvailable

public void setAvailable(boolean available)
                  throws java.io.IOException,
                         AutomationException

Indicates if the algorithm is currently available.

Specified by:

setAvailable in interface ISchematicAlgorithm

Parameters:

available - The available (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isOverridable

public boolean isOverridable()
                      throws java.io.IOException,
                             AutomationException

Indicates if the algorithm properties page is editable from ArcMap; that is, enabling the Layout Properties button in ArcMap.

Specified by:

isOverridable in interface ISchematicAlgorithm

Returns:

The pOverridable

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOverridable

public void setOverridable(boolean pOverridable)
                    throws java.io.IOException,
                           AutomationException

Indicates if the algorithm properties page is editable from ArcMap; that is, enabling the Layout Properties button in ArcMap.

Specified by:

setOverridable in interface ISchematicAlgorithm

Parameters:

pOverridable - The pOverridable (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicDiagramClassName

public ISchematicDiagramClassName getSchematicDiagramClassName()
                                                        throws java.io.IOException,
                                                               AutomationException

The diagram class object used to initialize the algorithm.

Specified by:

getSchematicDiagramClassName in interface ISchematicAlgorithm

Returns:

A reference to a com.esri.arcgis.schematic.ISchematicDiagramClassName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSchematicDiagramClassNameByRef

public void setSchematicDiagramClassNameByRef(ISchematicDiagramClassName schematicDiagramClassName)
                                       throws java.io.IOException,
                                              AutomationException

The diagram class object used to initialize the algorithm.

Specified by:

setSchematicDiagramClassNameByRef in interface ISchematicAlgorithm

Parameters:

schematicDiagramClassName - A reference to a com.esri.arcgis.schematic.ISchematicDiagramClassName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabel

public java.lang.String getLabel()
                          throws java.io.IOException,
                                 AutomationException

The label of the algorithm.

Specified by:

getLabel in interface ISchematicAlgorithm

Returns:

The label

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabel

public void setLabel(java.lang.String label)
              throws java.io.IOException,
                     AutomationException

The label of the algorithm.

Specified by:

setLabel in interface ISchematicAlgorithm

Parameters:

label - The label (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseRootNode

public boolean isUseRootNode()
                      throws java.io.IOException,
                             AutomationException

Indicates if the algorithm use root nodes.

Specified by:

isUseRootNode in interface ISchematicAlgorithm

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseEndNode

public boolean isUseEndNode()
                     throws java.io.IOException,
                            AutomationException

Indicates if the algorithm use end nodes.

Specified by:

isUseEndNode in interface ISchematicAlgorithm

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPropertySet

public IPropertySet getPropertySet()
                            throws java.io.IOException,
                                   AutomationException

The property set of the algorithm contains a collection of its parameters and their values.

Specified by:

getPropertySet in interface ISchematicAlgorithm

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPropertySet

public void setPropertySet(IPropertySet propertySet)
                    throws java.io.IOException,
                           AutomationException

The property set of the algorithm contains a collection of its parameters and their values.

Specified by:

setPropertySet in interface ISchematicAlgorithm

Parameters:

propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAlgorithmCLSID

public java.lang.String getAlgorithmCLSID()
                                   throws java.io.IOException,
                                          AutomationException

The CLSID of the algorithm.

Specified by:

getAlgorithmCLSID in interface ISchematicAlgorithm

Returns:

The bstrCLSID

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

execute

public void execute(ISchematicLayer schematicLayer,
                    ITrackCancel cancelTracker)
             throws java.io.IOException,
                    AutomationException

Execute the schematic algorithm.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJSONParametersArray

public IJSONArray getJSONParametersArray()
                                  throws java.io.IOException,
                                         AutomationException

JSON parameters array.

Specified by:

getJSONParametersArray in interface ISchematicJSONParameters

Returns:

A reference to a com.esri.arcgis.system.IJSONArray

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setJSONParametersObject

public void setJSONParametersObject(IJSONObject rhs1)
                             throws java.io.IOException,
                                    AutomationException

JSON parameters object.

Specified by:

setJSONParametersObject in interface ISchematicJSONParameters

Parameters:

rhs1 - A reference to a com.esri.arcgis.system.IJSONObject (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.