com.esri.arcgis.schematic
Class SchematicAlgoRadialTree

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, ISchematicAlgoRadialTree, ISchematicAlgorithm, Serializable

public class SchematicAlgoRadialTree
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISchematicAlgoRadialTree, ISchematicAlgorithm

Radial Tree schematic algorithm object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

SchematicAlgoRadialTree()
Constructs a SchematicAlgoRadialTree using ArcGIS Engine.

SchematicAlgoRadialTree(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SchematicAlgoRadialTree theSchematicAlgoRadialTree = (SchematicAlgoRadialTree) 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.
static String	getClsid() getClsid.
double	getInitialRadius() Radius of the first concentric circle which center is the Radial Tree root node.
String	getLabel() The label of the algorithm.
IPropertySet	getPropertySet() The property set of the algorithm contains a collection of its parameters and their values.
double	getRadiusFactor() Multiplicative factor used to increase or decrease the radius of each concentric circle corresponding to a hierarchical level.
ISchematicDiagramClassName	getSchematicDiagramClassName() The diagram class object used to initialize the algorithm.
int	hashCode() the hashcode for this object
boolean	isAbsoluteParameters() Indicates if the values set for the Initial radius 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	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 Initial radius must be interpreted as absolute units.
void	setAvailable(boolean available) Indicates if the algorithm is currently available.
void	setInitialRadius(double pVal) Radius of the first concentric circle which center is the Radial Tree root node.
void	setLabel(String label) The label of the algorithm.
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	setRadiusFactor(double pVal) Multiplicative factor used to increase or decrease the radius of each concentric circle corresponding to a hierarchical level.
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

SchematicAlgoRadialTree

public SchematicAlgoRadialTree()
                        throws IOException,
                               UnknownHostException

Constructs a SchematicAlgoRadialTree using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

SchematicAlgoRadialTree

public SchematicAlgoRadialTree(Object obj)
                        throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SchematicAlgoRadialTree theSchematicAlgoRadialTree = (SchematicAlgoRadialTree) obj;

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

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

getRadiusFactor

public double getRadiusFactor()
                       throws IOException,
                              AutomationException

Multiplicative factor used to increase or decrease the radius of each concentric circle corresponding to a hierarchical level.

Description

By default, the RadiusFactor value is 1; that is, the InitialRadius also represents the distance that separates each concentric circle related to a hierarchical level. When setting a RadiusFactor lower than 1, the distance that separates the nodes belonging to the N hierarchical level and the N+1 hierarchical level progressively decreased; with factor upper than 1, the distance between the hierarchical levels increases progressively.

Product Availability

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

Specified by:

getRadiusFactor in interface ISchematicAlgoRadialTree

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgoRadialTree.getInitialRadius()

setRadiusFactor

public void setRadiusFactor(double pVal)
                     throws IOException,
                            AutomationException

Multiplicative factor used to increase or decrease the radius of each concentric circle corresponding to a hierarchical level.

Product Availability

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

Specified by:

setRadiusFactor in interface ISchematicAlgoRadialTree

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInitialRadius

public double getInitialRadius()
                        throws IOException,
                               AutomationException

Radius of the first concentric circle which center is the Radial Tree root node.

Description

That is, the intial radius is the radius of the circle around which the nodes belonging to the first hierarchical level are placed.

Product Availability

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

Specified by:

getInitialRadius in interface ISchematicAlgoRadialTree

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgoRadialTree.getRadiusFactor()

setInitialRadius

public void setInitialRadius(double pVal)
                      throws IOException,
                             AutomationException

Radius of the first concentric circle which center is the Radial Tree root node.

Product Availability

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

Specified by:

setInitialRadius in interface ISchematicAlgoRadialTree

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 Initial radius must be interpreted as absolute units.

Description

When this property returns false, the parameters that define the radius is expressed as relative units to the average of the current symbols sizes used to represent the schematic nodes in the diagram; that is, when the InitialRadius parameter value is 2, the radius for the first concentric circle centered around the root node corresponds to the average size of two symbols placed side by side (or 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 ISchematicAlgoRadialTree

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 Initial radius must be interpreted as absolute units.

Product Availability

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

Specified by:

setAbsoluteParameters in interface ISchematicAlgoRadialTree

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.