Package org.apache.sis.geometry

Class SubEnvelope

java.lang.Object

org.apache.sis.io.wkt.FormattableObject

org.apache.sis.geometry.AbstractEnvelope

org.apache.sis.geometry.ArrayEnvelope

org.apache.sis.geometry.GeneralEnvelope

org.apache.sis.geometry.SubEnvelope

All Implemented Interfaces:

Serializable, Cloneable, Emptiable, org.opengis.geometry.Envelope

final class SubEnvelope
extends GeneralEnvelope

A view over a sub-set of the dimensions of a GeneralEnvelope. This class doesn't keep any reference to the original envelope; only the internal array is shared.

Since:

0.3

Version:

0.3

Field Summary

Fields

Modifier and Type	Field	Description
private final int	beginIndex	The index of the first valid coordinate value of the lower corner in the ArrayEnvelope.coordinates array.
private final int	endIndex	The index after the last valid coordinate value of the lower corner in the ArrayEnvelope.coordinates array.
private static final long	serialVersionUID	For cross-version compatibility.

Fields inherited from class org.apache.sis.geometry.ArrayEnvelope

coordinates, crs

Constructor Summary

Constructors

Constructor	Description
SubEnvelope(double[] coordinates, int beginIndex, int endIndex)	Creates a new envelope over a portion of the given array.

Method Summary

Modifier and Type	Method	Description
(package private) final int	beginIndex()	Returns the index of the first valid coordinate value of the lower corner in the coordinates array.
GeneralEnvelope	clone()	If the user wants a clone, copy only the relevant part of the coordinates array.
(package private) final int	endIndex()	Returns the index after the last valid coordinate value of the lower corner in the coordinates array.
boolean	equals(Object object)	Must be overridden, since the super-class method processes the full array as a whole.
int	getDimension()	Returns the number of dimensions in the portion of the array used by this SubEnvelope.
double	getLower(int dimension)	Must be overridden, since the super-class method does not handle the index range for performance reasons.
double	getUpper(int dimension)	Must be overridden, since the super-class method does not handle the index range for performance reasons.
int	hashCode()	Must be overridden, since the super-class method processes the full array as a whole.
boolean	isAllNaN()	Must be overridden, since the super-class method processes the full array as a whole.
void	setEnvelope(double... corners)	Must be overridden, since the super-class method processes the full array as a whole.
void	setRange(int dimension, double lower, double upper)	Must be overridden, since the super-class method processes the full array as a whole.
void	setToNaN()	Must be overridden, since the super-class method processes the full array as a whole.
GeneralEnvelope	subEnvelope(int b, int e)	Must be overridden, since the super-class method does not handle the index range for performance reasons.

Methods inherited from class org.apache.sis.geometry.GeneralEnvelope

add, add, addSimple, castOrCopy, horizontal, intersect, normalize, normalize, setCoordinateReferenceSystem, setEnvelope, setTimeRange, setToInfinite, simplify, translate, verifyArrayLength, wraparound

Methods inherited from class org.apache.sis.geometry.ArrayEnvelope

ensureSameDimension, equalsByAPI, getCoordinateReferenceSystem, getMaximum, getMedian, getMinimum, getSpan, hashCodeByAPI, illegalRange, isEmpty, toString, verifyRanges

Methods inherited from class org.apache.sis.geometry.AbstractEnvelope

assertEquals, contains, contains, contains, equals, fixMedian, fixSpan, formatTo, getAxis, getCommonCRS, getCycle, getLowerCorner, getMedian, getSpan, getTimeRange, getUpperCorner, hasNaN, hasNaN, intersects, intersects, isNegativeUnsafe, isWrapAround, isWrapAround, toSimpleEnvelopes, toString

Methods inherited from class org.apache.sis.io.wkt.FormattableObject

print, toString, toWKT

Methods inherited from class java.lang.Object

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

Field Details

serialVersionUID

private static final long serialVersionUID

For cross-version compatibility.

See Also:

• Constant Field Values

beginIndex

private final int beginIndex

The index of the first valid coordinate value of the lower corner in the ArrayEnvelope.coordinates array.

See Also:

• ArrayEnvelope.beginIndex()

endIndex

private final int endIndex

The index after the last valid coordinate value of the lower corner in the ArrayEnvelope.coordinates array.

See Also:

• ArrayEnvelope.endIndex()

Constructor Details

SubEnvelope

SubEnvelope(double[] coordinates,
 int beginIndex,
 int endIndex)

Creates a new envelope over a portion of the given array. This constructor stores the given reference directly; it does not clone the given array. This is the desired behavior for allowing the SubEnvelope view to be "live".

Parameters:

coordinates - the array of coordinate values to store directly (not cloned).

beginIndex - the index of the first valid coordinate value of the lower corner in the coordinates array.

endIndex - the index after the last valid coordinate value of the lower corner in the coordinates array.

Method Details

beginIndex

final int beginIndex()

Returns the index of the first valid coordinate value of the lower corner in the coordinates array. This information is used by super-class methods.

Overrides:

beginIndex in class ArrayEnvelope

endIndex

final int endIndex()

Returns the index after the last valid coordinate value of the lower corner in the coordinates array. This information is used by super-class methods.

Overrides:

endIndex in class ArrayEnvelope

getDimension

public int getDimension()

Returns the number of dimensions in the portion of the array used by this SubEnvelope.

Specified by:

getDimension in interface org.opengis.geometry.Envelope

Overrides:

getDimension in class ArrayEnvelope

Returns:

the dimensionality of this envelope.

getLower

public double getLower(int dimension)
                throws IndexOutOfBoundsException

Must be overridden, since the super-class method does not handle the index range for performance reasons.

Overrides:

getLower in class ArrayEnvelope

Parameters:

dimension - the dimension for which to obtain the coordinate value.

Returns:

the starting coordinate value at the given dimension.

Throws:

IndexOutOfBoundsException - if the given index is negative or is equal or greater than the envelope dimension.

See Also:

• AbstractEnvelope.getLowerCorner()
• AbstractEnvelope.getMinimum(int)

getUpper

public double getUpper(int dimension)
                throws IndexOutOfBoundsException

Must be overridden, since the super-class method does not handle the index range for performance reasons.

Overrides:

getUpper in class ArrayEnvelope

Parameters:

dimension - the dimension for which to obtain the coordinate value.

Returns:

the starting coordinate value at the given dimension.

Throws:

IndexOutOfBoundsException - if the given index is negative or is equal or greater than the envelope dimension.

See Also:

• AbstractEnvelope.getUpperCorner()
• AbstractEnvelope.getMaximum(int)

setRange

public void setRange(int dimension,
 double lower,
 double upper)
              throws IndexOutOfBoundsException

Must be overridden, since the super-class method processes the full array as a whole.

Overrides:

setRange in class GeneralEnvelope

Parameters:

dimension - the dimension to set.

lower - the limit in the direction of decreasing coordinate values.

upper - the limit in the direction of increasing coordinate values.

Throws:

IndexOutOfBoundsException - if the given index is out of bounds.

setEnvelope

public void setEnvelope(double... corners)

Must be overridden, since the super-class method processes the full array as a whole.

Overrides:

setEnvelope in class GeneralEnvelope

Parameters:

corners - coordinates of the new lower corner followed by the new upper corner.

isAllNaN

public boolean isAllNaN()

Must be overridden, since the super-class method processes the full array as a whole.

Overrides:

isAllNaN in class ArrayEnvelope

Returns:

true if this envelope has NaN values.

See Also:

• GeneralEnvelope.setToNaN()
• DefaultGeographicBoundingBox.isEmpty()

setToNaN

public void setToNaN()

Must be overridden, since the super-class method processes the full array as a whole.

Overrides:

setToNaN in class GeneralEnvelope

See Also:

• ArrayEnvelope.isAllNaN()

hashCode

public int hashCode()

Must be overridden, since the super-class method processes the full array as a whole.

Overrides:

hashCode in class ArrayEnvelope

equals

public boolean equals(Object object)

Must be overridden, since the super-class method processes the full array as a whole.

Overrides:

equals in class ArrayEnvelope

Parameters:

object - the object to compare with this envelope.

Returns:

true if the given object is equal to this envelope.

subEnvelope

public GeneralEnvelope subEnvelope(int b,
 int e)
                            throws IndexOutOfBoundsException

Must be overridden, since the super-class method does not handle the index range for performance reasons.

Overrides:

subEnvelope in class GeneralEnvelope

Parameters:

b - the index of the first valid coordinate value of the corners.

e - the index after the last valid coordinate value of the corners.

Returns:

the sub-envelope of dimension endIndex - beginIndex.

Throws:

IndexOutOfBoundsException - if an index is out of bounds.

See Also:

• GeneralEnvelope.horizontal()
• CRS.getComponentAt(CoordinateReferenceSystem, int, int)

clone

public GeneralEnvelope clone()

If the user wants a clone, copy only the relevant part of the coordinates array.

Overrides:

clone in class GeneralEnvelope

Returns:

a clone of this envelope.