KosherJava Zmanim Homepage
Includes a dynamic Zmanim calendar generator

net.sourceforge.zmanim.util
Class GeoLocation

java.lang.Object
  extended bynet.sourceforge.zmanim.util.GeoLocation

public class GeoLocation
extends Object

A class that contains location information such as latitude and longitude required for astronomical calculations. The elevation field is not used by most calculation engines and would be ignored if set. Check the documentation for specific implementations of the AstronomicalCalculator to see if elevation is calculated as part o the algorithm.

Version:
1.1
Author:
© Eliyahu Hershfeld 2004 - 2007

Constructor Summary
GeoLocation()
          Default GeoLocation constructor will set location to the Prime Meridian at Greenwich, England and a TimeZone of GMT.
GeoLocation(String name, double latitude, double longitude, double elevation, TimeZone timeZone)
          GeoLocation constructor with parameters for all required fields.
GeoLocation(String name, double latitude, double longitude, TimeZone timeZone)
          GeoLocation constructor with parameters for all required fields.
 
Method Summary
 boolean equals(Object object)
           
 double getElevation()
          Method to get the elevation in Meters.
 double getLatitude()
           
 String getLocationName()
           
 double getLongitude()
           
 TimeZone getTimeZone()
           
 int hashCode()
           
 void setElevation(double elevation)
          Method to set the elevation in Meters above sea level.
 void setLatitude(double latitude)
          Method to set the latitude in a double format.
 void setLatitude(int degrees, int minutes, double seconds, String direction)
          Method to set the latitude in degrees, minutes and seconds.
 void setLocationName(String name)
           
 void setLongitude(double longitude)
          Method to set the longitude in a double format.
 void setLongitude(int degrees, int minutes, double seconds, String direction)
          Method to set the longitude in degrees, minutes and seconds.
 void setTimeZone(TimeZone timeZone)
           
 String toString()
           
 String toXML()
          A method that returns an XML formatted String representing the serialized Object.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

GeoLocation

public GeoLocation(String name,
                   double latitude,
                   double longitude,
                   TimeZone timeZone)
GeoLocation constructor with parameters for all required fields.

Parameters:
name - The location name for display use such as "Lakewood, NJ"
latitude - the latitude in a double format such as 40.095965 for Lakewood, NJ
longitude - double the longitude in a double format such as -74.222130 for Lakewood, NJ.
Note: For longitudes east of the Prime Meridian (Greenwich), a negative value should be used.
timeZone - the TimeZone for the location.

GeoLocation

public GeoLocation(String name,
                   double latitude,
                   double longitude,
                   double elevation,
                   TimeZone timeZone)
GeoLocation constructor with parameters for all required fields.

Parameters:
name - The location name for display use such as "Lakewood, NJ"
latitude - the latitude in a double format such as 40.095965 for Lakewood, NJ
longitude - double the longitude in a double format such as -74.222130 for Lakewood, NJ.
Note: For longitudes east of the Prime Meridian (Greenwich), a negative value should be used.
elevation - the elevation above sea level in Meters. Elevation is not used in most algorithms used for calculating sunrise and set.
timeZone - the TimeZone for the location.

GeoLocation

public GeoLocation()
Default GeoLocation constructor will set location to the Prime Meridian at Greenwich, England and a TimeZone of GMT. The longitude will be set to 0 and the latitude will be 51.4772 to match the location of the Royal Observatory, Greenwich . No daylight savings time will be used.

Method Detail

getElevation

public double getElevation()
Method to get the elevation in Meters.

Returns:
Returns the elevation in Meters.

setElevation

public void setElevation(double elevation)
Method to set the elevation in Meters above sea level.

Parameters:
elevation - The elevation to set in Meters. An IllegalArgumentException will be thrown if the value is a negative.

setLatitude

public void setLatitude(double latitude)
Method to set the latitude in a double format.

Parameters:
latitude - The degrees of latitude to set in a double format between -90° and 90°. An IllegalArgumentException will be thrown if the value exceeds the limit. For example 40.095965 would be used for Lakewood, NJ.

setLatitude

public void setLatitude(int degrees,
                        int minutes,
                        double seconds,
                        String direction)
Method to set the latitude in degrees, minutes and seconds.

Parameters:
degrees - The degrees of latitude to set between -90 and 90. An IllegalArgumentException will be thrown if the value exceeds the limit. For example 40 would be used for Lakewood, NJ.
minutes -
seconds -
direction - N for north and S for south. An IllegalArgumentException will be thrown if the value is not S or N.

getLatitude

public double getLatitude()
Returns:
Returns the latitude.

setLongitude

public void setLongitude(double longitude)
Method to set the longitude in a double format.

Parameters:
longitude - The degrees of longitude to set in a double format between -180° and 180°. An IllegalArgumentException will be thrown if the value exceeds the limit. For example -74.222130 would be used for Lakewood, NJ. Note: for longitudes east of the Prime Meridian (Greenwich) a negative value should be used.

setLongitude

public void setLongitude(int degrees,
                         int minutes,
                         double seconds,
                         String direction)
Method to set the longitude in degrees, minutes and seconds.

Parameters:
degrees - The degrees of longitude to set between -180 and 180. An IllegalArgumentException will be thrown if the value exceeds the limit. For example -74 would be used for Lakewood, NJ. Note: for longitudes east of the Prime Meridian (Greenwich) a negative value should be used.
minutes -
seconds -
direction - E for east of the Prime Meridian or W for west of it. An IllegalArgumentException will be thrown if the value is not E or W.

getLongitude

public double getLongitude()
Returns:
Returns the longitude.

getLocationName

public String getLocationName()
Returns:
Returns the location name.

setLocationName

public void setLocationName(String name)
Parameters:
name - The setter method for the display name.

getTimeZone

public TimeZone getTimeZone()
Returns:
Returns the timeZone.

setTimeZone

public void setTimeZone(TimeZone timeZone)
Parameters:
timeZone - The timeZone to set.

toXML

public String toXML()
A method that returns an XML formatted String representing the serialized Object. Very similar to the toString method but the return value is in an xml format. The format currently used (subject to change) is:
   <GeoLocation>
   	 <LocationName>Lakewood, NJ</LocationName>
   	 <Latitude>-74.222130°</Latitude>
   	 <Longitude>-74.222130°</Longitude>
   	 <Elevation>0 Meters</Elevation>
   	 <TimezoneName>America/New_York</TimezoneName>
   	 <TimeZoneDisplayName>Eastern Standard Time</TimeZoneDisplayName>
   	 <TimezoneGMTOffset>-5</TimezoneGMTOffset>
   	 <TimezoneDSTOffset>1</TimezoneDSTOffset>
   </GeoLocation>
 

Returns:
The XML formatted String.

equals

public boolean equals(Object object)
See Also:
Object.equals(Object)

hashCode

public int hashCode()
See Also:
Object.hashCode()

toString

public String toString()
See Also:
Object.toString()

KosherJava Zmanim Homepage
Includes a dynamic Zmanim calendar generator

Copyright © 2004 - 2007 Eliyahu Hershfeld. All Rights Reserved.