org.geolatte.geom

Interface PointSequenceBuilder

All Known Implementing Classes:

CountingPointSequenceBuilder

public interface PointSequenceBuilder

A builder for PointSequences.

PointSequence

s are built by adding points in sequence.

Author:

Karel Maesen, Geovise BVBA, 2011

Method Summary

Modifier and Type	Method and Description
PointSequenceBuilder	add(double[] coordinates) Adds a Point to the PointSequence being built.
PointSequenceBuilder	add(double x, double y) Adds a 2-dimensional point to the PointSequence being built.
PointSequenceBuilder	add(double x, double y, double zOrm) Adds a 3-dimensional point to the PointSequence being built.
PointSequenceBuilder	add(double x, double y, double z, double m) Adds a 4-dimensional point to the PointSequence being built.
PointSequenceBuilder	add(Point pnt) Adds the specified Point to the PointSequence being built.
CrsId	getCrsId() Returns the CrsId of the PointSequence being built.
DimensionalFlag	getDimensionalFlag() Returns the DimensionalFlag of the PointSequence being built.
int	getNumAdded() Returns the number of points already added to this PointSequence.
PointSequence	toPointSequence() Returns the result of this builder.

Method Detail

add

PointSequenceBuilder add(double[] coordinates)

Adds a Point to the PointSequence being built.

Parameters:

coordinates - the coordinates of the Point that is added

Returns:

this instance

add

PointSequenceBuilder add(double x,
                         double y)

Adds a 2-dimensional point to the PointSequence being built.

Parameters:

x - the X-coordinate of the of the Point that is added

y - the Y-coordinate of the of the Point that is added

Returns:

this instance

Throws:

IllegalArgumentException - when the DimensionalFlag returned by getDimensionalFlag() is not equal to DimensionalFlag.d2D

add

PointSequenceBuilder add(double x,
                         double y,
                         double zOrm)

Adds a 3-dimensional point to the PointSequence being built. The DimensionalFlag determines whether the third dimension is a Z- or M-coordinate.

Parameters:

x - the X-coordinate of the of the Point that is added

y - the Y-coordinate of the of the Point that is added

zOrm - the Z- or M-coordinate of the of the Point that is added

Returns:

this instance

Throws:

IllegalArgumentException - when the DimensionalFlag returned by getDimensionalFlag() is not equal to DimensionalFlag.d3D or DimensionalFlag.d2DM

add

PointSequenceBuilder add(double x,
                         double y,
                         double z,
                         double m)

Adds a 4-dimensional point to the PointSequence being built.

Parameters:

x - the X-coordinate of the of the Point that is added

y - the Y-coordinate of the of the Point that is added

z - the Z-coordinate of the of the Point that is added

m - the M-coordinate of the of the Point that is added

Returns:

this instance

Throws:

IllegalArgumentException - when the DimensionalFlag returned by getDimensionalFlag() is not equal to DimensionalFlag.d3DM

add

PointSequenceBuilder add(Point pnt)

Adds the specified Point to the PointSequence being built.

Parameters:

pnt - the Point that is added.

Returns:

this instance

Throws:

IllegalArgumentException - when the DimensionalFlag of the specified Point is not equal to the flag returned by getDimensionalFlag()

getDimensionalFlag

DimensionalFlag getDimensionalFlag()

Returns the DimensionalFlag of the PointSequence being built.

Returns:

the DimensionalFlag of the PointSequence being built.

getCrsId

CrsId getCrsId()

Returns the CrsId of the PointSequence being built.

Returns:

the CrsId of the PointSequence being built.

getNumAdded

int getNumAdded()

Returns the number of points already added to this PointSequence.

Returns:

toPointSequence

PointSequence toPointSequence()

Returns the result of this builder.

Returns:

the PointSequence that has been built by this builder instance.

Throws:

IllegalStateException - when the construction of the PointSequence has not yet been completed.