com.esri.arcgis.schematic
Class SchematicAlgoSeparateOverlappingLinks

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

All Implemented Interfaces:

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

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

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

Description 'Separate Overlapping Links 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.ISchematicAlgoSeparateOverlappingLinks

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

SchematicAlgoSeparateOverlappingLinks()
Constructs a SchematicAlgoSeparateOverlappingLinks using ArcGIS Engine.

SchematicAlgoSeparateOverlappingLinks(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SchematicAlgoSeparateOverlappingLinks theSchematicAlgoSeparateOverlappingLinks = (SchematicAlgoSeparateOverlappingLinks) 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	getBreakPointDistance() Distance between the extremity nodes of the links and the break points that will be inserted on the links that are overlapping.
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
IJSONArray	getJSONParametersArray() JSON parameters array.
java.lang.String	getLabel() The label of the algorithm.
IPropertySet	getPropertySet() The property set of the algorithm contains a collection of its parameters and their values.
ISchematicDiagramClassName	getSchematicDiagramClassName() The diagram class object used to initialize the algorithm.
double	getShiftBetweenLinks() Distance between the links that are overlapping so that they are separated.
double	getStep() Threshold value beyond which two link points are said to be non overlapping.
int	hashCode() the hashcode for this object
boolean	isAbsoluteParameters() Indicates if the values set for the distance parameters must be interpreted as absolute units.
boolean	isAvailable() Indicates if the algorithm is currently available.
boolean	isEnabled(ISchematicLayer schematicLayer) Indicates if the algorithm is currently enabled.
boolean	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	isUseOriginLinks() Indicates if the algorithm only processes the links parallel to the selected one.
boolean	isUseRootNode() Indicates if the algorithm use root nodes.
void	release() Release a SchematicAlgoSeparateOverlappingLinks.
void	setAbsoluteParameters(boolean pVal) Indicates if the values set for the distance parameters must be interpreted as absolute units.
void	setAvailable(boolean available) Indicates if the algorithm is currently available.
void	setBreakPointDistance(double pVal) Distance between the extremity nodes of the links and the break points that will be inserted on the links that are overlapping.
void	setJSONParametersObject(IJSONObject rhs1) JSON parameters object.
void	setLabel(java.lang.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	setSchematicDiagramClassNameByRef(ISchematicDiagramClassName schematicDiagramClassName) The diagram class object used to initialize the algorithm.
void	setShiftBetweenLinks(double pVal) Distance between the links that are overlapping so that they are separated.
void	setStep(double pVal) Threshold value beyond which two link points are said to be non overlapping.
void	setUseOriginLinks(boolean pVal) Indicates if the algorithm only processes the links parallel to the selected one.

Methods inherited from class java.lang.Object

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

Constructor Detail

SchematicAlgoSeparateOverlappingLinks

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

Constructs a SchematicAlgoSeparateOverlappingLinks using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

SchematicAlgoSeparateOverlappingLinks

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

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

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

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

Specified by:

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

getBreakPointDistance

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

Distance between the extremity nodes of the links and the break points that will be inserted on the links that are overlapping.

Specified by:

getBreakPointDistance in interface ISchematicAlgoSeparateOverlappingLinks

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBreakPointDistance

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

Distance between the extremity nodes of the links and the break points that will be inserted on the links that are overlapping.

Specified by:

setBreakPointDistance in interface ISchematicAlgoSeparateOverlappingLinks

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getShiftBetweenLinks

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

Distance between the links that are overlapping so that they are separated.

Specified by:

getShiftBetweenLinks in interface ISchematicAlgoSeparateOverlappingLinks

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShiftBetweenLinks

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

Distance between the links that are overlapping so that they are separated.

Specified by:

setShiftBetweenLinks in interface ISchematicAlgoSeparateOverlappingLinks

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStep

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

Threshold value beyond which two link points are said to be non overlapping.

Specified by:

getStep in interface ISchematicAlgoSeparateOverlappingLinks

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStep

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

Threshold value beyond which two link points are said to be non overlapping.

Specified by:

setStep in interface ISchematicAlgoSeparateOverlappingLinks

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAbsoluteParameters

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

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

Specified by:

isAbsoluteParameters in interface ISchematicAlgoSeparateOverlappingLinks

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAbsoluteParameters

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

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

Specified by:

setAbsoluteParameters in interface ISchematicAlgoSeparateOverlappingLinks

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUseOriginLinks

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

Indicates if the algorithm only processes the links parallel to the selected one. Only one link should be selected.

Specified by:

isUseOriginLinks in interface ISchematicAlgoSeparateOverlappingLinks

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseOriginLinks

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

Indicates if the algorithm only processes the links parallel to the selected one. Only one link should be selected.

Specified by:

setUseOriginLinks in interface ISchematicAlgoSeparateOverlappingLinks

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.