com.esri.arcgis.geodatabase
Class TopologyEdge

java.lang.Object
  com.esri.arcgis.geodatabase.TopologyEdge

All Implemented Interfaces:

ITopologyEdge, ITopologyElement, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class TopologyEdge
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ITopologyElement, ITopologyEdge

Esri Topology Edge object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

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

Method Summary

boolean	equals(Object o) Compare this object with another
ITopologyNode	getFromNode() A reference to the topology node at the from point of this edge.
IGeometry	getGeometry() The geometry of the topology element.
IEnumTopologyParent	getLeftParents(boolean boundedByEdge) The set of parents (polygon features) that cover this edge.
IEnumTopologyParent	getParents() The set of parents (features) of this topology element.
IEnumTopologyParent	getRightParents(boolean boundedByEdge) The set of parents (polygon features) that cover this edge.
ITopologyNode	getToNode() A reference to the topology node at the to point of this edge.
int	hashCode() the hashcode for this object
boolean	isDeleted() Indicates if this element has been deleted from its containing topology graph.
boolean	isLeftVisited() Indicates if the left side of the edge was visited.
boolean	isRightVisited() Indicates if the right side of the edge was visited.
boolean	isSelected() Indicates if this element is part of its containing topology graph's selected set.
boolean	isVisited() Indicates if the topology element has been visited.
void	queryGeometry(IGeometry geometry) Copies the element's geometry into the specified geometry.
void	setLeftVisited(boolean isLeftVisited) Indicates if the left side of the edge was visited.
void	setRightVisited(boolean isRightVisited) Indicates if the right side of the edge was visited.
void	setVisited(boolean isVisited) Indicates if the topology element has been visited.

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

TopologyEdge

public TopologyEdge(Object obj)
             throws IOException

Construct a TopologyEdge using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to TopologyEdge.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
TopologyEdge o = (TopologyEdge)obj; // will not work

TopologyEdge o = new TopologyEdge(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems TopologyEdge theTopologyEdge = (TopologyEdge) obj;

Method Detail

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

getGeometry

public IGeometry getGeometry()
                      throws IOException,
                             AutomationException

The geometry of the topology element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getGeometry in interface ITopologyElement

Returns:

A reference to a com.esri.arcgis.geometry.IGeometry

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSelected

public boolean isSelected()
                   throws IOException,
                          AutomationException

Indicates if this element is part of its containing topology graph's selected set.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isSelected in interface ITopologyElement

Returns:

The selected

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryGeometry

public void queryGeometry(IGeometry geometry)
                   throws IOException,
                          AutomationException

Copies the element's geometry into the specified geometry.

Remarks

The Geometry parameter must be an instance of an appropriate type of geometry for the topology element being called. For example, if the topology element is a node, a new point should be created and passed as the parameter, and if the topology element is an edge, a new polyline should be created and passed as the parameter.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

queryGeometry in interface ITopologyElement

Parameters:

geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDeleted

public boolean isDeleted()
                  throws IOException,
                         AutomationException

Indicates if this element has been deleted from its containing topology graph.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDeleted in interface ITopologyElement

Returns:

The deleted

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParents

public IEnumTopologyParent getParents()
                               throws IOException,
                                      AutomationException

The set of parents (features) of this topology element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getParents in interface ITopologyElement

Returns:

A reference to a com.esri.arcgis.geodatabase.IEnumTopologyParent

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isVisited

public boolean isVisited()
                  throws IOException,
                         AutomationException

Indicates if the topology element has been visited.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isVisited in interface ITopologyElement

Returns:

The isVisited

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVisited

public void setVisited(boolean isVisited)
                throws IOException,
                       AutomationException

Indicates if the topology element has been visited.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setVisited in interface ITopologyElement

Parameters:

isVisited - The isVisited (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFromNode

public ITopologyNode getFromNode()
                          throws IOException,
                                 AutomationException

A reference to the topology node at the from point of this edge.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFromNode in interface ITopologyEdge

Returns:

A reference to a com.esri.arcgis.geodatabase.ITopologyNode

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getToNode

public ITopologyNode getToNode()
                        throws IOException,
                               AutomationException

A reference to the topology node at the to point of this edge.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getToNode in interface ITopologyEdge

Returns:

A reference to a com.esri.arcgis.geodatabase.ITopologyNode

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLeftParents

public IEnumTopologyParent getLeftParents(boolean boundedByEdge)
                                   throws IOException,
                                          AutomationException

The set of parents (polygon features) that cover this edge. If boundedByEdge is true, then only polygons lying to the left of the edge will be returned.

Product Availability

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

Specified by:

getLeftParents in interface ITopologyEdge

Parameters:

boundedByEdge - The boundedByEdge (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IEnumTopologyParent

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRightParents

public IEnumTopologyParent getRightParents(boolean boundedByEdge)
                                    throws IOException,
                                           AutomationException

The set of parents (polygon features) that cover this edge. If boundedByEdge is true, then only polygons lying to the right of the edge will be returned.

Product Availability

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

Specified by:

getRightParents in interface ITopologyEdge

Parameters:

boundedByEdge - The boundedByEdge (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IEnumTopologyParent

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isLeftVisited

public boolean isLeftVisited()
                      throws IOException,
                             AutomationException

Indicates if the left side of the edge was visited.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isLeftVisited in interface ITopologyEdge

Returns:

The isLeftVisited

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLeftVisited

public void setLeftVisited(boolean isLeftVisited)
                    throws IOException,
                           AutomationException

Indicates if the left side of the edge was visited.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLeftVisited in interface ITopologyEdge

Parameters:

isLeftVisited - The isLeftVisited (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRightVisited

public boolean isRightVisited()
                       throws IOException,
                              AutomationException

Indicates if the right side of the edge was visited.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isRightVisited in interface ITopologyEdge

Returns:

The isRightVisited

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRightVisited

public void setRightVisited(boolean isRightVisited)
                     throws IOException,
                            AutomationException

Indicates if the right side of the edge was visited.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setRightVisited in interface ITopologyEdge

Parameters:

isRightVisited - The isRightVisited (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.