Package org.locationtech.jts.noding

Class BasicSegmentString

java.lang.Object

org.locationtech.jts.noding.BasicSegmentString

All Implemented Interfaces:

SegmentString

public class BasicSegmentString
extends java.lang.Object
implements SegmentString

Represents a read-only list of contiguous line segments. This can be used for detection of intersections or nodes. SegmentStrings can carry a context object, which is useful for preserving topological or parentage information.

If adding nodes is required use NodedSegmentString.

Version:

1.7

See Also:

NodedSegmentString

Constructor Summary

Constructors

Constructor	Description
BasicSegmentString(Coordinate[] pts, java.lang.Object data)	Creates a new segment string from a list of vertices.

Method Summary

Modifier and Type	Method	Description
Coordinate	getCoordinate(int i)
Coordinate[]	getCoordinates()
java.lang.Object	getData()	Gets the user-defined data for this segment string.
int	getSegmentOctant(int index)	Gets the octant of the segment starting at vertex index.
boolean	isClosed()
void	setData(java.lang.Object data)	Sets the user-defined data for this segment string.
int	size()
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BasicSegmentString

public BasicSegmentString(Coordinate[] pts,
                          java.lang.Object data)

Creates a new segment string from a list of vertices.

Parameters:

pts - the vertices of the segment string

data - the user-defined data of this segment string (may be null)

Method Detail

getData

public java.lang.Object getData()

Gets the user-defined data for this segment string.

Specified by:

getData in interface SegmentString

Returns:

the user-defined data

setData

public void setData(java.lang.Object data)

Sets the user-defined data for this segment string.

Specified by:

setData in interface SegmentString

Parameters:

data - an Object containing user-defined data

size

public int size()

Specified by:

size in interface SegmentString

getCoordinate

public Coordinate getCoordinate(int i)

Specified by:

getCoordinate in interface SegmentString

getCoordinates

public Coordinate[] getCoordinates()

Specified by:

getCoordinates in interface SegmentString

isClosed

public boolean isClosed()

Specified by:

isClosed in interface SegmentString

getSegmentOctant

public int getSegmentOctant(int index)

Gets the octant of the segment starting at vertex index.

Parameters:

index - the index of the vertex starting the segment. Must not be the last index in the vertex list

Returns:

the octant of the segment at the vertex

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object