com.esri.arcgis.schematic
Class SchematicAlgoForceDirected

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

All Implemented Interfaces:

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

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

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

Description 'Force Directed 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.ISchematicAlgoForceDirected

IID, IIDb9e17264_21ac_4e55_8aad_911016aa5992, 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

SchematicAlgoForceDirected()
Constructs a SchematicAlgoForceDirected using ArcGIS Engine.

SchematicAlgoForceDirected(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SchematicAlgoForceDirected theSchematicAlgoForceDirected = (SchematicAlgoForceDirected) 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.
static java.lang.String	getClsid() getClsid.
int	getDegreeOfFreedom() Parameter value used to limit the area used to move the schematic nodes during each algorithm's iteration.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
IJSONArray	getJSONParametersArray() JSON parameters array.
java.lang.String	getLabel() The label of the algorithm.
int	getNumberOfIterations() Number of Force Directed schematic algorithm iterations executed before the final result is shown.
IPropertySet	getPropertySet() The property set of the algorithm contains a collection of its parameters and their values.
double	getRepelFactor() Parameter value used to quickly increase the schematic nodes displacement for nodes that are very close.
ISchematicDiagramClassName	getSchematicDiagramClassName() The diagram class object used to initialize the algorithm.
int	hashCode() the hashcode for this object
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.
boolean	isWithoutDegreeTwoNodes() Indicates if the nodes with degree 2 can be temporally out-of-the-way during the first phase of the algorithm execution so the computing time is decreased.
void	release() Release a SchematicAlgoForceDirected.
void	setAvailable(boolean available) Indicates if the algorithm is currently available.
void	setDegreeOfFreedom(int pVal) Parameter value used to limit the area used to move the schematic nodes during each algorithm's iteration.
void	setJSONParametersObject(IJSONObject rhs1) JSON parameters object.
void	setLabel(java.lang.String label) The label of the algorithm.
void	setNumberOfIterations(int pVal) Number of Force Directed schematic algorithm iterations executed before the final result is shown.
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	setRepelFactor(double pVal) Parameter value used to quickly increase the schematic nodes displacement for nodes that are very close.
void	setSchematicDiagramClassNameByRef(ISchematicDiagramClassName schematicDiagramClassName) The diagram class object used to initialize the algorithm.
void	setWithoutDegreeTwoNodes(boolean pVal) Indicates if the nodes with degree 2 can be temporally out-of-the-way during the first phase of the algorithm execution so the computing time is decreased.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SchematicAlgoForceDirected

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

Constructs a SchematicAlgoForceDirected using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

SchematicAlgoForceDirected

public SchematicAlgoForceDirected(java.lang.Object obj)
                           throws java.io.IOException

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

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

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

Specified by:

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

getNumberOfIterations

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

Number of Force Directed schematic algorithm iterations executed before the final result is shown.

Specified by:

getNumberOfIterations in interface ISchematicAlgoForceDirected

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNumberOfIterations

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

Number of Force Directed schematic algorithm iterations executed before the final result is shown.

Specified by:

setNumberOfIterations in interface ISchematicAlgoForceDirected

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDegreeOfFreedom

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

Parameter value used to limit the area used to move the schematic nodes during each algorithm's iteration.

Specified by:

getDegreeOfFreedom in interface ISchematicAlgoForceDirected

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDegreeOfFreedom

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

Parameter value used to limit the area used to move the schematic nodes during each algorithm's iteration.

Specified by:

setDegreeOfFreedom in interface ISchematicAlgoForceDirected

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRepelFactor

public double getRepelFactor()
                      throws java.io.IOException,
                             AutomationException

Parameter value used to quickly increase the schematic nodes displacement for nodes that are very close.

Specified by:

getRepelFactor in interface ISchematicAlgoForceDirected

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRepelFactor

public void setRepelFactor(double pVal)
                    throws java.io.IOException,
                           AutomationException

Parameter value used to quickly increase the schematic nodes displacement for nodes that are very close.

Specified by:

setRepelFactor in interface ISchematicAlgoForceDirected

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isWithoutDegreeTwoNodes

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

Indicates if the nodes with degree 2 can be temporally out-of-the-way during the first phase of the algorithm execution so the computing time is decreased.

Specified by:

isWithoutDegreeTwoNodes in interface ISchematicAlgoForceDirected

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setWithoutDegreeTwoNodes

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

Indicates if the nodes with degree 2 can be temporally out-of-the-way during the first phase of the algorithm execution so the computing time is decreased.

Specified by:

setWithoutDegreeTwoNodes in interface ISchematicAlgoForceDirected

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.