LinkSegments (PLANitAllJava 0.2.0 API)

Type Parameters:

LS - link segment type

All Superinterfaces:

EdgeSegments<LS>, Iterable<LS>

All Known Implementing Classes:

LinkSegmentsImpl
```
public interface LinkSegments<LS extends LinkSegment>
extends EdgeSegments<LS>
```
wrapper around EdgeSegments interface to support LinkSegments explicitly rather than EdgeSegments

Author:

markr

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`LS`	`getByExternalId(String externalId)`	Retrieve a link segment by its external Id This method is not efficient, since it loops through all the registered link segments in order to find the required link segment.

Methods inherited from interface org.planit.utils.graph.EdgeSegments
create, get, getByXmlId, isEmpty, register, registerNew, registerUniqueCopyOf, remove, remove, size

Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator

- Method Detail
  - getByExternalId
```
LS getByExternalId(String externalId)
```
    Retrieve a link segment by its external Id This method is not efficient, since it loops through all the registered link segments in order to find the required link segment. TODO: currently utilised in Python wrapper via get_by_external_id as well as for feature in initial costs that can be provided by external id, this should be refactored such that this is no longer possible, or be made more efficient.
    
    Parameters:
    
    externalId - the external Id of the specified link segment type
    
    Returns:
    
    the retrieved link segment, or null if no link segment type was found