com.plexobject.iploc
Class Location

java.lang.Object
  |
  +--com.plexobject.iploc.Location

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable, java.io.Serializable

Direct Known Subclasses:

AirportLocation

public class Location

extends java.lang.Object

implements java.io.Serializable, java.lang.Comparable, java.lang.Cloneable

See Also:

Serialized Form

Nested Class Summary

static class	Location.CityCmp
static class	Location.CountryCmp
static class	Location.IDCmp
static class	Location.StateCodeCmp
static class	Location.StateNameCmp
static class	Location.TimeZoneCmp

Field Summary

static Location.CityCmp	CITY_CMP
static Location.CountryCmp	COUNTRY_CMP
static com.plexobject.iploc.Location	GMT_LOCATION
static Location.IDCmp	ID_CMP
static com.plexobject.iploc.Location	LOCAL_LOCATION
static com.ibm.icu.text.DateFormat	MILLI_FORMAT
static Location.StateCodeCmp	STATE_CODE_CMP
static Location.StateNameCmp	STATE_NAME_CMP
static Location.TimeZoneCmp	TZ_CMP
static com.ibm.icu.util.SimpleTimeZone	UTC
static java.lang.String[][]	ZONES_INFO

Constructor Summary

Location()

Location(java.lang.String city, java.lang.String state, java.lang.String countryCode, java.lang.String country, java.lang.String airportCode, java.lang.String timeZone, float latitude, float longitude, float altitude, boolean dst, java.lang.String areaCode, boolean capital, float gmtOffset, float dstAdjustment, long dstStart, long dstEnd)

Method Summary

java.lang.Object	clone()
int	compareTo(java.lang.Object o)
void	copy(com.plexobject.iploc.Location l)
long	currentTimeMillis()
boolean	equals(java.lang.Object o)
java.lang.String	formatDate()
static java.lang.String	formatDate(com.ibm.icu.util.Calendar cal, com.ibm.icu.util.TimeZone tz, java.util.Date date)
java.lang.String	formatDate(java.util.Date date)
java.lang.String	formatDate(long l)
java.lang.String	getAirportCode()
float	getAltitude()
java.lang.String	getAreaCode()
com.ibm.icu.util.Calendar	getCalendar()
java.lang.String	getCity()
java.lang.String	getCityState()
java.lang.String	getCityStateCountry()
java.lang.String	getContinent()
java.lang.String	getCountry()
java.lang.String	getCountryCode()
com.ibm.icu.text.DateFormat	getDateFormat()
static com.ibm.icu.text.DateFormat	getDateFormat(com.ibm.icu.util.Calendar cal)
java.lang.String	getDialCode()
java.lang.String	getDisplayLocation()
java.lang.String	getDisplayName()
float	getDstAdjustment()
long	getDstEnd()
long	getDstStart()
float	getGmtOffset()
static java.util.Date	getGmtTime()
java.lang.String	getID()
float	getLatitude()
static float	getLatitude(float deg, float min, float sec)
java.lang.String	getLatitudeDirection()
java.lang.String	getLatitudeString()
java.util.Locale	getLocale()
java.util.Date	getLocalTime()
float	getLongitude()
static float	getLongitude(float deg, float min, float sec)
java.lang.String	getLongitudeDirection()
java.lang.String	getLongitudeString()
java.lang.String	getNameForJList()
int	getOffset()
static int	getOffset(com.ibm.icu.util.TimeZone tz, com.ibm.icu.util.Calendar calendar)
int	getRawOffset()
java.lang.String	getStateCode()
java.lang.String	getStateName()
java.lang.String	getSummaryForSalat()
java.util.Date	getTime()
java.lang.String	getTimeZone()
java.lang.String	getTimeZoneString()
com.ibm.icu.util.TimeZone	getTz()
boolean	hasAirportCode()
boolean	hasAreaCode()
boolean	hasCity()
boolean	hasCountry()
boolean	hasCountryCode()
boolean	hasGeo()
boolean	hasGmtOffset()
int	hashCode()
boolean	hasLatitude()
boolean	hasLongitude()
boolean	hasStateCode()
boolean	hasStateName()
boolean	hasTimeZone()
boolean	isCapital()
boolean	isDst()
boolean	isLocalTimeZone()
static boolean	isLocalTimeZone(com.ibm.icu.util.TimeZone tz)
boolean	isNull()
boolean	isTimeZoneMatched(java.lang.String tz)
static void	main(java.lang.String[] args)
static com.plexobject.iploc.Location	mimeDeserialize(java.lang.String raw)
java.lang.String	mimeSerialize()
com.ibm.icu.util.BuddhistCalendar	newBuddhistCalendar()
com.ibm.icu.util.ChineseCalendar	newChineseCalendar()
com.ibm.icu.util.GregorianCalendar	newGregorianCalendar()
com.ibm.icu.util.GregorianCalendar	newGregorianCalendar(java.util.Locale loc)
com.ibm.icu.util.HebrewCalendar	newHebrewCalendar()
com.ibm.icu.util.IslamicCalendar	newIslamicCalendar()
com.ibm.icu.util.JapaneseCalendar	newJapaneseCalendar()
void	setAirportCode(java.lang.String airportCode)
void	setAltitude(float altitude)
void	setAreaCode(java.lang.String areaCode)
void	setCapital(boolean capital)
void	setCity(java.lang.String city)
void	setCountry(java.lang.String country)
void	setCountryCode(java.lang.String countryCode)
void	setDst(boolean dst)
void	setDstAdjustment(float dstAdjustment)
void	setDstEnd(long dstEnd)
void	setDstStart(long dstStart)
void	setGmtOffset(float gmtOffset)
void	setLatitude(float latitude)
void	setLongitude(float longitude)
void	setState(java.lang.String state)
void	setStateCode(java.lang.String s)
void	setStateName(java.lang.String s)
void	setTime(java.util.Date d)
void	setTimeZone(java.lang.String timeZone)
static int[]	toDegMinutes(double x)
java.lang.String	toString()
static java.lang.String	toTimeZone(float gmtOffset)
void	updateTime()
static float[]	validateLatitude(float deg, float min, float sec)
static float[]	validateLongitude(float deg, float min, float sec)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

ZONES_INFO

public static final java.lang.String[][] ZONES_INFO

COUNTRY_CMP

public static Location.CountryCmp COUNTRY_CMP

STATE_CODE_CMP

public static Location.StateCodeCmp STATE_CODE_CMP

STATE_NAME_CMP

public static Location.StateNameCmp STATE_NAME_CMP

CITY_CMP

public static Location.CityCmp CITY_CMP

ID_CMP

public static Location.IDCmp ID_CMP

TZ_CMP

public static Location.TimeZoneCmp TZ_CMP

UTC

public static final com.ibm.icu.util.SimpleTimeZone UTC

MILLI_FORMAT

public static final com.ibm.icu.text.DateFormat MILLI_FORMAT

GMT_LOCATION

public static final com.plexobject.iploc.Location GMT_LOCATION

LOCAL_LOCATION

public static final com.plexobject.iploc.Location LOCAL_LOCATION

Constructor Detail

Location

public Location()

Location

public Location(java.lang.String city,
                java.lang.String state,
                java.lang.String countryCode,
                java.lang.String country,
                java.lang.String airportCode,
                java.lang.String timeZone,
                float latitude,
                float longitude,
                float altitude,
                boolean dst,
                java.lang.String areaCode,
                boolean capital,
                float gmtOffset,
                float dstAdjustment,
                long dstStart,
                long dstEnd)

Method Detail

compareTo

public int compareTo(java.lang.Object o)

Specified by:

compareTo in interface java.lang.Comparable

getDisplayName

public java.lang.String getDisplayName()

Returns:

returns displayable name

getDisplayLocation

public java.lang.String getDisplayLocation()

Returns:

returns displayable string containg city/state/country for this location

getID

public java.lang.String getID()

Returns:

returns a unique id based on city/state/country for this location

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

getSummaryForSalat

public java.lang.String getSummaryForSalat()

getNameForJList

public java.lang.String getNameForJList()

getCityState

public java.lang.String getCityState()

Returns:

returns city/state

getCityStateCountry

public java.lang.String getCityStateCountry()

Returns:

returns city/state/country

getCity

public java.lang.String getCity()

Returns:

returns city

hasCity

public boolean hasCity()

Returns:

true if location has a valid city

setCity

public void setCity(java.lang.String city)

Parameters:

city -

getCountryCode

public java.lang.String getCountryCode()

Returns:

returns country-code

hasCountryCode

public boolean hasCountryCode()

setCountryCode

public void setCountryCode(java.lang.String countryCode)

Parameters:

countryCode -

getCountry

public java.lang.String getCountry()

Returns:

returns country

hasCountry

public boolean hasCountry()

setCountry

public void setCountry(java.lang.String country)

Parameters:

country -

getAirportCode

public java.lang.String getAirportCode()

Returns:

returns airportCode

setAirportCode

public void setAirportCode(java.lang.String airportCode)

Parameters:

airportCode -

hasAirportCode

public boolean hasAirportCode()

getLocale

public java.util.Locale getLocale()

Returns:

returns locale for this location based on country-code

newGregorianCalendar

public com.ibm.icu.util.GregorianCalendar newGregorianCalendar()

Returns:

instantiates a new gregorian calendar. Note that PlexGlobe does not use java.util.Calendar class

newGregorianCalendar

public com.ibm.icu.util.GregorianCalendar newGregorianCalendar(java.util.Locale loc)

newHebrewCalendar

public com.ibm.icu.util.HebrewCalendar newHebrewCalendar()

newBuddhistCalendar

public com.ibm.icu.util.BuddhistCalendar newBuddhistCalendar()

newJapaneseCalendar

public com.ibm.icu.util.JapaneseCalendar newJapaneseCalendar()

newChineseCalendar

public com.ibm.icu.util.ChineseCalendar newChineseCalendar()

newIslamicCalendar

public com.ibm.icu.util.IslamicCalendar newIslamicCalendar()

getRawOffset

public int getRawOffset()

getOffset

public static int getOffset(com.ibm.icu.util.TimeZone tz,
                            com.ibm.icu.util.Calendar calendar)

getOffset

public int getOffset()

getCalendar

public com.ibm.icu.util.Calendar getCalendar()

getTz

public com.ibm.icu.util.TimeZone getTz()

currentTimeMillis

public long currentTimeMillis()

getGmtTime

public static java.util.Date getGmtTime()

getLocalTime

public java.util.Date getLocalTime()

setTime

public void setTime(java.util.Date d)

updateTime

public void updateTime()

getTime

public java.util.Date getTime()

formatDate

public java.lang.String formatDate()

formatDate

public java.lang.String formatDate(long l)

formatDate

public java.lang.String formatDate(java.util.Date date)

getDateFormat

public com.ibm.icu.text.DateFormat getDateFormat()

Returns:

returns default date-formatter for this location

getDateFormat

public static com.ibm.icu.text.DateFormat getDateFormat(com.ibm.icu.util.Calendar cal)

formatDate

public static java.lang.String formatDate(com.ibm.icu.util.Calendar cal,
                                          com.ibm.icu.util.TimeZone tz,
                                          java.util.Date date)

getTimeZone

public java.lang.String getTimeZone()

Returns:

returns timeZone

getTimeZoneString

public java.lang.String getTimeZoneString()

hasTimeZone

public boolean hasTimeZone()

setTimeZone

public void setTimeZone(java.lang.String timeZone)

Parameters:

timeZone -

getLatitude

public float getLatitude()

Returns:

returns latitude

getLatitudeString

public java.lang.String getLatitudeString()

hasLatitude

public boolean hasLatitude()

setLatitude

public void setLatitude(float latitude)

Parameters:

latitude -

getLatitudeDirection

public java.lang.String getLatitudeDirection()

Returns:

returns latitudeDirection POS. LATITUDE = NORTH NEG. LATITUDE = SOUTH

getLongitude

public float getLongitude()

Returns:

returns longitude

hasLongitude

public boolean hasLongitude()

setLongitude

public void setLongitude(float longitude)

Parameters:

longitude -

getLongitudeDirection

public java.lang.String getLongitudeDirection()

Returns:

returns longitudeDirection POS. LONGITUDE = EAST NEG. LONGITUDE = WEST

getLongitudeString

public java.lang.String getLongitudeString()

hasGeo

public boolean hasGeo()

getStateCode

public java.lang.String getStateCode()

Returns:

returns state

setStateCode

public void setStateCode(java.lang.String s)

hasStateCode

public boolean hasStateCode()

getStateName

public java.lang.String getStateName()

setStateName

public void setStateName(java.lang.String s)

hasStateName

public boolean hasStateName()

setState

public void setState(java.lang.String state)

Parameters:

state -

isDst

public boolean isDst()

Returns:

returns dst

setDst

public void setDst(boolean dst)

Parameters:

dst -

getAreaCode

public java.lang.String getAreaCode()

Returns:

returns areaCode

hasAreaCode

public boolean hasAreaCode()

setAreaCode

public void setAreaCode(java.lang.String areaCode)

Parameters:

areaCode -

isCapital

public boolean isCapital()

Returns:

returns capital

setCapital

public void setCapital(boolean capital)

Parameters:

capital -

getGmtOffset

public float getGmtOffset()

Returns:

returns gmtOffset

hasGmtOffset

public boolean hasGmtOffset()

setGmtOffset

public void setGmtOffset(float gmtOffset)

Parameters:

gmtOffset -

getDstAdjustment

public float getDstAdjustment()

Returns:

returns dstAdjustment

setDstAdjustment

public void setDstAdjustment(float dstAdjustment)

Parameters:

dstAdjustment -

getDstStart

public long getDstStart()

Returns:

returns dstStart

setDstStart

public void setDstStart(long dstStart)

Parameters:

dstStart -

getDstEnd

public long getDstEnd()

Returns:

returns dstEnd

setDstEnd

public void setDstEnd(long dstEnd)

Parameters:

dstEnd -

isTimeZoneMatched

public boolean isTimeZoneMatched(java.lang.String tz)

copy

public void copy(com.plexobject.iploc.Location l)

getDialCode

public java.lang.String getDialCode()

getContinent

public java.lang.String getContinent()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toTimeZone

public static java.lang.String toTimeZone(float gmtOffset)

mimeSerialize

public java.lang.String mimeSerialize()
                               throws java.io.IOException

java.io.IOException

mimeDeserialize

public static com.plexobject.iploc.Location mimeDeserialize(java.lang.String raw)
                                                     throws java.io.IOException,
                                                            java.lang.ClassNotFoundException

java.io.IOException

java.lang.ClassNotFoundException

getLatitude

public static float getLatitude(float deg,
                                float min,
                                float sec)

getLongitude

public static float getLongitude(float deg,
                                 float min,
                                 float sec)

toDegMinutes

public static int[] toDegMinutes(double x)

validateLatitude

public static float[] validateLatitude(float deg,
                                       float min,
                                       float sec)

validateLongitude

public static float[] validateLongitude(float deg,
                                        float min,
                                        float sec)

getAltitude

public float getAltitude()

Returns:

returns altitude

setAltitude

public void setAltitude(float altitude)

Parameters:

altitude -

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

java.lang.CloneNotSupportedException

isNull

public boolean isNull()

isLocalTimeZone

public boolean isLocalTimeZone()

isLocalTimeZone

public static boolean isLocalTimeZone(com.ibm.icu.util.TimeZone tz)

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

java.lang.Exception