org.kepler.gis.data

Class BoundingBoxToken

java.lang.Object

ptolemy.data.Token

org.kepler.gis.data.BoundingBoxToken

public class BoundingBoxToken
extends Token

Token containing a GIS bounding box.

Author:

Daniel Crawl

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BoundingBoxToken.BoundingBoxType The Type for the BoundingBoxToken.

Field Summary

Fields

Modifier and Type	Field and Description
static BoundingBoxToken.BoundingBoxType	BOUNDING_BOX The bounding box type.

Fields inherited from class ptolemy.data.Token

NIL

Constructor Summary

Constructors

Constructor and Description
BoundingBoxToken(org.geotools.geometry.jts.ReferencedEnvelope envelope) Create a new BoundingBoxToken with an evelope.
BoundingBoxToken(java.lang.String value) Create a new BoundingBoxToken from a string value.

Method Summary

Modifier and Type	Method and Description
static BoundingBoxToken	bbox(java.lang.String value) Create a BoundingBoxToken from a string value.
org.geotools.geometry.jts.ReferencedEnvelope	boundingBoxValue() Get the bounding box.
Type	getType() Get the token type.
BooleanToken	isCloseTo(Token other, double epsilon) Test that the value of this Token is close to the first argument, where "close" means that the distance between them is less than or equal to the second argument.
BooleanToken	isEqualTo(Token rightArgument) Test for equality of the values of this Token and the argument Token.
double	maxX() Get the maximum x coordinate.
double	maxY() Get the maximum x coordinate.
double	minX() Get the minimum x coordinate.
double	minY() Get the minimum y coordinate.
java.lang.String	toString() Return a string representation of the bounding box.

Methods inherited from class ptolemy.data.Token

add, addReverse, divide, divideReverse, isCloseTo, isNil, modulo, moduloReverse, multiply, multiplyReverse, notSupportedConversionMessage, notSupportedIncomparableConversionMessage, notSupportedIncomparableMessage, notSupportedMessage, notSupportedNullNilStringMessage, one, pow, subtract, subtractReverse, zero, zeroReturnType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

BOUNDING_BOX

public static final BoundingBoxToken.BoundingBoxType BOUNDING_BOX

The bounding box type.

Constructor Detail

BoundingBoxToken

public BoundingBoxToken(java.lang.String value)
                 throws IllegalActionException

Create a new BoundingBoxToken from a string value. The value is the format produced by toString().

Throws:

IllegalActionException

BoundingBoxToken

public BoundingBoxToken(org.geotools.geometry.jts.ReferencedEnvelope envelope)

Create a new BoundingBoxToken with an evelope.

Method Detail

bbox

public static BoundingBoxToken bbox(java.lang.String value)
                             throws IllegalActionException

Create a BoundingBoxToken from a string value.

Throws:

IllegalActionException

boundingBoxValue

public org.geotools.geometry.jts.ReferencedEnvelope boundingBoxValue()

Get the bounding box.

getType

public Type getType()

Get the token type.

Overrides:

getType in class Token

Returns:

BaseType.GENERAL

isCloseTo

public BooleanToken isCloseTo(Token other,
                              double epsilon)
                       throws IllegalActionException

Test that the value of this Token is close to the first argument, where "close" means that the distance between them is less than or equal to the second argument.

Overrides:

isCloseTo in class Token

Parameters:

other - The token to test closeness of this token with.

epsilon - The value that we use to determine whether two tokens are close.

Returns:

A boolean token that contains the value true if the value of this token are close to those of the argument token. If either this token or the argument token is a nil token, then a boolean token that contains the value false is returned.

Throws:

IllegalActionException - If the argument token is not of a type that can be compared with this token.

isEqualTo

public final BooleanToken isEqualTo(Token rightArgument)
                             throws IllegalActionException

Test for equality of the values of this Token and the argument Token. If the value of this token or the value of the rightArgument token is null, then we return False.

Overrides:

isEqualTo in class Token

Parameters:

rightArgument - The Token to test against.

Returns:

A boolean token that contains the value true if the dates are the same.

Throws:

IllegalActionException - Not thrown in this base class.

maxX

public double maxX()

Get the maximum x coordinate.

maxY

public double maxY()

Get the maximum x coordinate.

minX

public double minX()

Get the minimum x coordinate.

minY

public double minY()

Get the minimum y coordinate.

toString

public java.lang.String toString()

Return a string representation of the bounding box.

Overrides:

toString in class Token

Returns:

The String "present", unless this token is Token.NIL, in which case return the String "nil".