net.agmodel.metsoap
Interface MetSoapRemoteInterface

All Superinterfaces:
Remote

public interface MetSoapRemoteInterface
extends Remote

Provides SOAP-based access to MetBroker
Copyright (c) 2002 National Agricultural Research Center


Method Summary
 StationData getStationData(StationMetRequest request)
          Returns the elements of interest at the resolution of interest from a single station.
 StationData getStationDataOld(String metSourceID, String stationID, String username, String password, Date start, Date end, int[] elements, int resolution, String language, boolean okToSummarise)
          Deprecated. use getStationData(StationMetRequest) instead
 MetSource[] listMetSources(String language)
          List the metSources available from the broker.
 MetSource[] listMetSourcesInArea(String language, GeographicalBox area)
          List the metSources available from the broker which cover or partially cover an area of interest.
 Region[] listRegionsForSource(String language, String metSourceID)
          List the regions for a metSource.
 WeatherStation[] listStations(String language, String metSourceID, String regionID)
          List the stations for a database region or entire metsource if no regions are defined for the metsource.
 WeatherStation[] listStationsInArea(String language, GeographicalBox area)
          List all the stations in a particular area, regardless of the database in which they are stored.
 

Method Detail

getStationDataOld

public StationData getStationDataOld(String metSourceID,
                                     String stationID,
                                     String username,
                                     String password,
                                     Date start,
                                     Date end,
                                     int[] elements,
                                     int resolution,
                                     String language,
                                     boolean okToSummarise)
                              throws RemoteException
Deprecated. use getStationData(StationMetRequest) instead

Returns the elements of interest at the resolution of interest from a single station.

getStationData

public StationData getStationData(StationMetRequest request)
                           throws RemoteException
Returns the elements of interest at the resolution of interest from a single station.
Parameters:
request - details of the data required
Returns:
the station data, or null if the station ID is not defined or there isn't any data
Throws:
RemoteException -  

listMetSources

public MetSource[] listMetSources(String language)
                           throws RemoteException
List the metSources available from the broker.
See MetRequest.setLanguage(String) for a list of language codes.
Parameters:
language - a 2 letter code indicating the preferred national language for the database names
Returns:
an array of 0 length if no regions are defined for a metsource

listMetSourcesInArea

public MetSource[] listMetSourcesInArea(String language,
                                        GeographicalBox area)
                                 throws RemoteException
List the metSources available from the broker which cover or partially cover an area of interest.
See MetRequest.setLanguage(String) for a list of language codes.
Parameters:
language - a 2 letter code indicating the preferred national language for the database names
area - the area of interest
Returns:
an array of 0 length if no regions are defined for a metsource

listRegionsForSource

public Region[] listRegionsForSource(String language,
                                     String metSourceID)
                              throws RemoteException
List the regions for a metSource.
See MetRequest.setLanguage(String) for a list of language codes.
See (@link StationMetRequest#setSourceID(String)} for a list of metSourceIDs.
Parameters:
language - a 2 letter code indicating the preferred national language for the database names
metSourceID - the MetBroker ID for the database
Returns:
an array of 0 length if no regions are defined for a metsource

listStations

public WeatherStation[] listStations(String language,
                                     String metSourceID,
                                     String regionID)
                              throws RemoteException
List the stations for a database region or entire metsource if no regions are defined for the metsource.
See (@link StationMetRequest#setSourceID(String)} for a list of metSourceIDs.
Parameters:
metSourceID - the ID MetBroker has assigned to the database
regionID - the ID MetBroker has assigned to the region, or null if no regions are defined for the database
Returns:
an array of 0 length if no stations are defined for the region

listStationsInArea

public WeatherStation[] listStationsInArea(String language,
                                           GeographicalBox area)
                                    throws RemoteException
List all the stations in a particular area, regardless of the database in which they are stored.
See MetRequest.setLanguage(String) for a list of language codes.
Parameters:
language - a 2 letter code indicating the preferred national language for the database names
area - an area of interest (may span several databases)
Returns:
an array of 0 length if no stations are defined for the region