edu.wisc.ssec.mcidas.adde
Class DataSetInfo

java.lang.Object
  extended by edu.wisc.ssec.mcidas.adde.DataSetInfo

public class DataSetInfo
extends java.lang.Object

DataSetInfo interface for McIDAS ADDE data sets. Simulates a McIDAS DSINFO request using an ADDE URL.

 URLs must all have the following format   
   adde://host/datasetinfo?keyword_1=value_1&keyword_2=value_2

 there can be any valid combination of the following supported keywords:

   group - ADDE group name   
   type  - ADDE data type.  Must be one of the following:
               image, point, grid, text, nav
           the default is the image type.

 the following keywords are required:

   group

 an example URL might look like:
   adde://viper/datasetinfo?group=gvar&type=image
 


Constructor Summary
DataSetInfo(java.lang.String request)
          creates a DataSetInfo object that allows reading
 
Method Summary
 char[] getData()
          Return the data sent by the server
 java.util.Hashtable getDescriptionTable()
          Return a hashtable of descriptive names and ADDE dataset descriptors Descriptive names are the keys.
 java.lang.String[] getDescriptors()
          Return a sorted list of the dataset descriptors
static void main(java.lang.String[] args)
          test by running 'java edu.wisc.ssec.mcidas.adde.DataSetInfo'
 java.lang.String toString()
          Return a formated string of the returned data
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DataSetInfo

public DataSetInfo(java.lang.String request)
            throws AddeURLException
creates a DataSetInfo object that allows reading

Parameters:
request - ADDE URL to read from. See class javadoc.
 an example URL might look like:
   adde://viper/datasetinfo?group=gvar&type=image
 
Throws:
AddeURLException - if there are no datasets of the particular type or there is an error reading data
Method Detail

getData

public char[] getData()
               throws AddeURLException
Return the data sent by the server

Returns:
array of the data. Data is in the format of a McIDAS DSINFO (LWPR) request.
Throws:
AddeURLException - if there was an error reading data

getDescriptionTable

public java.util.Hashtable getDescriptionTable()
                                        throws AddeURLException
Return a hashtable of descriptive names and ADDE dataset descriptors Descriptive names are the keys. If there is no descriptive name, the dataset descriptor is used.

Returns:
hashtable of names/desciptors
Throws:
AddeURLException - if there was an error reading data

getDescriptors

public java.lang.String[] getDescriptors()
                                  throws AddeURLException
Return a sorted list of the dataset descriptors

Returns:
sorted list
Throws:
AddeURLException - if there was an error reading data

toString

public java.lang.String toString()
Return a formated string of the returned data

Overrides:
toString in class java.lang.Object
Returns:
formatted string representing the data.

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception
test by running 'java edu.wisc.ssec.mcidas.adde.DataSetInfo'

Throws:
java.lang.Exception