com.c5corp.c5utm
Class Point

java.lang.Object
  extended by com.c5corp.c5utm.Point
Direct Known Subclasses:
StatisticalPoint

public class Point
extends java.lang.Object

public class Point Point.java - part of Landscape database (otherwise known as the C5UTM database). A Point is just a structure to hold the fields from a UTM_COORDS record. It provides constructor and accessor methods for all fields. Usually you will not create and instance of this class yourself, but will use the static methods in the C5UTM class class to create a Point from a query of some sort. If you do encounter "Artifical" points, it is likely to be mediated by the ArtificialPoints class. This class also provides a toString() method. Clean up this docu! (See sql for doc on params...)

Since:
2.0
Author:
Brett Stalbaum Copyright 2002-2006 see LICENSE.txt and UCSD_LICENSE.txt
See Also:
Points, ArtificialPoints

Constructor Summary
Point()
          Default constructor for the Point class
Point(int zone, int easting, int northing, int elevation, java.lang.String dem_id, java.lang.String id)
          Constructor for the Point class.
Point(int zone, UtmCoordinatePairElev point)
          Constructor for the Point class which constructs a Point from a UTM zone and a com.c5corp.c5dem.UtmCoordinatePairElev object.
 
Method Summary
 java.lang.String getDemId()
          public getDemId() accesses the elevation member
 int getEasting()
          public getEasting() accesses the easting member
 int getElevation()
          public getElevation() accesses the elevation member
 java.lang.String getId()
          public getId() accesses the id member
 int getNorthing()
          public getNorthing() accesses the northing member
 int getZone()
          public getZone() accesses the zone member
 java.lang.String toString()
          overrides toString() of the Object class
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Point

public Point()
Default constructor for the Point class


Point

public Point(int zone,
             int easting,
             int northing,
             int elevation,
             java.lang.String dem_id,
             java.lang.String id)
Constructor for the Point class. Normally you would not call this constructor yourself, but would use on of the static methods fo the C5UTM class to create an object of this type. The static methods of the C5UTM class makes an call to the database in which the related data from the UTM_COORDS table is taken and an instance of this class produced.

Parameters:
zone - the UTM zone
easting - the UTM easting
northing - the UTM northing
elevation - the elevation
dem_id - the database id of the containing dem
id - the database id

Point

public Point(int zone,
             UtmCoordinatePairElev point)
Constructor for the Point class which constructs a Point from a UTM zone and a com.c5corp.c5dem.UtmCoordinatePairElev object. Such an object will have empty strings as the values for dem_id and id. (In other words, it will contain no reference to the records in relational database.)

Parameters:
zone - the UTM zone
point - a UtmCorrdinatePairElev
Method Detail

getZone

public int getZone()
public getZone() accesses the zone member

Returns:
the UTM zone

getEasting

public int getEasting()
public getEasting() accesses the easting member

Returns:
the UTM easting

getNorthing

public int getNorthing()
public getNorthing() accesses the northing member

Returns:
the UTM northing

getElevation

public int getElevation()
public getElevation() accesses the elevation member

Returns:
the Elevation

getDemId

public java.lang.String getDemId()
public getDemId() accesses the elevation member

Returns:
the database id of the enclosing DEM

getId

public java.lang.String getId()
public getId() accesses the id member

Returns:
the database id

toString

public java.lang.String toString()
overrides toString() of the Object class

Overrides:
toString in class java.lang.Object