org.gvsig.raster.lib.buffer.api

Interface ROI

All Superinterfaces:

Observable

All Known Subinterfaces:

VectorROI

All Known Implementing Classes:

AbstractROI, DefaultVectorROI

public interface ROI
extends Observable

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ROI_CHANGED

Method Summary

Modifier and Type	Method and Description
Envelope	getEnvelope() Gets the bounding box of this ROI
long	getID()
java.lang.String	getName()
boolean	isInside(Geometry geometry) Checks if the geometry is inside of this region of interest
boolean	isInside(int cellX, int cellY) Checks if a point in pixel coordinates is inside of this region of interest
void	setID(long id)
void	setName(java.lang.String name)

Methods inherited from interface org.gvsig.tools.observer.Observable

addObserver, deleteObserver, deleteObservers

Field Detail

ROI_CHANGED

static final java.lang.String ROI_CHANGED

See Also:

Constant Field Values

Method Detail

isInside

boolean isInside(int cellX,
                 int cellY)
          throws CreateGeometryException,
                 GeometryOperationNotSupportedException,
                 GeometryOperationException

Checks if a point in pixel coordinates is inside of this region of interest

Parameters:

cellX - X cell of raster

cellY - Y cell of raster

Returns:

true whether the point is inside

Throws:

CreateGeometryException

GeometryOperationException

GeometryOperationNotSupportedException

isInside

boolean isInside(Geometry geometry)
          throws GeometryOperationNotSupportedException,
                 GeometryOperationException

Checks if the geometry is inside of this region of interest

Parameters:

geometry - Geometry to check if it is inside roi

Returns:

true whether the point is inside

Throws:

GeometryOperationException

GeometryOperationNotSupportedException

getEnvelope

Envelope getEnvelope()
              throws GettingEnvelopeException

Gets the bounding box of this ROI

Returns:

the envelope

Throws:

GettingEnvelopeException

java.lang.CloneNotSupportedException

getName

java.lang.String getName()

Returns:

the name

setName

void setName(java.lang.String name)

Parameters:

name -

getID

long getID()

Returns:

the identifier

setID

void setID(long id)

Parameters:

id -