net.agmodel.demdata
Interface DEMBroker

All Superinterfaces:

GenericBrokerRMI, Remote, ServerRMI

public interface DEMBroker

extends GenericBrokerRMI

Title:

Description:

Copyright: Copyright (c) NARO 2002

Company:

Field Summary

static String	GTOP30
static String	Japan50m
static String	RMIHOSTPARAM
static String	RMINAME

Fields inherited from interface net.agmodel.genericBroker.GenericBrokerRMI

EMAIL, HOSTPARAMEXTENSION, NOLOGIN, PASSWORD

Fields inherited from interface net.agmodel.genericBroker.ServerRMI

EXISTINGUSER, NEWUSER, SUPERUSER

Method Summary

DEMSourceDetail	getDEMSourceDetail(String sessionID, String dataSourceID) Gets details about a single data source.
double	getElevation(String sessionID, DEMPointRequest request)
GridLayer	getRegion(String sessionID, DEMSpatialRequest request) Gets DEM data to fulfil the request.
DEMSourceDetail[]	listDEMSourceDetails(String sessionID) Get the details for all the data sources in the broker.
DEMSourceDetail[]	listDEMSourceDetails(String sessionID, GeographicalArea ofInterest) Get the details of the data sources in the broker that coincide with the area specified.

Methods inherited from interface net.agmodel.genericBroker.GenericBrokerRMI

alreadyLoggedIn, getSourceDetail, getSourceID, listSourceDetails, listSourceDetails, loginToDataSource, loginToDataSource, loginToDataSource, logOutOfAllSources, logOutOfSource

Methods inherited from interface net.agmodel.genericBroker.ServerRMI

disconnect, getConnection, getConnection

Field Detail

GTOP30

public static final String GTOP30

See Also:

Constant Field Values

Japan50m

public static final String Japan50m

See Also:

Constant Field Values

RMINAME

public static final String RMINAME

See Also:

Constant Field Values

RMIHOSTPARAM

public static final String RMIHOSTPARAM

See Also:

Constant Field Values

Method Detail

listDEMSourceDetails

public DEMSourceDetail[] listDEMSourceDetails(String sessionID)
                                       throws RemoteException,
                                              GeneralException

Get the details for all the data sources in the broker.

Parameters:

sessionID - the ID returned by getConnection

Returns:

a list of sources. Returns an array of 0 length if the broker doesn't have any sources (not much use as a broker!)

RemoteException

GeneralException

listDEMSourceDetails

public DEMSourceDetail[] listDEMSourceDetails(String sessionID,
                                              GeographicalArea ofInterest)
                                       throws RemoteException,
                                              GeneralException

Get the details of the data sources in the broker that coincide with the area specified.

Parameters:

sessionID - the ID returned by getConnection

ofInterest - the area from which data is required

Returns:

a list of sources whose GeographicalAreas overlap with the area of Interest. Returns an array of 0 length if no such sources exist.

RemoteException

GeneralException

getDEMSourceDetail

public DEMSourceDetail getDEMSourceDetail(String sessionID,
                                          String dataSourceID)
                                   throws RemoteException

Gets details about a single data source.

Parameters:

sessionID - the ID returned by getConnection

Returns:

the database details

Throws:

IllegalArgumentException - if the data source ID is not known

RemoteException

getRegion

public GridLayer getRegion(String sessionID,
                           DEMSpatialRequest request)
                    throws RemoteException,
                           GeneralException

Gets DEM data to fulfil the request. If the requested resolution is finer than the data available, only the available resolution will be returned.
eg If you request 10m resolution and 50m is the finest available, then 50m resolution data will be returned in the result. If the requested resolution is coarser than the available data, the DEM nearest in resolution (but finer) will be used, and the data will be sampled to the requested resolution (ie the nearest source data point to each result data point will be used). The data is not interpolated in any way.

Parameters:

sessionID - the ID returned by getConnection

request -

Returns:

Throws:

RemoteException

GeneralException

getElevation

public double getElevation(String sessionID,
                           DEMPointRequest request)
                    throws RemoteException,
                           GeneralException

Parameters:

sessionID - the ID returned by getConnection

request -

Returns:

Throws:

RemoteException

GeneralException