org.locationtech.jts.geom

Interface CoordinateSequenceFactory

All Known Implementing Classes:

CoordinateArraySequenceFactory, PackedCoordinateSequenceFactory

public interface CoordinateSequenceFactory

A factory to create concrete instances of CoordinateSequences. Used to configure GeometryFactorys to provide specific kinds of CoordinateSequences.

Version:

1.7

Method Summary

Modifier and Type	Method and Description
CoordinateSequence	create(Coordinate[] coordinates) Returns a CoordinateSequence based on the given array.
CoordinateSequence	create(CoordinateSequence coordSeq) Creates a CoordinateSequence which is a copy of the given CoordinateSequence.
CoordinateSequence	create(int size, int dimension) Creates a CoordinateSequence of the specified size and dimension.
default CoordinateSequence	create(int size, int dimension, int measures) Creates a CoordinateSequence of the specified size and dimension with measure support.

Method Detail

create

CoordinateSequence create(Coordinate[] coordinates)

Returns a CoordinateSequence based on the given array. Whether the array is copied or simply referenced is implementation-dependent. This method must handle null arguments by creating an empty sequence.

Parameters:

coordinates - the coordinates

create

CoordinateSequence create(CoordinateSequence coordSeq)

Creates a CoordinateSequence which is a copy of the given CoordinateSequence. This method must handle null arguments by creating an empty sequence.

Parameters:

coordSeq - the coordinate sequence to copy

create

CoordinateSequence create(int size,
                          int dimension)

Creates a CoordinateSequence of the specified size and dimension. For this to be useful, the CoordinateSequence implementation must be mutable.

If the requested dimension is larger than the CoordinateSequence implementation can provide, then a sequence of maximum possible dimension should be created. An error should not be thrown.

Parameters:

size - the number of coordinates in the sequence

dimension - the dimension of the coordinates in the sequence (if user-specifiable, otherwise ignored)

create

default CoordinateSequence create(int size,
                                  int dimension,
                                  int measures)

Creates a CoordinateSequence of the specified size and dimension with measure support. For this to be useful, the CoordinateSequence implementation must be mutable.

If the requested dimension or measures are larger than the CoordinateSequence implementation can provide, then a sequence of maximum possible dimension should be created. An error should not be thrown.

Parameters:

size - the number of coordinates in the sequence

dimension - the dimension of the coordinates in the sequence (if user-specifiable, otherwise ignored)

measures - the number of measures of the coordinates in the sequence (if user-specifiable, otherwise ignored)