net.agmodel.weatherData
Class MetSourceDetail

java.lang.Object
  |
  +--net.agmodel.genericBroker.DataSourceDetail
        |
        +--net.agmodel.weatherData.MetSourceDetail

All Implemented Interfaces:

Comparable, Serializable

public class MetSourceDetail

extends DataSourceDetail

See Also:

Serialized Form

Field Summary

Fields inherited from class net.agmodel.genericBroker.DataSourceDetail

bounds, defaultDisplayRegion, ID, loginRequirements, sourceName

Constructor Summary

MetSourceDetail(String ID, String sourceName, GeographicalArea coverage, int loginRequirements, String suggestedTimeZone, float suggestedDailyOffset, Period operational, Duration shortestResolution, Duration longestResolution)

Method Summary

Duration	getLongestResolution()
Period	getOperatingPeriod() Get the period over which the database has data available
Duration	getShortestResolution()
float	getSuggestedDailyOffset() Provide client applications with a sensible default offset for building requests for daily data for displaying the resulting data.
String	getSuggestedTimezone() Provide client applications with a sensible default timezone for building requests to the database and for displaying the resulting data.

Methods inherited from class net.agmodel.genericBroker.DataSourceDetail

compareTo, getDefaultDisplayRegion, getGeographicalArea, getID, getLoginRequirements, getName, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MetSourceDetail

public MetSourceDetail(String ID,
                       String sourceName,
                       GeographicalArea coverage,
                       int loginRequirements,
                       String suggestedTimeZone,
                       float suggestedDailyOffset,
                       Period operational,
                       Duration shortestResolution,
                       Duration longestResolution)

Method Detail

getSuggestedTimezone

public String getSuggestedTimezone()

Provide client applications with a sensible default timezone for building requests to the database and for displaying the resulting data. The String ID of the timezone is used rather than a TimeZone object for speed of transmission and portability to other languages.

Returns:

the timezone that users of this database are likely to be in.

getSuggestedDailyOffset

public float getSuggestedDailyOffset()

Provide client applications with a sensible default offset for building requests for daily data for displaying the resulting data. Daily weather data is usually recorded either at midnight or in the morning at around 9am local time.

Returns:

the number of hours from midnight that the data is recorded,eg if at midnight return 0, if at 9am return 9

getOperatingPeriod

public Period getOperatingPeriod()

Get the period over which the database has data available

Returns:

a Period from the earliest date that data is available to the latest.

getShortestResolution

public Duration getShortestResolution()

getLongestResolution

public Duration getLongestResolution()