net.agmodel.metsoap
Class WeatherStation

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

public class WeatherStation

extends Object

Contains details about a weather station.
Conforms to the JavaBean pattern to ensure easy SOAP serialization
Copyright (c)2002 National Agricultural Research Center

Constructor Summary

WeatherStation()

Method Summary

boolean[][]	getCatalog() Return a set of flags indicating which elements, and at what resolution are available from the station.
Location	getLocation() Get this station's location on the globe, including its altitude.
String	getMetSourceID() Retrieves the identifier of the database in which this station's data is stored.
TimeInterval	getOperational() Retrieves the period of operation of the station, from establishment to shut down.
String	getRegionID() Get the identifier of the region to which the station belongs, if any.
String	getStationID() Get the ID used to identify this station within its host database.
String	getStationName() Get the name of station in a form (character set) suitable for presentation to the user.
void	setCatalog(boolean[][] catalog)
void	setLocation(Location aLocation)
void	setMetSourceID(String metSourceID)
void	setOperational(TimeInterval ofOperation)
void	setRegionID(String aRegionID)
void	setStationID(String aStationID)
void	setStationName(String aStationName)

Methods inherited from class java.lang.Object

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

Constructor Detail

WeatherStation

public WeatherStation()

Method Detail

getOperational

public TimeInterval getOperational()

Retrieves the period of operation of the station, from establishment to shut down.

setOperational

public void setOperational(TimeInterval ofOperation)

setMetSourceID

public void setMetSourceID(String metSourceID)

getMetSourceID

public String getMetSourceID()

Retrieves the identifier of the database in which this station's data is stored.
This value can be used to identify the database in communications between applications and MetBroker.

Returns:

the ID of the metsource

See Also:

MetSoapRemoteInterface.listMetSources(String)

setRegionID

public void setRegionID(String aRegionID)

getRegionID

public String getRegionID()

Get the identifier of the region to which the station belongs, if any.
Regions are only defined for some databases, and the identifiers are only unique within the context of a particular database.

Returns:

a regionID or null if the database has no regions defined.

See Also:

MetSoapRemoteInterface.listRegionsForSource(String,String)

setStationID

public void setStationID(String aStationID)

getStationID

public String getStationID()

Get the ID used to identify this station within its host database.
This string must be used together with the database ID to uniquely identify the station to MetBroker

Returns:

the ID used by MetBroker to distinguish this station from others in the same database

setStationName

public void setStationName(String aStationName)

getStationName

public String getStationName()

Get the name of station in a form (character set) suitable for presentation to the user.

Returns:

the name of the station in the user's national language

getCatalog

public boolean[][] getCatalog()

Return a set of flags indicating which elements, and at what resolution are available from the station.
This function returns a 2D array of boolean values. The first index corresponds to meteorological elements. The second index corresponds to resolutions. The values for these indexes are described in the MetRequest class.

Returns:

a value of True if the element is available at the specified resolution from this station at any time during the station's period of operation.

See Also:

MetRequest.setResolution(int), MetRequest.setRequestedElements(int[])

setCatalog

public void setCatalog(boolean[][] catalog)

getLocation

public Location getLocation()

Get this station's location on the globe, including its altitude.

Returns:

a point on the planet

setLocation

public void setLocation(Location aLocation)