com.esri.arcgis.schematic
Class SchematicAnalystFindPath

java.lang.Object
  extended by com.esri.arcgis.schematic.SchematicAnalystFindPath
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, ISchematicAlgorithm, ISchematicAnalystFindPath, ISchematicAnalystTraceResult, Serializable

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

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)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SchematicAnalystFindPath theSchematicAnalystFindPath = (SchematicAnalystFindPath) obj;
 
Method Summary
 void clearResult()
          Release internal results of the previous trace.
 boolean equals(Object o)
          Compare this object with another
 void execute(ISchematicLayer schematicLayer, ITrackCancel cancelTracker)
          Execute the schematic algorithm.
 String getAlgorithmCLSID()
          The CLSID of the algorithm.
static String getClsid()
          getClsid.
 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.
 IEnumSchematicFeature getTraceResult()
          The set of schematic features 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
 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 isSelectLink()
          Indicates if the schematic links that belong to the Find Path trace result must be selected.
 boolean isSelectNode()
          Indicates if the schematic nodes that belong to the Find Path trace result must be selected.
 boolean isUseEndNode()
          Indicates if the algorithm use end nodes.
 boolean isUseRootNode()
          Indicates if the algorithm use root nodes.
 void setAvailable(boolean available)
          Indicates if the algorithm is currently available.
 void setLabel(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 setSelectLink(boolean selectLink)
          Indicates if the schematic links that belong to the Find Path trace result must be selected.
 void setSelectNode(boolean selectNode)
          Indicates if the schematic nodes that belong to the Find Path trace result must be selected.
 void setUserDataNameForLinkWeight(String name)
          Name of the userdata that defines the links weight.
 void setUserDataNameOfForbiddenLinks(String name)
          Name of the userdata that defines the forbidden links; that is, the links which prevent the detection from continuing beyond them.
 
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
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SchematicAnalystFindPath theSchematicAnalystFindPath = (SchematicAnalystFindPath) obj;

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

getTraceResult

public IEnumSchematicFeature getTraceResult()
                                     throws IOException,
                                            AutomationException
The set of schematic features 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.IEnumSchematicFeature
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clearResult

public void clearResult()
                 throws IOException,
                        AutomationException
Release internal results of the previous trace.

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.

isEnabled

public boolean isEnabled(ISchematicLayer schematicLayer)
                  throws IOException,
                         AutomationException
Indicates if the algorithm is currently enabled.

Product Availability

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

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAvailable

public boolean isAvailable()
                    throws IOException,
                           AutomationException
Indicates if the algorithm is currently available.

Product Availability

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

Specified by:
isAvailable in interface ISchematicAlgorithm
Returns:
The available
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAvailable

public void setAvailable(boolean available)
                  throws IOException,
                         AutomationException
Indicates if the algorithm is currently available.

Product Availability

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

Specified by:
setAvailable in interface ISchematicAlgorithm
Parameters:
available - The available (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isOverridable

public boolean isOverridable()
                      throws IOException,
                             AutomationException
Indicates if the algorithm properties page is editable from ArcMap; that is, enabling the Layout Properties button in ArcMap.

Product Availability

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

Specified by:
isOverridable in interface ISchematicAlgorithm
Returns:
The pOverridable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOverridable

public void setOverridable(boolean pOverridable)
                    throws IOException,
                           AutomationException
Indicates if the algorithm properties page is editable from ArcMap; that is, enabling the Layout Properties button in ArcMap.

Product Availability

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

Specified by:
setOverridable in interface ISchematicAlgorithm
Parameters:
pOverridable - The pOverridable (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicDiagramClassName

public ISchematicDiagramClassName getSchematicDiagramClassName()
                                                        throws IOException,
                                                               AutomationException
The diagram class object used to initialize the algorithm.

Product Availability

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

Specified by:
getSchematicDiagramClassName in interface ISchematicAlgorithm
Returns:
A reference to a com.esri.arcgis.schematic.ISchematicDiagramClassName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSchematicDiagramClassNameByRef

public void setSchematicDiagramClassNameByRef(ISchematicDiagramClassName schematicDiagramClassName)
                                       throws IOException,
                                              AutomationException
The diagram class object used to initialize the algorithm.

Product Availability

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

Specified by:
setSchematicDiagramClassNameByRef in interface ISchematicAlgorithm
Parameters:
schematicDiagramClassName - A reference to a com.esri.arcgis.schematic.ISchematicDiagramClassName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabel

public String getLabel()
                throws IOException,
                       AutomationException
The label of the algorithm.

Product Availability

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

Specified by:
getLabel in interface ISchematicAlgorithm
Returns:
The label
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabel

public void setLabel(String label)
              throws IOException,
                     AutomationException
The label of the algorithm.

Product Availability

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

Specified by:
setLabel in interface ISchematicAlgorithm
Parameters:
label - The label (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseRootNode

public boolean isUseRootNode()
                      throws IOException,
                             AutomationException
Indicates if the algorithm use root nodes.

Product Availability

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

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

isUseEndNode

public boolean isUseEndNode()
                     throws IOException,
                            AutomationException
Indicates if the algorithm use end nodes.

Product Availability

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

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

getPropertySet

public IPropertySet getPropertySet()
                            throws IOException,
                                   AutomationException
The property set of the algorithm contains a collection of its parameters and their values.

Product Availability

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

Specified by:
getPropertySet in interface ISchematicAlgorithm
Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPropertySet

public void setPropertySet(IPropertySet propertySet)
                    throws IOException,
                           AutomationException
The property set of the algorithm contains a collection of its parameters and their values.

Product Availability

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

Specified by:
setPropertySet in interface ISchematicAlgorithm
Parameters:
propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAlgorithmCLSID

public String getAlgorithmCLSID()
                         throws IOException,
                                AutomationException
The CLSID of the algorithm.

Product Availability

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

Specified by:
getAlgorithmCLSID in interface ISchematicAlgorithm
Returns:
The bstrCLSID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

execute

public void execute(ISchematicLayer schematicLayer,
                    ITrackCancel cancelTracker)
             throws IOException,
                    AutomationException
Execute the schematic algorithm.

Product Availability

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

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSelectNode

public boolean isSelectNode()
                     throws IOException,
                            AutomationException
Indicates if the schematic 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 selectNode
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSelectNode

public void setSelectNode(boolean selectNode)
                   throws IOException,
                          AutomationException
Indicates if the schematic 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:
selectNode - The selectNode (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 schematic 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 selectLink
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSelectLink

public void setSelectLink(boolean selectLink)
                   throws IOException,
                          AutomationException
Indicates if the schematic 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:
selectLink - The selectLink (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 name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUserDataNameOfForbiddenLinks

public void setUserDataNameOfForbiddenLinks(String name)
                                     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:
name - The name (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 name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUserDataNameForLinkWeight

public void setUserDataNameForLinkWeight(String name)
                                  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:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.