com.esri.arcgis.schematic
Class SchematicAlgoRelativeMainLine

java.lang.Object
  extended by com.esri.arcgis.schematic.SchematicAlgoRelativeMainLine
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, ISchematicAlgoRelativeMainLine, ISchematicAlgorithm, ISchematicJSONParameters, java.io.Serializable

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

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

Description 'RelativeMainLine 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.ISchematicAlgoRelativeMainLine
IID, IID9b152a92_af41_4fa3_a18d_5b11e0a63b65, 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
SchematicAlgoRelativeMainLine()
          Constructs a SchematicAlgoRelativeMainLine using ArcGIS Engine.
SchematicAlgoRelativeMainLine(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SchematicAlgoRelativeMainLine theSchematicAlgoRelativeMainLine = (SchematicAlgoRelativeMainLine) 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 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 java.lang.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.
 java.lang.String getExcludedTypeValues()
          Excluded type values.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 IJSONArray getJSONParametersArray()
          JSON parameters array.
 java.lang.String getLabel()
          The label of the algorithm.
 java.lang.String getLengthAttributeName()
          The name of the attribute holding the initial length of the link.
 java.lang.String getLinesAttributeName()
          The name of the attribute defining the parallel lines.
 java.lang.String getMainLinesTypeValue()
          Define the main line type value.
 double getMinimalDistanceBetweenNodes()
          Minimal distance between nodes along direction defines where compression can occur.
 java.lang.String getPriorityAttributeName()
          The name of the attribute defining the priority..
 java.lang.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.
 java.lang.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 release()
          Release a SchematicAlgoRelativeMainLine.
 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(java.lang.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(java.lang.String label)
          The label of the algorithm.
 void setLengthAttributeName(java.lang.String name)
          The name of the attribute holding the initial length of the link.
 void setLinesAttributeName(java.lang.String name)
          The name of the attribute defining the parallel lines.
 void setMainLinesTypeValue(java.lang.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(java.lang.String name)
          The name of the attribute defining the priority..
 void setPriorityValue(java.lang.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(java.lang.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
 

Constructor Detail

SchematicAlgoRelativeMainLine

public SchematicAlgoRelativeMainLine()
                              throws java.io.IOException,
                                     java.net.UnknownHostException
Constructs a SchematicAlgoRelativeMainLine using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

SchematicAlgoRelativeMainLine

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

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

getDirection

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

Specified by:
getDirection in interface ISchematicAlgoRelativeMainLine
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
RelativeMainLine structure direction.

Specified by:
setDirection in interface ISchematicAlgoRelativeMainLine
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.

getDistanceBetweenBranches

public double getDistanceBetweenBranches()
                                  throws java.io.IOException,
                                         AutomationException
Spacing between the branches perpendicularly to the direction.

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

setDistanceBetweenBranches

public void setDistanceBetweenBranches(double pVal)
                                throws java.io.IOException,
                                       AutomationException
Spacing between the branches perpendicularly to the direction.

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

getBreakPointAngle

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

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

setBreakPointAngle

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

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

isCompressAlongDirection

public boolean isCompressAlongDirection()
                                 throws java.io.IOException,
                                        AutomationException
Indicates if the algorithm shrinks the distances between nodes along the direction.

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

setCompressAlongDirection

public void setCompressAlongDirection(boolean pVal)
                               throws java.io.IOException,
                                      AutomationException
Indicates if the algorithm shrinks the distances between nodes along the direction.

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

getMinimalDistanceBetweenNodes

public double getMinimalDistanceBetweenNodes()
                                      throws java.io.IOException,
                                             AutomationException
Minimal distance between nodes along direction defines where compression can occur.

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

setMinimalDistanceBetweenNodes

public void setMinimalDistanceBetweenNodes(double pVal)
                                    throws java.io.IOException,
                                           AutomationException
Minimal distance between nodes along direction defines where compression can occur.

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

getCompression

public double getCompression()
                      throws java.io.IOException,
                             AutomationException
Number comprised between 0 and 1 that define the percentage of compression along the direction.

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

setCompression

public void setCompression(double pVal)
                    throws java.io.IOException,
                           AutomationException
Number comprised between 0 and 1 that define the percentage of compression along the direction.

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

getLinesAttributeName

public java.lang.String getLinesAttributeName()
                                       throws java.io.IOException,
                                              AutomationException
The name of the attribute defining the parallel lines.

Specified by:
getLinesAttributeName in interface ISchematicAlgoRelativeMainLine
Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLinesAttributeName

public void setLinesAttributeName(java.lang.String name)
                           throws java.io.IOException,
                                  AutomationException
The name of the attribute defining the parallel lines.

Specified by:
setLinesAttributeName in interface ISchematicAlgoRelativeMainLine
Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseTypeAttribute

public boolean isUseTypeAttribute()
                           throws java.io.IOException,
                                  AutomationException
Indicates if the algorithm uses type values to distinguish between lines.

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

setUseTypeAttribute

public void setUseTypeAttribute(boolean pVal)
                         throws java.io.IOException,
                                AutomationException
Indicates if the algorithm uses type values to distinguish between lines.

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

getTypeAttributeName

public java.lang.String getTypeAttributeName()
                                      throws java.io.IOException,
                                             AutomationException
The name of the attribute defining the type of the lines.

Specified by:
getTypeAttributeName in interface ISchematicAlgoRelativeMainLine
Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTypeAttributeName

public void setTypeAttributeName(java.lang.String name)
                          throws java.io.IOException,
                                 AutomationException
The name of the attribute defining the type of the lines.

Specified by:
setTypeAttributeName in interface ISchematicAlgoRelativeMainLine
Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMainLinesTypeValue

public java.lang.String getMainLinesTypeValue()
                                       throws java.io.IOException,
                                              AutomationException
Define the main line type value.

Specified by:
getMainLinesTypeValue in interface ISchematicAlgoRelativeMainLine
Returns:
The value
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMainLinesTypeValue

public void setMainLinesTypeValue(java.lang.String value)
                           throws java.io.IOException,
                                  AutomationException
Define the main line type value.

Specified by:
setMainLinesTypeValue in interface ISchematicAlgoRelativeMainLine
Parameters:
value - The value (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExcludedTypeValues

public java.lang.String getExcludedTypeValues()
                                       throws java.io.IOException,
                                              AutomationException
Excluded type values.

Specified by:
getExcludedTypeValues in interface ISchematicAlgoRelativeMainLine
Returns:
The value
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExcludedTypeValues

public void setExcludedTypeValues(java.lang.String value)
                           throws java.io.IOException,
                                  AutomationException
Excluded type values.

Specified by:
setExcludedTypeValues in interface ISchematicAlgoRelativeMainLine
Parameters:
value - The value (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUsePriorityAttribute

public boolean isUsePriorityAttribute()
                               throws java.io.IOException,
                                      AutomationException
Indicates if the algorithm uses priority attribute to merge connected main lines.

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

setUsePriorityAttribute

public void setUsePriorityAttribute(boolean pVal)
                             throws java.io.IOException,
                                    AutomationException
Indicates if the algorithm uses priority attribute to merge connected main lines.

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

getPriorityAttributeName

public java.lang.String getPriorityAttributeName()
                                          throws java.io.IOException,
                                                 AutomationException
The name of the attribute defining the priority..

Specified by:
getPriorityAttributeName in interface ISchematicAlgoRelativeMainLine
Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPriorityAttributeName

public void setPriorityAttributeName(java.lang.String name)
                              throws java.io.IOException,
                                     AutomationException
The name of the attribute defining the priority..

Specified by:
setPriorityAttributeName in interface ISchematicAlgoRelativeMainLine
Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPriorityValue

public java.lang.String getPriorityValue()
                                  throws java.io.IOException,
                                         AutomationException
Define the priority value.

Specified by:
getPriorityValue in interface ISchematicAlgoRelativeMainLine
Returns:
The value
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPriorityValue

public void setPriorityValue(java.lang.String value)
                      throws java.io.IOException,
                             AutomationException
Define the priority value.

Specified by:
setPriorityValue in interface ISchematicAlgoRelativeMainLine
Parameters:
value - The value (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isInitialLengthIsGeometry

public boolean isInitialLengthIsGeometry()
                                  throws java.io.IOException,
                                         AutomationException
Indicates if the initial length is computed from the link geometry or fetched from an attibute.

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

setInitialLengthIsGeometry

public void setInitialLengthIsGeometry(boolean pVal)
                                throws java.io.IOException,
                                       AutomationException
Indicates if the initial length is computed from the link geometry or fetched from an attibute.

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

getLengthAttributeName

public java.lang.String getLengthAttributeName()
                                        throws java.io.IOException,
                                               AutomationException
The name of the attribute holding the initial length of the link.

Specified by:
getLengthAttributeName in interface ISchematicAlgoRelativeMainLine
Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLengthAttributeName

public void setLengthAttributeName(java.lang.String name)
                            throws java.io.IOException,
                                   AutomationException
The name of the attribute holding the initial length of the link.

Specified by:
setLengthAttributeName in interface ISchematicAlgoRelativeMainLine
Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isVerticesHint

public boolean isVerticesHint()
                       throws java.io.IOException,
                              AutomationException
Indicates if the link vertices are used to determine the side and orientation of the branches.

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

setVerticesHint

public void setVerticesHint(boolean pVal)
                     throws java.io.IOException,
                            AutomationException
Indicates if the link vertices are used to determine the side and orientation of the branches.

Specified by:
setVerticesHint in interface ISchematicAlgoRelativeMainLine
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.