org.gvsig.fmap.geom.jts.primitive

Class DefaultEnvelope

java.lang.Object

org.gvsig.fmap.geom.jts.primitive.DefaultEnvelope

All Implemented Interfaces:

java.lang.Cloneable, Envelope, Persistent

Direct Known Subclasses:

Envelope2D, Envelope3D

public abstract class DefaultEnvelope
extends java.lang.Object
implements Envelope, Cloneable

A minimum bounding box or rectangle. Regardless of dimension, an Envelope can be represented without ambiguity as two direct positions (coordinate points). To encode an Envelope, it is sufficient to encode these two points. This is consistent with all of the data types in this specification, their state is represented by their publicly accessible attributes.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isEmpty
protected static java.lang.String	LOWERCORNER_FIELD
protected static GeometryManager	manager
protected Point	max
protected Point	min
static java.lang.String	PERSISTENCE_DEFINITION_NAME
protected IProjection	projection
protected static java.lang.String	UPPERCORNER_FIELD

Constructor Summary

Constructors

Constructor and Description
DefaultEnvelope()
DefaultEnvelope(IProjection projection)
DefaultEnvelope(Point min, Point max, IProjection projection)

Method Summary

Modifier and Type	Method and Description
void	add(Geometry geometry) Utility method to add the envelop of geometry to the current envelope.
void	centerTo(Point p) Centers the envelope to a given point
void	clear()
java.lang.Object	clone() Creates a copy of the object.
boolean	contains(Envelope envelope) Returns true if the new envelope is contained in the current envelope.
boolean	equals(java.lang.Object other)
Geometry	getBox2D()
double	getCenter(int dimension) Returns the center ordinate along the specified dimension.
Geometry	getGeometry() It returns the equivalent of an envelope like a geometry.
double	getLength(int dimension) Returns the envelope length along the specified dimension.
Point	getLowerCorner() A coordinate position consisting of all the minimal ordinates for each dimension for all points within the Envelope.
double	getMaximum(int dimension) Returns the maximal ordinate along the specified dimension.
double	getMinimum(int dimension) Returns the minimal ordinate along the specified dimension.
IProjection	getProjection()
Point	getUpperCorner() A coordinate position consisting of all the maximal ordinates for each dimension for all points within the Envelope.
boolean	hasM()
boolean	hasZ()
boolean	intersects(Envelope envelope) Returns true if the new envelope intersects with the current envelope.
boolean	intersects(Geometry geometry) Returns true if the geometry intersects with the current envelope.
boolean	isCollapsed()
boolean	isCollapsed(int subtype)
boolean	isEmpty() Gets if the envelope is null or not.
void	loadFromState(PersistentState state) Set the state of the object from the state passed as parameter.
static void	registerPersistent()
void	saveToState(PersistentState state) Saves the internal state of the object on the provided PersistentState object.
void	setLowerCorner(Point lowerCorner) Sets the coordinate position consisting of all the minimal ordinates for each dimension for all points within the Envelope.
void	setProjection(IProjection projection)
void	setProjectionIffNull(IProjection projection)
void	setUpperCorner(Point upperCorner) Sets the coordinate position consisting of all the maximal ordinates for each dimension for all points within the Envelope.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gvsig.fmap.geom.primitive.Envelope

add, convert, getDimension

Methods inherited from interface org.gvsig.tools.lang.Cloneable

cloneQuietly, cloneQuietly

Field Detail

PERSISTENCE_DEFINITION_NAME

public static final java.lang.String PERSISTENCE_DEFINITION_NAME

See Also:

Constant Field Values

LOWERCORNER_FIELD

protected static final java.lang.String LOWERCORNER_FIELD

See Also:

Constant Field Values

UPPERCORNER_FIELD

protected static final java.lang.String UPPERCORNER_FIELD

See Also:

Constant Field Values

min

protected Point min

max

protected Point max

isEmpty

protected boolean isEmpty

projection

protected IProjection projection

manager

protected static GeometryManager manager

Constructor Detail

DefaultEnvelope

public DefaultEnvelope()

DefaultEnvelope

public DefaultEnvelope(IProjection projection)

DefaultEnvelope

public DefaultEnvelope(Point min,
                       Point max,
                       IProjection projection)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getCenter

public double getCenter(int dimension)

Returns the center ordinate along the specified dimension.

Specified by:

getCenter in interface Envelope

Parameters:

dimension - DOCUMENT ME!

Returns:

DOCUMENT ME!

getLength

public double getLength(int dimension)

Returns the envelope length along the specified dimension.

Specified by:

getLength in interface Envelope

Parameters:

dimension -

Returns:

getLowerCorner

public Point getLowerCorner()

A coordinate position consisting of all the minimal ordinates for each dimension for all points within the Envelope.

Specified by:

getLowerCorner in interface Envelope

Returns:

getMaximum

public double getMaximum(int dimension)

Returns the maximal ordinate along the specified dimension.

Specified by:

getMaximum in interface Envelope

Parameters:

dimension -

Returns:

getMinimum

public double getMinimum(int dimension)

Returns the minimal ordinate along the specified dimension.

Specified by:

getMinimum in interface Envelope

Parameters:

dimension -

Returns:

getUpperCorner

public Point getUpperCorner()

A coordinate position consisting of all the maximal ordinates for each dimension for all points within the Envelope.

Specified by:

getUpperCorner in interface Envelope

Returns:

getGeometry

public Geometry getGeometry()

Description copied from interface: Envelope

It returns the equivalent of an envelope like a geometry.

Specified by:

getGeometry in interface Envelope

Returns:

A geometry that contains the same area that the envelope.

getBox2D

public Geometry getBox2D()

Specified by:

getBox2D in interface Envelope

contains

public boolean contains(Envelope envelope)

Description copied from interface: Envelope

Returns true if the new envelope is contained in the current envelope.

Specified by:

contains in interface Envelope

Parameters:

envelope - The envelope to compare.

Returns:

If the current envelope contains the new envelope

intersects

public boolean intersects(Envelope envelope)

Description copied from interface: Envelope

Returns true if the new envelope intersects with the current envelope.

Specified by:

intersects in interface Envelope

Parameters:

envelope - The envelope to compare.

Returns:

If the current envelope intersects with the new envelope

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

setLowerCorner

public void setLowerCorner(Point lowerCorner)

Description copied from interface: Envelope

Sets the coordinate position consisting of all the minimal ordinates for each dimension for all points within the Envelope.

Specified by:

setLowerCorner in interface Envelope

Parameters:

lowerCorner - The lower corner.

setUpperCorner

public void setUpperCorner(Point upperCorner)

Description copied from interface: Envelope

Sets the coordinate position consisting of all the maximal ordinates for each dimension for all points within the Envelope.

Specified by:

setUpperCorner in interface Envelope

Parameters:

upperCorner - The upper corner.

registerPersistent

public static void registerPersistent()

loadFromState

public void loadFromState(PersistentState state)
                   throws PersistenceException

Description copied from interface: Persistent

Set the state of the object from the state passed as parameter.

Specified by:

loadFromState in interface Persistent

Throws:

PersistenceException

saveToState

public void saveToState(PersistentState state)
                 throws PersistenceException

Description copied from interface: Persistent

Saves the internal state of the object on the provided PersistentState object.

Specified by:

saveToState in interface Persistent

Throws:

PersistenceException

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Description copied from interface: Cloneable

Creates a copy of the object.

Overrides:

clone in class java.lang.Object

Returns:

a copy of the object

Throws:

java.lang.CloneNotSupportedException - if the instance of the object cannot be cloned. As this is extending Cloneable so its sure it implements it, so this exception may be used for problems on specific object instances.

See Also:

Object#clone()}.

isEmpty

public boolean isEmpty()

Description copied from interface: Envelope

Gets if the envelope is null or not. Is Empty means that the lower and upper corner are null.

Specified by:

isEmpty in interface Envelope

Returns:

null or not if is empty.

add

public void add(Geometry geometry)

Description copied from interface: Envelope

Utility method to add the envelop of geometry to the current envelope. Is equivalent to: add(geometry.getEnvelope())

Specified by:

add in interface Envelope

Parameters:

geometry - The geometry to add.

clear

public void clear()

Specified by:

clear in interface Envelope

intersects

public boolean intersects(Geometry geometry)

Description copied from interface: Envelope

Returns true if the geometry intersects with the current envelope.

Specified by:

intersects in interface Envelope

Parameters:

geometry - The geometry to compare.

Returns:

If the current envelope intersects with the geometry

centerTo

public void centerTo(Point p)

Description copied from interface: Envelope

Centers the envelope to a given point

Specified by:

centerTo in interface Envelope

Parameters:

p - Point to be centered

getProjection

public IProjection getProjection()

Specified by:

getProjection in interface Envelope

setProjectionIffNull

public void setProjectionIffNull(IProjection projection)

Specified by:

setProjectionIffNull in interface Envelope

setProjection

public void setProjection(IProjection projection)

Specified by:

setProjection in interface Envelope

isCollapsed

public boolean isCollapsed()

Specified by:

isCollapsed in interface Envelope

isCollapsed

public boolean isCollapsed(int subtype)

Specified by:

isCollapsed in interface Envelope

hasZ

public boolean hasZ()

Specified by:

hasZ in interface Envelope

hasM

public boolean hasM()

Specified by:

hasM in interface Envelope