public class PointCoordinates extends ListBase implements java.lang.Iterable<java.lang.Double>
Represents an N-dimensional point.
Note that some coordinate reference systems will support only PointCoordinates.x and PointCoordinates.y dimensions.
| Modifier and Type | Field and Description |
|---|---|
static PointCoordinates |
empty |
| Constructor and Description |
|---|
PointCoordinates()
|
PointCoordinates(int capacity)
Construct a new list with
PointCoordinates.length of zero and optional initial capacity. |
| Modifier and Type | Method and Description |
|---|---|
void |
add(double item)
Add
item to the end of this list. |
void |
addAll(PointCoordinates list)
Add all the items of
list to the end of this list. |
PointCoordinates |
addThis(double item)
Add
item to the end of this list. |
PointCoordinates |
copy()
Return a shallow copy of this list.
|
double |
first()
Return the first item in this list.
|
static PointCoordinates |
from(java.util.List<java.lang.Double> list) |
double |
get(int index)
Return the item in this list at the specified
index. |
double |
getAltitude()
Return synonym for
PointCoordinates.z. |
double |
getLatitude()
Return synonym for
PointCoordinates.y. |
double |
getLongitude()
Return synonym for
PointCoordinates.x. |
double |
getM()
Return the
M dimension (e.g. |
double |
getMeasure()
Return synonym for
PointCoordinates.m. |
double |
getX()
Return the
X dimension (e.g. |
double |
getY()
Return the
Y dimension (e.g. |
double |
getZ()
Return the
Z dimension (e.g. |
boolean |
includes(double item)
Return
true if this list contains item. |
int |
indexOf(double item)
See indexOf(double, int).
|
int |
indexOf(double item,
int start)
Return first index in this list of
item, or -1 if not found. |
void |
insertAll(int index,
PointCoordinates list)
Insert all items of
list into this list, before the item (if any) at index. |
void |
insertAt(int index,
double item)
Insert
item into this list, before the item (if any) at index. |
java.util.Iterator<java.lang.Double> |
iterator() |
double |
last()
Return the last item in this list.
|
int |
lastIndexOf(double item)
|
int |
lastIndexOf(double item,
int start)
Return last index in this list of
item, or -1 if not found. |
void |
set(int index,
double item)
Set the item in this list at the specified
index. |
void |
setAltitude(double value)
Set synonym for
PointCoordinates.z. |
void |
setLatitude(double value)
Set synonym for
PointCoordinates.y. |
void |
setLongitude(double value)
Set synonym for
PointCoordinates.x. |
void |
setX(double value)
Set the
X dimension (e.g. |
void |
setY(double value)
Set the
Y dimension (e.g. |
void |
setZ(double value)
Set the
Z dimension (e.g. |
static PointCoordinates |
share(ListBase list)
|
double |
single()
Return a single item from this list.
|
PointCoordinates |
slice(int start)
See slice(int, int).
|
PointCoordinates |
slice(int start,
int end)
Return a slice of this list from index
start (inclusive) to index end (exclusive). |
java.util.List<java.lang.Double> |
toGeneric() |
static PointCoordinates |
withLatitudeLongitude(double latitude,
double longitude)
Return 2D point coordinates.
|
static PointCoordinates |
withXY(double x,
double y)
Return 2D point coordinates.
|
static PointCoordinates |
withXYM(double x,
double y,
double m)
Return 2D point coordinates with measure.
|
static PointCoordinates |
withXYZ(double x,
double y,
double z)
Return 3D point coordinates.
|
static PointCoordinates |
withXYZM(double x,
double y,
double z,
double m)
Return 3D point coordinates with measure.
|
clear, getComparer, getDataType, getEquality, getUntypedList, isEmpty, length, removeAt, removeFirst, removeLast, removeRange, reverse, shareWith, sort, sortWith, toDynamic, toString, validatecloneMutable, equals, getTypeCode, hashCodepublic static final PointCoordinates empty
public PointCoordinates()
public PointCoordinates(int capacity)
Construct a new list with PointCoordinates.length of zero and optional initial capacity.
A list can expand in length beyond its initial capacity, but best performance
will be obtained if the initial capacity is close to the list's maximum length.
capacity - Optional initial capacity.public void add(double item)
Add item to the end of this list.
item - Item to be added.public void addAll(PointCoordinates list)
Add all the items of list to the end of this list.
list - Items to be added.public PointCoordinates addThis(double item)
Add item to the end of this list.
item - Item to be added.public PointCoordinates copy()
Return a shallow copy of this list.
public double first()
Return the first item in this list.
EmptyListException if the list is empty.
public static PointCoordinates from(java.util.List<java.lang.Double> list)
public double get(int index)
Return the item in this list at the specified index.
ListIndexException if index is out of range (0 to PointCoordinates.length - 1).
index - Zero-based index.public double getAltitude()
Return synonym for PointCoordinates.z.
PointCoordinates.z.public double getLatitude()
Return synonym for PointCoordinates.y.
PointCoordinates.y.public double getLongitude()
Return synonym for PointCoordinates.x.
PointCoordinates.x.public double getM()
Return the M dimension (e.g. measure). Equivalent to this.last().
Use PointCoordinates.withXYM or PointCoordinates.withXYZM to obtain point coordinates with an M dimension.
M dimension (e.g. measure). Equivalent to this.last().public double getMeasure()
Return synonym for PointCoordinates.m.
PointCoordinates.m.public double getX()
Return the X dimension (e.g. longitude). Equivalent to this.get(0).
X dimension (e.g. longitude). Equivalent to this.get(0).public double getY()
Return the Y dimension (e.g. latitude). Equivalent to this.get(1).
Y dimension (e.g. latitude). Equivalent to this.get(1).public double getZ()
Return the Z dimension (e.g. altitude). Equivalent to this.get(2).
Z dimension (e.g. altitude). Equivalent to this.get(2).public boolean includes(double item)
Return true if this list contains item.
item - Item for comparison. Comparison uses the PointCoordinates.equality property, which would usually be expected to match the == operator for item type double.true if this list contains item.public int indexOf(double item)
item - Item parameter.public int indexOf(double item,
int start)
Return first index in this list of item, or -1 if not found.
item - Item for comparison. Comparison uses the PointCoordinates.equality property, which would usually be expected to match the == operator for item type double.start - Zero-based starting index (search moves forwards from this index).item, or -1 if not found.public void insertAll(int index,
PointCoordinates list)
Insert all items of list into this list, before the item (if any) at index.
ListIndexException if index is out of range (0 to PointCoordinates.length).
index - Zero-based index.list - List of items to be inserted.public void insertAt(int index,
double item)
Insert item into this list, before the item (if any) at index.
ListIndexException if index is out of range (0 to PointCoordinates.length).
index - Zero-based index.item - Item to be added.public java.util.Iterator<java.lang.Double> iterator()
iterator in interface java.lang.Iterable<java.lang.Double>public double last()
Return the last item in this list.
EmptyListException if the list is empty.
public int lastIndexOf(double item)
item - Item parameter.public int lastIndexOf(double item,
int start)
Return last index in this list of item, or -1 if not found.
item - Item for comparison. Comparison uses the PointCoordinates.equality property, which would usually be expected to match the == operator for item type double.start - Zero-based starting index (search moves backwards from this index).item, or -1 if not found.public void set(int index,
double item)
Set the item in this list at the specified index.
index - Zero-based index.item - Item value.public void setAltitude(double value)
Set synonym for PointCoordinates.z.
value - Synonym for PointCoordinates.z.public void setLatitude(double value)
Set synonym for PointCoordinates.y.
value - Synonym for PointCoordinates.y.public void setLongitude(double value)
Set synonym for PointCoordinates.x.
value - Synonym for PointCoordinates.x.public void setX(double value)
Set the X dimension (e.g. longitude). Equivalent to this.get(0).
value - The X dimension (e.g. longitude). Equivalent to this.get(0).public void setY(double value)
Set the Y dimension (e.g. latitude). Equivalent to this.get(1).
value - The Y dimension (e.g. latitude). Equivalent to this.get(1).public void setZ(double value)
Set the Z dimension (e.g. altitude). Equivalent to this.get(2).
value - The Z dimension (e.g. altitude). Equivalent to this.get(2).public static PointCoordinates share(ListBase list)
Return a new PointCoordinates that shares the ListBase.untypedList as the list parameter.
To ensure type safety, items in list that do not have the item type double will be removed.
list - List whose items will be shared by the resulting list.double, sharing the same items as list.public double single()
Return a single item from this list.
EmptyListException if the list has no items, NotUniqueException if the list has multiple items.
public PointCoordinates slice(int start)
start - Start parameter.public PointCoordinates slice(int start, int end)
Return a slice of this list from index start (inclusive) to index end (exclusive).
start - Zero-based starting index (inclusive), or negative for starting index relative to the end of this list.end - Zero-based ending index (exclusive), or negative for ending index relative to the end of this list.start (inclusive) to index end (exclusive).public java.util.List<java.lang.Double> toGeneric()
public static PointCoordinates withLatitudeLongitude(double latitude, double longitude)
Return 2D point coordinates.
latitude - Latitude (Y-coordinate).longitude - Longitude (X-coordinate).public static PointCoordinates withXY(double x, double y)
Return 2D point coordinates.
x - X-coordinate (longitude for geography points).y - Y-coordinate (latitude for geography points).public static PointCoordinates withXYM(double x, double y, double m)
Return 2D point coordinates with measure.
x - X-coordinate (longitude for geography points).y - Y-coordinate (latitude for geography points).m - M-coordinate (measure).public static PointCoordinates withXYZ(double x, double y, double z)
Return 3D point coordinates.
x - X-coordinate (longitude for geography points).y - Y-coordinate (latitude for geography points).z - Z-coordinate (altitude for geography points).public static PointCoordinates withXYZM(double x, double y, double z, double m)
Return 3D point coordinates with measure.
x - X-coordinate (longitude for geography points).y - Y-coordinate (latitude for geography points).z - Z-coordinate (altitude for geography points).m - M-coordinate (measure).