All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.las.ogdi.OGDIRegion 

java.lang.Object
   |
   +----com.las.ogdi.OGDIRegion
public class OGDIRegion
extends Object
The Region class defines a delimiting zone of interest and resolution. Geographic objects are always located within the currently selected region. The northing and easting parameters are substituted with the coordinates in the format defined by the type of projection. If using latlong as the projection, the coordinates are specified in the same manner. If using UTM, then utm values are required. The res parameter is used for matrix/image coverage's. This defines the resolution of the matrix/image being returned from the server to the client. The coordinates are entered in the following order: 
OGDIRegion(West_limit, North_limit, East_limit, South_limit, EW_resolution, 
 NS_resolution).
The correspondance with the parameters are: 
OGDIRegion(x1, y1, x2, y2, xRes, yRes).
Here's an example with latitude/longitude coordinates (in decimal degrees):
 OGDIRegion region = new OGDIRegion(-86.802, 37.6021, -73.0964, 24.8276, 0.006853, 
 0.006853);
Here's an example with UTM coordinates (in metres):
 OGDIRegion region = new OGDIRegion(576235, 5033880, 606509, 5017050, 4.99983, 
 4.99983);

Version:
1.0
Author:
Las Inc.

Constructor Index

o OGDIRegion(double, double, double, double, double, double)
Creates a Region instance defined by a left reference, an upper reference, a right reference, a lower reference and two resolution (x and y), all expressed in current geographic units.

Method Index

o getX1()
Gets the most-at-left x geographic reference in the current unit.
o getX2()
Gets the most-at-right x geographic reference in the current unit.
o getXRes()
Gets the x-plane geographic resolution in the current unit.
o getY1()
Gets the upper y geographic reference in the current unit.
o getY2()
Gets the lower y geographic reference in the current unit.
o getYRes()
Gets the y-plane geographic resolution in the current unit.
o setX1(double)
Sets the most-at-left x geographic reference in the current unit.
o setX2(double)
Sets the most-at-right x geographic reference in the current unit.
o setXRes(double)
Sets the x-plane geographic resolution in the current unit.
o setY1(double)
Sets the upper y geographic reference in the current unit.
o setY2(double)
Sets the lower y geographic reference in the current unit.
o setYRes(double)
Sets the y-plane geographic resolution in the current unit.
o toString()
Gets the complete region description.

Constructors

o OGDIRegion 
 public OGDIRegion(double x1,
                   double y1,
                   double x2,
                   double y2,
                   double xRes,
                   double yRes)
Creates a Region instance defined by a left reference, an upper reference, a right reference, a lower reference and two resolution (x and y), all expressed in current geographic units.

Parameters:
x1 - the left reference of the region in the current units
y1 - the upper reference of the region in the current units
x2 - the right reference of the region in the current units
y2 - the lower reference of the region in the current units
xRes - the x-plane resolution in the current units
yRes - the y-plane resolution in the current units
Returns:
no return
Throws: IllegalArgumentException
if x1 not less than x2, y2 not less than y1 or negative resolution

Methods

o getY1 
 public double getY1()
Gets the upper y geographic reference in the current unit.

Parameters:
no - parameter
Returns:
a real number
Throws: no
exception
o setY1 
 public void setY1(double y1)
Sets the upper y geographic reference in the current unit.

Parameters:
y1 - a real number
Returns:
no return
Throws: IllegalArgumentException
if y1 is not greater than lower reference
o getY2 
 public double getY2()
Gets the lower y geographic reference in the current unit.

Parameters:
no - parameter
Returns:
a real number
Throws: no
exception
o setY2 
 public void setY2(double y2)
Sets the lower y geographic reference in the current unit.

Parameters:
y2 - a real number
Returns:
no return
Throws: IllegalArgumentException
if y2 is not less than upper reference
o getX2 
 public double getX2()
Gets the most-at-right x geographic reference in the current unit.

Parameters:
no - parameter
Returns:
a real number
Throws: no
exception
o setX2 
 public void setX2(double x2)
Sets the most-at-right x geographic reference in the current unit.

Parameters:
x2 - a real number
Returns:
no return
Throws: IllegalArgumentException
if x2 is not greater than left reference
o getX1 
 public double getX1()
Gets the most-at-left x geographic reference in the current unit.

Parameters:
no - parameter
Returns:
a real number
Throws: no
exception
o setX1 
 public void setX1(double x1)
Sets the most-at-left x geographic reference in the current unit.

Parameters:
x1 - a real number
Returns:
no return
Throws: IllegalArgumentException
if x1 is not less than right reference
o getXRes 
 public double getXRes()
Gets the x-plane geographic resolution in the current unit.

Parameters:
no - parameter
Returns:
a real number
Throws: no
exception
o setXRes 
 public void setXRes(double xRes)
Sets the x-plane geographic resolution in the current unit.

Parameters:
xRes - a real number
Returns:
no return
Throws: IllegalArgumentException
if resolution is zero or less
o getYRes 
 public double getYRes()
Gets the y-plane geographic resolution in the current unit.

Parameters:
no - parameter
Returns:
a real number
Throws: no
exception
o setYRes 
 public void setYRes(double yRes)
Sets the y-plane geographic resolution in the current unit.

Parameters:
yRes - a real number
Returns:
no return
Throws: IllegalArgumentException
if resolution is zero or less
o toString 
 public String toString()
Gets the complete region description.

Parameters:
no - parameter
Returns:
the region (west, north, east, south, x-plane and y-plane resolution) as a string
Throws: no
exception
Overrides:
toString in class Object 
All Packages  Class Hierarchy  This Package  Previous  Next  Index