EdgeSegment (PLANitAllJava 0.1.0 API)

All Superinterfaces:

Comparable<EdgeSegment>, Serializable

All Known Subinterfaces:

ConnectoidSegment, LinkSegment, MacroscopicLinkSegment

All Known Implementing Classes:

ConnectoidSegmentImpl, EdgeSegmentImpl, LinkSegmentImpl, MacroscopicLinkSegmentImpl
```
public interface EdgeSegment
extends Comparable<EdgeSegment>, Serializable
```
EdgeSegment represents an edge in a particular (single) direction. Each edge has either one or two edge segments where each edge segment may have a more detailed geography than its parent edge

Author:

markr

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Vertex`	`getDownstreamVertex()`	Get the segment's downstream vertex
`Object`	`getExternalId()`	Get external id of the instance.
`long`	`getId()`	Return id of this instance.
`Edge`	`getParentEdge()`	Collect the parent edge of the segment
`Vertex`	`getUpstreamVertex()`	Get the segment's upstream vertex
`boolean`	`hasExternalId()`	Does the instance have an external id
`void`	`setExternalId(Object externalId)`	set external id of the instance.

Methods inherited from interface java.lang.Comparable
compareTo

- Method Detail
  - getId
```
long getId()
```
    Return id of this instance. This id is expected to be generated using the org.planit.utils.misc.IdGenerator
    
    Returns:
    
    id the id
  - setExternalId
```
void setExternalId(Object externalId)
```
    set external id of the instance. Note that this id need not be unique (unlike regular id)
    
    Parameters:
    
    externalId - the external id to set
  - hasExternalId
```
boolean hasExternalId()
```
    Does the instance have an external id
    
    Returns:
    
    true when available, false otherwise
  - getExternalId
```
Object getExternalId()
```
    Get external id of the instance. Note that this id need not be unique (unlike regular id)
    
    Returns:
    
    externalId
  - getUpstreamVertex
```
Vertex getUpstreamVertex()
```
    Get the segment's upstream vertex
    
    Returns:
    
    upstream vertex
  - getDownstreamVertex
```
Vertex getDownstreamVertex()
```
    Get the segment's downstream vertex
    
    Returns:
    
    downstream vertex
  - getParentEdge
```
Edge getParentEdge()
```
    Collect the parent edge of the segment
    
    Returns:
    
    parentEdge