com.esri.arcgis.schematic
Class SchematicAlgoSeparateOverlappingLinks

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, ISchematicAlgorithm, ISchematicAlgorithmParameters, ISchematicAlgoSeparateOverlappingLinks, ISchematicAlgoSeparateOverlappingLinks2, ISupportErrorInfo, Serializable

public class SchematicAlgoSeparateOverlappingLinks
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISchematicAlgoSeparateOverlappingLinks, ISchematicAlgoSeparateOverlappingLinks2, ISchematicAlgorithm, ISchematicAlgorithmParameters, ISupportErrorInfo

Separate Overlapping Links schematic algorithm object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

SchematicAlgoSeparateOverlappingLinks()
Constructs a SchematicAlgoSeparateOverlappingLinks using ArcGIS Engine.

SchematicAlgoSeparateOverlappingLinks(Object obj)
Construct a SchematicAlgoSeparateOverlappingLinks using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	equals(Object o) Compare this object with another
void	execute(INgView view, INgCancelTracker tracker) Executes the schematic algorithm.
String	getAlgorithmCLSID() CLSID of the schematic 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 String	getClsid() getClsid.
String	getLabel() Label for the schematic algorithm that displays in the Layout Task dropdown list.
INgNames	getParameterNames() List of the names for the schematic algorithm parameters.
Object	getParameterValue(String name) List of the values for the schematic algorithm parameters.
INgProject	getProject() Project the schematic algorithm is related to.
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
void	initialize(INgProject wrk) Initializes the schematic algorithm for the specified project.
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isAbsoluteParameters() Indicates if the values set for the distance parameters must be interpreted as absolute units.
boolean	isAvailable() Indicates if the schematic algorithm is available from the Layout Task dropdown list.
boolean	isEnabled(INgView view) Indicates if the schematic algorithm is enabled.
boolean	isUseOriginLinks() Indicates if the Separate Overlapping Links algorithm can work with links that are connected with sames extremities.
boolean	isWorkOnUnvisibleObjects() Indicates if the Separate Overlapping Links algorithm must work both with the visible and invisible graphic elements.
void	setAbsoluteParameters(boolean pVal) Indicates if the values set for the distance parameters must be interpreted as absolute units.
void	setAvailable(boolean pVal) Indicates if the schematic algorithm is available from the Layout Task dropdown list.
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	setLabel(String pVal) Label for the schematic algorithm that displays in the Layout Task dropdown list.
void	setParameterValue(String name, Object value) List of the values for the schematic algorithm parameters.
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 Separate Overlapping Links algorithm can work with links that are connected with sames extremities.
void	setWorkOnUnvisibleObjects(boolean pVal) Indicates if the Separate Overlapping Links algorithm must work both with the visible and invisible graphic elements.

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

SchematicAlgoSeparateOverlappingLinks

public SchematicAlgoSeparateOverlappingLinks()
                                      throws IOException,
                                             UnknownHostException

Constructs a SchematicAlgoSeparateOverlappingLinks using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

SchematicAlgoSeparateOverlappingLinks

public SchematicAlgoSeparateOverlappingLinks(Object obj)
                                      throws IOException

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:

IOException - if there are interop problems SchematicAlgoSeparateOverlappingLinks theSchematicAlgoSeparateOverlappingLinks = (SchematicAlgoSeparateOverlappingLinks) obj;

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

getBreakPointDistance

public double getBreakPointDistance()
                             throws IOException,
                                    AutomationException

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

Product Availability

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

Specified by:

getBreakPointDistance in interface ISchematicAlgoSeparateOverlappingLinks

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgoSeparateOverlappingLinks.getShiftBetweenLinks()

setBreakPointDistance

public void setBreakPointDistance(double pVal)
                           throws IOException,
                                  AutomationException

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

Product Availability

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

Specified by:

setBreakPointDistance in interface ISchematicAlgoSeparateOverlappingLinks

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getShiftBetweenLinks

public double getShiftBetweenLinks()
                            throws IOException,
                                   AutomationException

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

Product Availability

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

Specified by:

getShiftBetweenLinks in interface ISchematicAlgoSeparateOverlappingLinks

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgoSeparateOverlappingLinks.getBreakPointDistance()

setShiftBetweenLinks

public void setShiftBetweenLinks(double pVal)
                          throws IOException,
                                 AutomationException

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

Product Availability

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

Specified by:

setShiftBetweenLinks in interface ISchematicAlgoSeparateOverlappingLinks

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStep

public double getStep()
               throws IOException,
                      AutomationException

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

Product Availability

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

Specified by:

getStep in interface ISchematicAlgoSeparateOverlappingLinks

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStep

public void setStep(double pVal)
             throws IOException,
                    AutomationException

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

Product Availability

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

Specified by:

setStep in interface ISchematicAlgoSeparateOverlappingLinks

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isWorkOnUnvisibleObjects

public boolean isWorkOnUnvisibleObjects()
                                 throws IOException,
                                        AutomationException

Indicates if the Separate Overlapping Links algorithm must work both with the visible and invisible graphic elements.

Product Availability

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

Specified by:

isWorkOnUnvisibleObjects in interface ISchematicAlgoSeparateOverlappingLinks

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWorkOnUnvisibleObjects

public void setWorkOnUnvisibleObjects(boolean pVal)
                               throws IOException,
                                      AutomationException

Indicates if the Separate Overlapping Links algorithm must work both with the visible and invisible graphic elements.

Product Availability

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

Specified by:

setWorkOnUnvisibleObjects in interface ISchematicAlgoSeparateOverlappingLinks

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAbsoluteParameters

public boolean isAbsoluteParameters()
                             throws IOException,
                                    AutomationException

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

Description

If this parameter is false, the distance parameters are interpreted as relative units to the average of the current symbols sizes used to represent the schematic nodes in the diagram; that is, for instance, if the ShiftBetweenLinks property value is 2, the distance that will separate two links that were overlapping will correspond to the average size of two symbols placed side by side

Product Availability

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

Specified by:

isAbsoluteParameters in interface ISchematicAlgoSeparateOverlappingLinks

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAbsoluteParameters

public void setAbsoluteParameters(boolean pVal)
                           throws IOException,
                                  AutomationException

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

Product Availability

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

Specified by:

setAbsoluteParameters in interface ISchematicAlgoSeparateOverlappingLinks

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseOriginLinks

public boolean isUseOriginLinks()
                         throws IOException,
                                AutomationException

Indicates if the Separate Overlapping Links algorithm can work with links that are connected with sames extremities.

Product Availability

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

Specified by:

isUseOriginLinks in interface ISchematicAlgoSeparateOverlappingLinks2

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseOriginLinks

public void setUseOriginLinks(boolean pVal)
                       throws IOException,
                              AutomationException

Indicates if the Separate Overlapping Links algorithm can work with links that are connected with sames extremities.

Product Availability

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

Specified by:

setUseOriginLinks in interface ISchematicAlgoSeparateOverlappingLinks2

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

execute

public void execute(INgView view,
                    INgCancelTracker tracker)
             throws IOException,
                    AutomationException

Executes the schematic algorithm.

Product Availability

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

Specified by:

execute in interface ISchematicAlgorithm

Parameters:

view - A reference to a com.esri.arcgis.schematic.INgView (in, optional, pass 0 if not required)

tracker - A reference to a com.esri.arcgis.schematic.INgCancelTracker (in, optional, pass 0 if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnabled

public boolean isEnabled(INgView view)
                  throws IOException,
                         AutomationException

Indicates if the schematic algorithm is enabled. That is, if the Apply button is available.

Product Availability

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

Specified by:

isEnabled in interface ISchematicAlgorithm

Parameters:

view - A reference to a com.esri.arcgis.schematic.INgView (in, optional, pass 0 if not required)

Returns:

The pVal

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 schematic algorithm is available from the Layout Task dropdown list.

Product Availability

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

Specified by:

isAvailable in interface ISchematicAlgorithm

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAvailable

public void setAvailable(boolean pVal)
                  throws IOException,
                         AutomationException

Indicates if the schematic algorithm is available from the Layout Task dropdown list.

Product Availability

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

Specified by:

setAvailable in interface ISchematicAlgorithm

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabel

public String getLabel()
                throws IOException,
                       AutomationException

Label for the schematic algorithm that displays in the Layout Task dropdown list.

Product Availability

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

Specified by:

getLabel in interface ISchematicAlgorithm

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabel

public void setLabel(String pVal)
              throws IOException,
                     AutomationException

Label for the schematic algorithm that displays in the Layout Task dropdown list.

Product Availability

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

Specified by:

setLabel in interface ISchematicAlgorithm

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

initialize

public void initialize(INgProject wrk)
                throws IOException,
                       AutomationException

Initializes the schematic algorithm for the specified project.

Product Availability

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

Specified by:

initialize in interface ISchematicAlgorithm

Parameters:

wrk - A reference to a com.esri.arcgis.schematic.INgProject (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAlgorithmCLSID

public String getAlgorithmCLSID()
                         throws IOException,
                                AutomationException

CLSID of the schematic algorithm.

Product Availability

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

Specified by:

getAlgorithmCLSID in interface ISchematicAlgorithm

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProject

public INgProject getProject()
                      throws IOException,
                             AutomationException

Project the schematic algorithm is related to.

Product Availability

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

Specified by:

getProject in interface ISchematicAlgorithm

Returns:

A reference to a com.esri.arcgis.schematic.INgProject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParameterNames

public INgNames getParameterNames()
                           throws IOException,
                                  AutomationException

List of the names for the schematic algorithm parameters.

Product Availability

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

Specified by:

getParameterNames in interface ISchematicAlgorithmParameters

Returns:

A reference to a com.esri.arcgis.schematic.INgNames

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgorithmParameters.setParameterValue(String, java.lang.Object)

setParameterValue

public void setParameterValue(String name,
                              Object value)
                       throws IOException,
                              AutomationException

List of the values for the schematic algorithm parameters.

Product Availability

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

Specified by:

setParameterValue in interface ISchematicAlgorithmParameters

Parameters:

name - The name (in)

value - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParameterValue

public Object getParameterValue(String name)
                         throws IOException,
                                AutomationException

List of the values for the schematic algorithm parameters.

Product Availability

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

Specified by:

getParameterValue in interface ISchematicAlgorithmParameters

Parameters:

name - The name (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.