org.geotoolkit.coverage.grid
Class GeneralGridCoordinates

Object
  GeneralGridCoordinates

All Implemented Interfaces:

Serializable, Cloneable, GridCoordinates

Direct Known Subclasses:

GeneralGridCoordinates.Immutable

public class GeneralGridCoordinates
extends Object
implements GridCoordinates, Cloneable, Serializable

Holds the set of grid coordinates that specifies the location of the grid point within the grid.

Since:

2.4

Version:

3.00

Author:

Martin Desruisseaux (IRD)

See Also:

GridCoordinates2D, Serialized Form

Module:

coverage/geotk-coverage (download)

View source code for this class

Nested Class Summary

static class

GeneralGridCoordinates.Immutable An immutable GridCoordinates.

Constructor Summary

GeneralGridCoordinates(GridCoordinates coordinates)
Creates a grid coordinates which is a copy of the specified one.

GeneralGridCoordinates(int dimension)
Creates a grid coordinates of the specified dimension.

GeneralGridCoordinates(int[] coordinates)
Creates a grid coordinates initialized to the specified values.

GeneralGridCoordinates(int[] coordinates, int lower, int upper)
Creates a grid coordinates initialized to the specified values in the specified range.

Method Summary

GeneralGridCoordinates	clone() Returns a clone of this grid coordinates.
boolean	equals(Object object) Compares this grid coordinates with the specified object for equality.
int	getCoordinateValue(int dimension) Returns the coordinate value at the specified dimension.
int[]	getCoordinateValues() Returns one integer value for each dimension of the grid.
int	getDimension() Returns the number of dimensions.
int	hashCode() Returns a hash code value for this object.
void	setCoordinateValue(int dimension, int value) Sets the coordinate value at the specified dimension (optional operation).
String	toString() Returns a string representation of this grid coordinates.

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GeneralGridCoordinates

public GeneralGridCoordinates(int dimension)

Creates a grid coordinates of the specified dimension. All coordinates are initially set to 0.

Parameters:

dimension - The number of dimension.

GeneralGridCoordinates

public GeneralGridCoordinates(int[] coordinates)

Creates a grid coordinates initialized to the specified values.

Parameters:

coordinates - The grid coordinates to copy.

GeneralGridCoordinates

public GeneralGridCoordinates(int[] coordinates,
                              int lower,
                              int upper)

Creates a grid coordinates initialized to the specified values in the specified range.

Parameters:

coordinates - The coordinates to copy.

lower - Index of the first value to copy, inclusive.

upper - Index of the last value to copy, exclusive.

Since:

2.5

GeneralGridCoordinates

public GeneralGridCoordinates(GridCoordinates coordinates)

Creates a grid coordinates which is a copy of the specified one.

Parameters:

coordinates - The grid coordinates to copy.

Since:

2.5

Method Detail

getDimension

public int getDimension()

Returns the number of dimensions. This method is equivalent to getCoordinateValues().length. It is provided for efficiency.

Specified by:

getDimension in interface GridCoordinates

getCoordinateValues

public int[] getCoordinateValues()

Returns one integer value for each dimension of the grid. The ordering of these coordinate values shall be the same as that of the elements of Grid.getAxisNames(). The value of a single coordinate shall be the number of offsets from the origin of the grid in the direction of a specific axis.

Specified by:

getCoordinateValues in interface GridCoordinates

Returns:

A copy of the coordinates. Changes in the returned array will not be reflected back in this GeneralGridCoordinates object.

getCoordinateValue

public int getCoordinateValue(int dimension)
                       throws ArrayIndexOutOfBoundsException

Returns the coordinate value at the specified dimension. This method is equivalent to getCoordinateValues()[i]. It is provided for efficiency.

Specified by:

getCoordinateValue in interface GridCoordinates

Parameters:

dimension - The dimension from 0 inclusive to getDimension() exclusive.

Returns:

The value at the requested dimension.

Throws:

ArrayIndexOutOfBoundsException - if the specified dimension is out of bounds.

setCoordinateValue

public void setCoordinateValue(int dimension,
                               int value)
                        throws ArrayIndexOutOfBoundsException,
                               UnsupportedOperationException

Sets the coordinate value at the specified dimension (optional operation).

Specified by:

setCoordinateValue in interface GridCoordinates

Parameters:

dimension - The index of the value to set.

value - The new value.

Throws:

ArrayIndexOutOfBoundsException - if the specified dimension is out of bounds.

UnsupportedOperationException - if this grid coordinates is not modifiable.

toString

public String toString()

Returns a string representation of this grid coordinates.

Overrides:

toString in class Object

hashCode

public int hashCode()

Returns a hash code value for this object.

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Compares this grid coordinates with the specified object for equality.

Overrides:

equals in class Object

Parameters:

object - The object to compares with this grid coordinates.

Returns:

true if the given object is equal to this grid coordinates.

clone

public GeneralGridCoordinates clone()

Returns a clone of this grid coordinates.

Overrides:

clone in class Object

Returns:

A clone of this grid coordinates.

See Also:

Object.clone()