net.agmodel.metsoap
Class MetSource

java.lang.Object
  |
  +--net.agmodel.metsoap.MetSource

public class MetSource

extends Object

Contains details about a single database or source of meteorological data
Conforms to the JavaBean pattern to ensure easy SOAP serialization
Copyright (c)2002 National Agricultural Research Center

Constructor Summary

MetSource()

Method Summary

String	getID() Returns a unique ID which programs can use to identify the database.
int	getLoginRequirements() Indicate the usercode and password detail that need to be supplied by users of the database.
String	getName() The name of the database, suitable for presentation to the user.
GeographicalBox	getSpatialCoverage() Indicate the bounds of latitude and longitude covered by stations in this database.
float	getSuggestedDailyOffset() Provide client applications with a sensible default offset for building requests for daily data for displaying the resulting data.
float	getSuggestedTimezone() Provide client applications with a sensible default timezone for building requests to the database and for displaying the resulting data.
void	setID(String anID)
void	setLoginRequirements(int newLoginRequirements)
void	setName(String aName)
void	setSpatialCoverage(GeographicalBox coverage)
void	setSuggestedDailyOffset(float suggestedDailyOffset)
void	setSuggestedTimezone(float suggestedTimeZone)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MetSource

public MetSource()

Method Detail

getSuggestedTimezone

public float getSuggestedTimezone()

Provide client applications with a sensible default timezone for building requests to the database and for displaying the resulting data.

Returns:

the timezone that users of this database are likely to be in (in hours offset from Greenwich)

setSuggestedTimezone

public void setSuggestedTimezone(float suggestedTimeZone)

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

setSuggestedDailyOffset

public void setSuggestedDailyOffset(float suggestedDailyOffset)

setID

public void setID(String anID)

getID

public String getID()

Returns a unique ID which programs can use to identify the database.

Returns:

the ID that MetBroker uses for the database

setName

public void setName(String aName)

getName

public String getName()

The name of the database, suitable for presentation to the user.

Returns:

the name of the database

setLoginRequirements

public void setLoginRequirements(int newLoginRequirements)

getLoginRequirements

public int getLoginRequirements()

Indicate the usercode and password detail that need to be supplied by users of the database.
Options are:
0 - database doesn't require login
1 - database requires e-mail as identification
2 - database requires valid username and password

Returns:

one of the above codes

getSpatialCoverage

public GeographicalBox getSpatialCoverage()

Indicate the bounds of latitude and longitude covered by stations in this database.

Returns:

a "rectangular" box indicating the corners of the boundaries.

setSpatialCoverage

public void setSpatialCoverage(GeographicalBox coverage)