com.esri.arcgis.schematic
Class SchematicAnalystFindPath

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, ISchematicAlgorithm, ISchematicAlgorithmParameters, ISchematicAnalystFindPath, ISchematicAnalystTraceHighlight, ISchematicAnalystTraceResult, ISupportErrorInfo, Serializable

public class SchematicAnalystFindPath
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISchematicAnalystFindPath, ISchematicAlgorithm, ISchematicAlgorithmParameters, ISchematicAnalystTraceHighlight, ISchematicAnalystTraceResult, ISupportErrorInfo

Find Path schematic trace analyst object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

SchematicAnalystFindPath()
Constructs a SchematicAnalystFindPath using ArcGIS Engine.

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

Method Summary

void	clearResult() Clears the trace result.
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.
static String	getClsid() getClsid.
String	getLabel() Label for the schematic algorithm that displays in the Layout Task dropdown list.
int	getLinkColor() Color of the highlithted links.
int	getLinkStyle() Style of the highlithted links.
double	getLinkWidth() Width of the highlithted links.
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.
INgElements	getTraceResult() Returns the set of graphic elements detected by the trace operation.
String	getUserDataNameForLinkWeight() Name of the userdata that defines the links weight.
String	getUserDataNameOfForbiddenLinks() Name of the userdata that defines the forbidden links; that is, the links which prevent the detection from continuing beyond them.
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	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	isLinkColorSet() Indicates if the highlighting color currently set must be used to highlight the links detected by the trace operation.
boolean	isLinkStyleSet() Indicates if the highlighting style currently set must be used to highlight the links detected by the trace operation.
boolean	isLinkWidthSet() Indicates if the link width currently specified must be used to highlight the links detected by the trace operation.
boolean	isSelectLink() Indicates if the graphic links that belong to the Find Path trace result must be selected.
boolean	isSelectNode() Indicates if the graphic nodes that belong to the Find Path trace result must be selected.
void	setAvailable(boolean pVal) Indicates if the schematic algorithm is available from the Layout Task dropdown list.
void	setLabel(String pVal) Label for the schematic algorithm that displays in the Layout Task dropdown list.
void	setLinkColor(int pVal) Color of the highlithted links.
void	setLinkColorSet(boolean pVal) Indicates if the highlighting color currently set must be used to highlight the links detected by the trace operation.
void	setLinkStyle(int pVal) Style of the highlithted links.
void	setLinkStyleSet(boolean pVal) Indicates if the highlighting style currently set must be used to highlight the links detected by the trace operation.
void	setLinkWidth(double pVal) Width of the highlithted links.
void	setLinkWidthSet(boolean pVal) Indicates if the link width currently specified must be used to highlight the links detected by the trace operation.
void	setParameterValue(String name, Object value) List of the values for the schematic algorithm parameters.
void	setSelectLink(boolean pVal) Indicates if the graphic links that belong to the Find Path trace result must be selected.
void	setSelectNode(boolean pVal) Indicates if the graphic nodes that belong to the Find Path trace result must be selected.
void	setUserDataNameForLinkWeight(String pVal) Name of the userdata that defines the links weight.
void	setUserDataNameOfForbiddenLinks(String pVal) Name of the userdata that defines the forbidden links; that is, the links which prevent the detection from continuing beyond them.
void	showResult(int newVal) Shows the trace result.

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

SchematicAnalystFindPath

public SchematicAnalystFindPath()
                         throws IOException,
                                UnknownHostException

Constructs a SchematicAnalystFindPath using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

SchematicAnalystFindPath

public SchematicAnalystFindPath(Object obj)
                         throws IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems SchematicAnalystFindPath theSchematicAnalystFindPath = (SchematicAnalystFindPath) 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

isSelectNode

public boolean isSelectNode()
                     throws IOException,
                            AutomationException

Indicates if the graphic nodes that belong to the Find Path trace result must be selected.

Product Availability

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

Specified by:

isSelectNode in interface ISchematicAnalystFindPath

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

com.esri.arcgis.schematic.ISchematicAlgoFindPath

setSelectNode

public void setSelectNode(boolean pVal)
                   throws IOException,
                          AutomationException

Indicates if the graphic nodes that belong to the Find Path trace result must be selected.

Product Availability

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

Specified by:

setSelectNode in interface ISchematicAnalystFindPath

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSelectLink

public boolean isSelectLink()
                     throws IOException,
                            AutomationException

Indicates if the graphic links that belong to the Find Path trace result must be selected.

Product Availability

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

Specified by:

isSelectLink in interface ISchematicAnalystFindPath

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

com.esri.arcgis.schematic.ISchematicAlgoFindPath

setSelectLink

public void setSelectLink(boolean pVal)
                   throws IOException,
                          AutomationException

Indicates if the graphic links that belong to the Find Path trace result must be selected.

Product Availability

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

Specified by:

setSelectLink in interface ISchematicAnalystFindPath

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUserDataNameOfForbiddenLinks

public String getUserDataNameOfForbiddenLinks()
                                       throws IOException,
                                              AutomationException

Name of the userdata that defines the forbidden links; that is, the links which prevent the detection from continuing beyond them.

Product Availability

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

Specified by:

getUserDataNameOfForbiddenLinks in interface ISchematicAnalystFindPath

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

com.esri.arcgis.schematic.ISchematicAlgoFindPath, INgUserData

setUserDataNameOfForbiddenLinks

public void setUserDataNameOfForbiddenLinks(String pVal)
                                     throws IOException,
                                            AutomationException

Name of the userdata that defines the forbidden links; that is, the links which prevent the detection from continuing beyond them.

Product Availability

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

Specified by:

setUserDataNameOfForbiddenLinks in interface ISchematicAnalystFindPath

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUserDataNameForLinkWeight

public String getUserDataNameForLinkWeight()
                                    throws IOException,
                                           AutomationException

Name of the userdata that defines the links weight.

Product Availability

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

Specified by:

getUserDataNameForLinkWeight in interface ISchematicAnalystFindPath

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

com.esri.arcgis.schematic.ISchematicAlgoFindPath, INgUserData

setUserDataNameForLinkWeight

public void setUserDataNameForLinkWeight(String pVal)
                                  throws IOException,
                                         AutomationException

Name of the userdata that defines the links weight.

Product Availability

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

Specified by:

setUserDataNameForLinkWeight in interface ISchematicAnalystFindPath

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.

getLinkColor

public int getLinkColor()
                 throws IOException,
                        AutomationException

Color of the highlithted links.

Product Availability

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

Specified by:

getLinkColor in interface ISchematicAnalystTraceHighlight

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAnalystTraceHighlight.getLinkStyle(), ISchematicAnalystTraceHighlight.isLinkColorSet()

setLinkColor

public void setLinkColor(int pVal)
                  throws IOException,
                         AutomationException

Color of the highlithted links.

Product Availability

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

Specified by:

setLinkColor in interface ISchematicAnalystTraceHighlight

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLinkStyle

public int getLinkStyle()
                 throws IOException,
                        AutomationException

Style of the highlithted links.

Product Availability

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

Specified by:

getLinkStyle in interface ISchematicAnalystTraceHighlight

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAnalystTraceHighlight.isLinkStyleSet(), ISchematicAnalystTraceHighlight.getLinkColor()

setLinkStyle

public void setLinkStyle(int pVal)
                  throws IOException,
                         AutomationException

Style of the highlithted links.

Product Availability

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

Specified by:

setLinkStyle in interface ISchematicAnalystTraceHighlight

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLinkWidth

public double getLinkWidth()
                    throws IOException,
                           AutomationException

Width of the highlithted links.

Product Availability

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

Specified by:

getLinkWidth in interface ISchematicAnalystTraceHighlight

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAnalystTraceHighlight.isLinkWidthSet()

setLinkWidth

public void setLinkWidth(double pVal)
                  throws IOException,
                         AutomationException

Width of the highlithted links.

Product Availability

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

Specified by:

setLinkWidth in interface ISchematicAnalystTraceHighlight

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isLinkColorSet

public boolean isLinkColorSet()
                       throws IOException,
                              AutomationException

Indicates if the highlighting color currently set must be used to highlight the links detected by the trace operation.

Product Availability

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

Specified by:

isLinkColorSet in interface ISchematicAnalystTraceHighlight

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAnalystTraceHighlight.getLinkColor()

setLinkColorSet

public void setLinkColorSet(boolean pVal)
                     throws IOException,
                            AutomationException

Indicates if the highlighting color currently set must be used to highlight the links detected by the trace operation.

Product Availability

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

Specified by:

setLinkColorSet in interface ISchematicAnalystTraceHighlight

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isLinkStyleSet

public boolean isLinkStyleSet()
                       throws IOException,
                              AutomationException

Indicates if the highlighting style currently set must be used to highlight the links detected by the trace operation.

Product Availability

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

Specified by:

isLinkStyleSet in interface ISchematicAnalystTraceHighlight

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAnalystTraceHighlight.getLinkStyle()

setLinkStyleSet

public void setLinkStyleSet(boolean pVal)
                     throws IOException,
                            AutomationException

Indicates if the highlighting style currently set must be used to highlight the links detected by the trace operation.

Product Availability

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

Specified by:

setLinkStyleSet in interface ISchematicAnalystTraceHighlight

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isLinkWidthSet

public boolean isLinkWidthSet()
                       throws IOException,
                              AutomationException

Indicates if the link width currently specified must be used to highlight the links detected by the trace operation.

Product Availability

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

Specified by:

isLinkWidthSet in interface ISchematicAnalystTraceHighlight

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAnalystTraceHighlight.getLinkWidth()

setLinkWidthSet

public void setLinkWidthSet(boolean pVal)
                     throws IOException,
                            AutomationException

Indicates if the link width currently specified must be used to highlight the links detected by the trace operation.

Product Availability

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

Specified by:

setLinkWidthSet in interface ISchematicAnalystTraceHighlight

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearResult

public void clearResult()
                 throws IOException,
                        AutomationException

Clears the trace result. Applies only to trace results that are returned as drawings and not returned as a selection.

Product Availability

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

Specified by:

clearResult in interface ISchematicAnalystTraceResult

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

showResult

public void showResult(int newVal)
                throws IOException,
                       AutomationException

Shows the trace result.

Product Availability

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

Specified by:

showResult in interface ISchematicAnalystTraceResult

Parameters:

newVal - The newVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAnalystTraceResult.getTraceResult()

getTraceResult

public INgElements getTraceResult()
                           throws IOException,
                                  AutomationException

Returns the set of graphic elements detected by the trace operation.

Product Availability

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

Specified by:

getTraceResult in interface ISchematicAnalystTraceResult

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAnalystTraceResult.showResult(int)

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.