com.esri.arcgis.schematic
Class SchematicAlgoRelativeMainLine

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, ISchematicAlgoRelativeMainLine, ISchematicAlgorithm, ISchematicJSONParameters, Serializable

public class SchematicAlgoRelativeMainLine
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISchematicAlgoRelativeMainLine, ISchematicAlgorithm, ISchematicJSONParameters

RelativeMainLine schematic algorithm object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

SchematicAlgoRelativeMainLine()
Constructs a SchematicAlgoRelativeMainLine using ArcGIS Engine.

SchematicAlgoRelativeMainLine(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SchematicAlgoRelativeMainLine theSchematicAlgoRelativeMainLine = (SchematicAlgoRelativeMainLine) 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	getBreakPointAngle() Angle comprised between 30° and 90° that defines the relative position of the break point on the first and last segments of the links; that is on the link segments that are paralleled to the tree direction.
static String	getClsid() getClsid.
double	getCompression() Number comprised between 0 and 1 that define the percentage of compression along the direction.
int	getDirection() RelativeMainLine structure direction.
double	getDistanceBetweenBranches() Spacing between the branches perpendicularly to the direction.
String	getExcludedTypeValues() Excluded type values.
IJSONArray	getJSONParametersArray() JSON parameters array.
String	getLabel() The label of the algorithm.
String	getLengthAttributeName() The name of the attribute holding the initial length of the link.
String	getLinesAttributeName() The name of the attribute defining the parallel lines.
String	getMainLinesTypeValue() Define the main line type value.
double	getMinimalDistanceBetweenNodes() Minimal distance between nodes along direction defines where compression can occur.
String	getPriorityAttributeName() The name of the attribute defining the priority..
String	getPriorityValue() Define the priority value.
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.
String	getTypeAttributeName() The name of the attribute defining the type of the lines.
int	hashCode() the hashcode for this object
boolean	isAvailable() Indicates if the algorithm is currently available.
boolean	isCompressAlongDirection() Indicates if the algorithm shrinks the distances between nodes along the direction.
boolean	isEnabled(ISchematicLayer schematicLayer) Indicates if the algorithm is currently enabled.
boolean	isInitialLengthIsGeometry() Indicates if the initial length is computed from the link geometry or fetched from an attibute.
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	isUsePriorityAttribute() Indicates if the algorithm uses priority attribute to merge connected main lines.
boolean	isUseRootNode() Indicates if the algorithm use root nodes.
boolean	isUseTypeAttribute() Indicates if the algorithm uses type values to distinguish between lines.
boolean	isVerticesHint() Indicates if the link vertices are used to determine the side and orientation of the branches.
void	setAvailable(boolean available) Indicates if the algorithm is currently available.
void	setBreakPointAngle(double pVal) Angle comprised between 30° and 90° that defines the relative position of the break point on the first and last segments of the links; that is on the link segments that are paralleled to the tree direction.
void	setCompressAlongDirection(boolean pVal) Indicates if the algorithm shrinks the distances between nodes along the direction.
void	setCompression(double pVal) Number comprised between 0 and 1 that define the percentage of compression along the direction.
void	setDirection(int pVal) RelativeMainLine structure direction.
void	setDistanceBetweenBranches(double pVal) Spacing between the branches perpendicularly to the direction.
void	setExcludedTypeValues(String value) Excluded type values.
void	setInitialLengthIsGeometry(boolean pVal) Indicates if the initial length is computed from the link geometry or fetched from an attibute.
void	setJSONParametersObject(IJSONObject rhs1) JSON parameters object.
void	setLabel(String label) The label of the algorithm.
void	setLengthAttributeName(String name) The name of the attribute holding the initial length of the link.
void	setLinesAttributeName(String name) The name of the attribute defining the parallel lines.
void	setMainLinesTypeValue(String value) Define the main line type value.
void	setMinimalDistanceBetweenNodes(double pVal) Minimal distance between nodes along direction defines where compression can occur.
void	setOverridable(boolean pOverridable) Indicates if the algorithm properties page is editable from ArcMap; that is, enabling the Layout Properties button in ArcMap.
void	setPriorityAttributeName(String name) The name of the attribute defining the priority..
void	setPriorityValue(String value) Define the priority value.
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	setTypeAttributeName(String name) The name of the attribute defining the type of the lines.
void	setUsePriorityAttribute(boolean pVal) Indicates if the algorithm uses priority attribute to merge connected main lines.
void	setUseTypeAttribute(boolean pVal) Indicates if the algorithm uses type values to distinguish between lines.
void	setVerticesHint(boolean pVal) Indicates if the link vertices are used to determine the side and orientation of the branches.

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

SchematicAlgoRelativeMainLine

public SchematicAlgoRelativeMainLine()
                              throws IOException,
                                     UnknownHostException

Constructs a SchematicAlgoRelativeMainLine using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

SchematicAlgoRelativeMainLine

public SchematicAlgoRelativeMainLine(Object obj)
                              throws IOException

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

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

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

getDirection

public int getDirection()
                 throws IOException,
                        AutomationException

RelativeMainLine structure direction.

Product Availability

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

Specified by:

getDirection in interface ISchematicAlgoRelativeMainLine

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

RelativeMainLine structure direction.

Product Availability

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

Specified by:

setDirection in interface ISchematicAlgoRelativeMainLine

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.

getDistanceBetweenBranches

public double getDistanceBetweenBranches()
                                  throws IOException,
                                         AutomationException

Spacing between the branches perpendicularly to the direction.

Product Availability

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

Specified by:

getDistanceBetweenBranches in interface ISchematicAlgoRelativeMainLine

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDistanceBetweenBranches

public void setDistanceBetweenBranches(double pVal)
                                throws IOException,
                                       AutomationException

Spacing between the branches perpendicularly to the direction.

Product Availability

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

Specified by:

setDistanceBetweenBranches in interface ISchematicAlgoRelativeMainLine

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBreakPointAngle

public double getBreakPointAngle()
                          throws IOException,
                                 AutomationException

Angle comprised between 30° and 90° that defines the relative position of the break point on the first and last segments of the links; that is on the link segments that are paralleled to the tree direction.

Product Availability

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

Specified by:

getBreakPointAngle in interface ISchematicAlgoRelativeMainLine

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBreakPointAngle

public void setBreakPointAngle(double pVal)
                        throws IOException,
                               AutomationException

Angle comprised between 30° and 90° that defines the relative position of the break point on the first and last segments of the links; that is on the link segments that are paralleled to the tree direction.

Product Availability

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

Specified by:

setBreakPointAngle in interface ISchematicAlgoRelativeMainLine

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCompressAlongDirection

public boolean isCompressAlongDirection()
                                 throws IOException,
                                        AutomationException

Indicates if the algorithm shrinks the distances between nodes along the direction.

Product Availability

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

Specified by:

isCompressAlongDirection in interface ISchematicAlgoRelativeMainLine

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCompressAlongDirection

public void setCompressAlongDirection(boolean pVal)
                               throws IOException,
                                      AutomationException

Indicates if the algorithm shrinks the distances between nodes along the direction.

Product Availability

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

Specified by:

setCompressAlongDirection in interface ISchematicAlgoRelativeMainLine

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinimalDistanceBetweenNodes

public double getMinimalDistanceBetweenNodes()
                                      throws IOException,
                                             AutomationException

Minimal distance between nodes along direction defines where compression can occur.

Product Availability

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

Specified by:

getMinimalDistanceBetweenNodes in interface ISchematicAlgoRelativeMainLine

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinimalDistanceBetweenNodes

public void setMinimalDistanceBetweenNodes(double pVal)
                                    throws IOException,
                                           AutomationException

Minimal distance between nodes along direction defines where compression can occur.

Product Availability

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

Specified by:

setMinimalDistanceBetweenNodes in interface ISchematicAlgoRelativeMainLine

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCompression

public double getCompression()
                      throws IOException,
                             AutomationException

Number comprised between 0 and 1 that define the percentage of compression along the direction.

Product Availability

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

Specified by:

getCompression in interface ISchematicAlgoRelativeMainLine

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCompression

public void setCompression(double pVal)
                    throws IOException,
                           AutomationException

Number comprised between 0 and 1 that define the percentage of compression along the direction.

Product Availability

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

Specified by:

setCompression in interface ISchematicAlgoRelativeMainLine

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLinesAttributeName

public String getLinesAttributeName()
                             throws IOException,
                                    AutomationException

The name of the attribute defining the parallel lines.

Product Availability

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

Specified by:

getLinesAttributeName in interface ISchematicAlgoRelativeMainLine

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLinesAttributeName

public void setLinesAttributeName(String name)
                           throws IOException,
                                  AutomationException

The name of the attribute defining the parallel lines.

Product Availability

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

Specified by:

setLinesAttributeName in interface ISchematicAlgoRelativeMainLine

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseTypeAttribute

public boolean isUseTypeAttribute()
                           throws IOException,
                                  AutomationException

Indicates if the algorithm uses type values to distinguish between lines.

Product Availability

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

Specified by:

isUseTypeAttribute in interface ISchematicAlgoRelativeMainLine

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseTypeAttribute

public void setUseTypeAttribute(boolean pVal)
                         throws IOException,
                                AutomationException

Indicates if the algorithm uses type values to distinguish between lines.

Product Availability

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

Specified by:

setUseTypeAttribute in interface ISchematicAlgoRelativeMainLine

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTypeAttributeName

public String getTypeAttributeName()
                            throws IOException,
                                   AutomationException

The name of the attribute defining the type of the lines.

Product Availability

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

Specified by:

getTypeAttributeName in interface ISchematicAlgoRelativeMainLine

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTypeAttributeName

public void setTypeAttributeName(String name)
                          throws IOException,
                                 AutomationException

The name of the attribute defining the type of the lines.

Product Availability

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

Specified by:

setTypeAttributeName in interface ISchematicAlgoRelativeMainLine

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMainLinesTypeValue

public String getMainLinesTypeValue()
                             throws IOException,
                                    AutomationException

Define the main line type value.

Product Availability

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

Specified by:

getMainLinesTypeValue in interface ISchematicAlgoRelativeMainLine

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMainLinesTypeValue

public void setMainLinesTypeValue(String value)
                           throws IOException,
                                  AutomationException

Define the main line type value.

Product Availability

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

Specified by:

setMainLinesTypeValue in interface ISchematicAlgoRelativeMainLine

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExcludedTypeValues

public String getExcludedTypeValues()
                             throws IOException,
                                    AutomationException

Excluded type values.

Product Availability

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

Specified by:

getExcludedTypeValues in interface ISchematicAlgoRelativeMainLine

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExcludedTypeValues

public void setExcludedTypeValues(String value)
                           throws IOException,
                                  AutomationException

Excluded type values.

Product Availability

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

Specified by:

setExcludedTypeValues in interface ISchematicAlgoRelativeMainLine

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUsePriorityAttribute

public boolean isUsePriorityAttribute()
                               throws IOException,
                                      AutomationException

Indicates if the algorithm uses priority attribute to merge connected main lines.

Product Availability

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

Specified by:

isUsePriorityAttribute in interface ISchematicAlgoRelativeMainLine

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUsePriorityAttribute

public void setUsePriorityAttribute(boolean pVal)
                             throws IOException,
                                    AutomationException

Indicates if the algorithm uses priority attribute to merge connected main lines.

Product Availability

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

Specified by:

setUsePriorityAttribute in interface ISchematicAlgoRelativeMainLine

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPriorityAttributeName

public String getPriorityAttributeName()
                                throws IOException,
                                       AutomationException

The name of the attribute defining the priority..

Product Availability

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

Specified by:

getPriorityAttributeName in interface ISchematicAlgoRelativeMainLine

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPriorityAttributeName

public void setPriorityAttributeName(String name)
                              throws IOException,
                                     AutomationException

The name of the attribute defining the priority..

Product Availability

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

Specified by:

setPriorityAttributeName in interface ISchematicAlgoRelativeMainLine

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPriorityValue

public String getPriorityValue()
                        throws IOException,
                               AutomationException

Define the priority value.

Product Availability

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

Specified by:

getPriorityValue in interface ISchematicAlgoRelativeMainLine

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPriorityValue

public void setPriorityValue(String value)
                      throws IOException,
                             AutomationException

Define the priority value.

Product Availability

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

Specified by:

setPriorityValue in interface ISchematicAlgoRelativeMainLine

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isInitialLengthIsGeometry

public boolean isInitialLengthIsGeometry()
                                  throws IOException,
                                         AutomationException

Indicates if the initial length is computed from the link geometry or fetched from an attibute.

Product Availability

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

Specified by:

isInitialLengthIsGeometry in interface ISchematicAlgoRelativeMainLine

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInitialLengthIsGeometry

public void setInitialLengthIsGeometry(boolean pVal)
                                throws IOException,
                                       AutomationException

Indicates if the initial length is computed from the link geometry or fetched from an attibute.

Product Availability

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

Specified by:

setInitialLengthIsGeometry in interface ISchematicAlgoRelativeMainLine

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLengthAttributeName

public String getLengthAttributeName()
                              throws IOException,
                                     AutomationException

The name of the attribute holding the initial length of the link.

Product Availability

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

Specified by:

getLengthAttributeName in interface ISchematicAlgoRelativeMainLine

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLengthAttributeName

public void setLengthAttributeName(String name)
                            throws IOException,
                                   AutomationException

The name of the attribute holding the initial length of the link.

Product Availability

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

Specified by:

setLengthAttributeName in interface ISchematicAlgoRelativeMainLine

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isVerticesHint

public boolean isVerticesHint()
                       throws IOException,
                              AutomationException

Indicates if the link vertices are used to determine the side and orientation of the branches.

Product Availability

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

Specified by:

isVerticesHint in interface ISchematicAlgoRelativeMainLine

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVerticesHint

public void setVerticesHint(boolean pVal)
                     throws IOException,
                            AutomationException

Indicates if the link vertices are used to determine the side and orientation of the branches.

Product Availability

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

Specified by:

setVerticesHint in interface ISchematicAlgoRelativeMainLine

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.

getJSONParametersArray

public IJSONArray getJSONParametersArray()
                                  throws IOException,
                                         AutomationException

JSON parameters array.

Product Availability

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

Specified by:

getJSONParametersArray in interface ISchematicJSONParameters

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setJSONParametersObject

public void setJSONParametersObject(IJSONObject rhs1)
                             throws IOException,
                                    AutomationException

JSON parameters object.

Product Availability

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

Specified by:

setJSONParametersObject in interface ISchematicJSONParameters

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.