edu.wisc.ssec.mcidas.adde

Class AddeImageURL

java.lang.Object

edu.wisc.ssec.mcidas.adde.AddeURL

edu.wisc.ssec.mcidas.adde.AddeDatasetURL

edu.wisc.ssec.mcidas.adde.AddeImageURL

All Implemented Interfaces:

java.lang.Cloneable

public class AddeImageURL
extends AddeDatasetURL

A class for holding the ADDE URL for an image directory or data request.

 URLs must all have the following format:

   adde://host/request?keyword_1=value_1&keyword_2=value_2

 where request can be one of the following:

   imagedata - request for data in AreaFile format (AGET)
   imagedirectory - request for image directory information (ADIR)

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

   group=<groupname>         ADDE group name
   descr=<descriptor>        ADDE descriptor name
   band=<band>               spectral band or channel number
   mag=<lmag> <emag>         image magnification, postitive for blowup,
                               negative for blowdown (default = 1, emag=lmag)
                               (imagedata only)
   latlon=<lat> <lon>        lat/lon point to center image on (imagedata only)
   linele=<lin> <ele> <type> line/element to center image on (imagedata only)
   place=<placement>         placement of lat/lon or linele points (center
                               or upperleft (def=center)) (imagedata only)
   pos=<position>            request an absolute or relative ADDE position
                               number.  May use <start> <end>  Default
                               for <end> is 0 if start<0, or =start otherwise.
   size=<lines> <elements>   size of image to be returned (imagedata only)
   unit=<unit>               to specify calibration units other than the
                               default
   spac=<bytes>              number of bytes per data point, 1, 2, or 4
                               (imagedata only)
   doc=<yes/no>              specify yes to include line documentation
                               with image (def=no)
   nav=<lalo>                include the lat-lon navigation info and not the O&A.
   aux=<yes/no>              specify yes to include auxilliary information
                               with image
   time=<time1> <time2>      specify the time range of images to select
                               (def=latest image if pos not specified)
   day=<day>                 specify the day of the images to select
                               (def=latest image if pos not specified)
   cal=<cal type>            request a specific calibration on the image
                               (imagedata only)
   id=<stn id>               radar station id
   user=<user_id>            ADDE user identification
   proj=<proj #>             a valid ADDE project number
   trace=<0/1>               setting to 1 tells server to write debug
                               trace file
   version=                  ADDE version number, currently 1 except for
                             griddata requests
   debug=                    set to true to watch the printlns stream by
   compress=                 set to "gzip" if you want to use the GZIP
                             compression or "compress" if you want to use
                             transfers in Unix compress format (You need to
                             have the VisAD package if you want to support
                             this.)  default = none.
   port=                     Socket port to connect on.  Overridden by
                             a port specified in the host
                             (e.g., adde.ucar.edu:500)
 

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KEY_AUX Keyword for aux request
static java.lang.String	KEY_BAND Keyword for band
static java.lang.String	KEY_DAY Keyword for day request
static java.lang.String	KEY_DOC Keyword for doc request
static java.lang.String	KEY_ID Keyword for station id
static java.lang.String	KEY_LATLON Keyword for lat/lon request
static java.lang.String	KEY_LINEELE Keyword for lin/ele request
static java.lang.String	KEY_LOC Keyword for location
static java.lang.String	KEY_MAG Keyword for mag
static java.lang.String	KEY_NAV Keyword for navigation type
static java.lang.String	KEY_NUM Keyword for number of items
static java.lang.String	KEY_PLACE Keyword for place
static java.lang.String	KEY_POS Keyword for position
static java.lang.String	KEY_SIZE Keyword for size
static java.lang.String	KEY_SPAC Keyword for spacing
static java.lang.String	KEY_TIME Keyword for time request
static java.lang.String	KEY_UNIT Keyword for calibration unit

Fields inherited from class edu.wisc.ssec.mcidas.adde.AddeDatasetURL

KEY_DESCRIPTOR, KEY_GROUP

Fields inherited from class edu.wisc.ssec.mcidas.adde.AddeURL

ADDE_PROTOCOL, ALL, COMPRESS, DEFAULT_VALUE, GZIP, KEY_COMPRESS, KEY_DEBUG, KEY_PORT, KEY_PROJ, KEY_TRACE, KEY_USER, KEY_VERSION, NO, NO_COMPRESS, REQ_ADIR, REQ_AGET, REQ_DATASETINFO, REQ_GDIR, REQ_GGET, REQ_GRIDDATA, REQ_GRIDDIR, REQ_IMAGEDATA, REQ_IMAGEDIR, REQ_LWPR, REQ_MDKS, REQ_OBTEXT, REQ_OBTG, REQ_POINTDATA, REQ_TEXT, REQ_TXTG, REQ_WTXG, REQ_WXTEXT, TRACE_OFF, TRACE_ON, YES

Constructor Summary

Constructors

Constructor and Description
AddeImageURL() no arg constructor
AddeImageURL(java.lang.String host, java.lang.String requestType, java.lang.String group, java.lang.String descriptor) Create an AddeImageURL.
AddeImageURL(java.lang.String host, java.lang.String requestType, java.lang.String group, java.lang.String descriptor, java.lang.String query) Create an ADDE Image URL from the given specs.
AddeImageURL(java.lang.String host, java.lang.String requestType, java.lang.String group, java.lang.String descriptor, java.lang.String locateKey, java.lang.String locateValue, java.lang.String placeValue, int lines, int elements, int lmag, int emag, java.lang.String band, java.lang.String unit, int spacing) Create an ADDE Image URL from the given spec

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAuxValue() Get the AUX keyword value
java.lang.String	getBand() Get the band or band range
int	getDatasetPosition() Get the dataset position
java.lang.String	getDocValue() Get the DOC keyword value
int	getElementMag() Get the element magnification
int	getElements() Get the number of elements
java.util.Date	getEndDate() Get the end date for the request
java.lang.String	getId() Get the location ID for radar images
int	getLineMag() Get the line magnification
int	getLines() Get the number of lines
java.lang.String	getLocateKey() Get the locate key
java.lang.String	getLocateValue() Get the locate value
java.lang.String	getNavType() Get the navigation type
java.lang.String	getPlaceValue() Get the PLACE value
int	getSpacing() Get the data size (SPAC)
java.util.Date	getStartDate() Get the start date for the request
java.lang.String	getTimeCoverage() Set the time coverage
java.lang.String	getUnit() Get the calibration unit
void	setAuxValue(java.lang.String value) Set the AUX keyword value
void	setBand(java.lang.String value) Set the band or band range
void	setDatasetPosition(int value) Set the dataset position
void	setDocValue(java.lang.String value) Set the DOC keyword value
void	setElementMag(int value) Set the element magnification
void	setElements(int value) Set the number of elements
void	setEndDate(java.util.Date value) Set the end date for the request
void	setId(java.lang.String value) Set the location ID for radar images
void	setLineMag(int value) Set the line magnification
void	setLines(int value) Set the number of lines
void	setLocateKey(java.lang.String value) Set the locate key
void	setLocateValue(java.lang.String value) Set the locate value
void	setNavType(java.lang.String value) Set the navigation type
void	setPlaceValue(java.lang.String value) Set the place value
void	setSpacing(int value) Set the data size (SPAC)
void	setStartDate(java.util.Date value) Set the start date for the request
void	setTimeCoverage(java.lang.String value) Set the time coverage
void	setUnit(java.lang.String value) Set the calibration unit

Methods inherited from class edu.wisc.ssec.mcidas.adde.AddeDatasetURL

getDescriptor, getGroup, setDescriptor, setGroup

Methods inherited from class edu.wisc.ssec.mcidas.adde.AddeURL

clone, equals, getCompression, getDebug, getExtraKeys, getHost, getPort, getProject, getRequestType, getTrace, getURLString, getUser, getValue, getVersion, hashCode, setCompression, setCompressionFromString, setDebug, setExtraKeys, setHost, setPort, setProject, setRequestType, setTrace, setUser, setVersion

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEY_BAND

public static final java.lang.String KEY_BAND

Keyword for band

See Also:

Constant Field Values

KEY_POS

public static final java.lang.String KEY_POS

Keyword for position

See Also:

Constant Field Values

KEY_ID

public static final java.lang.String KEY_ID

Keyword for station id

See Also:

Constant Field Values

KEY_LATLON

public static final java.lang.String KEY_LATLON

Keyword for lat/lon request

See Also:

Constant Field Values

KEY_LINEELE

public static final java.lang.String KEY_LINEELE

Keyword for lin/ele request

See Also:

Constant Field Values

KEY_LOC

public static final java.lang.String KEY_LOC

Keyword for location

See Also:

Constant Field Values

KEY_MAG

public static final java.lang.String KEY_MAG

Keyword for mag

See Also:

Constant Field Values

KEY_NUM

public static final java.lang.String KEY_NUM

Keyword for number of items

See Also:

Constant Field Values

KEY_PLACE

public static final java.lang.String KEY_PLACE

Keyword for place

See Also:

Constant Field Values

KEY_SIZE

public static final java.lang.String KEY_SIZE

Keyword for size

See Also:

Constant Field Values

KEY_SPAC

public static final java.lang.String KEY_SPAC

Keyword for spacing

See Also:

Constant Field Values

KEY_UNIT

public static final java.lang.String KEY_UNIT

Keyword for calibration unit

See Also:

Constant Field Values

KEY_NAV

public static final java.lang.String KEY_NAV

Keyword for navigation type

See Also:

Constant Field Values

KEY_AUX

public static final java.lang.String KEY_AUX

Keyword for aux request

See Also:

Constant Field Values

KEY_DOC

public static final java.lang.String KEY_DOC

Keyword for doc request

See Also:

Constant Field Values

KEY_DAY

public static final java.lang.String KEY_DAY

Keyword for day request

See Also:

Constant Field Values

KEY_TIME

public static final java.lang.String KEY_TIME

Keyword for time request

See Also:

Constant Field Values

Constructor Detail

AddeImageURL

public AddeImageURL()

no arg constructor

AddeImageURL

public AddeImageURL(java.lang.String host,
                    java.lang.String requestType,
                    java.lang.String group,
                    java.lang.String descriptor)

Create an AddeImageURL.

Parameters:

host - host to send to

requestType - type of request (REQ_IMAGEDATA, REQ_IMAGEDIR)

group - ADDE group

descriptor - ADDE descriptor

AddeImageURL

public AddeImageURL(java.lang.String host,
                    java.lang.String requestType,
                    java.lang.String group,
                    java.lang.String descriptor,
                    java.lang.String query)

Create an ADDE Image URL from the given specs.

Parameters:

host - host to send to

requestType - type of request (REQ_IMAGEDATA, REQ_IMAGEDIR)

group - ADDE group (may be null)

descriptor - ADDE descriptor (may be null)

query - query string (key/value pairs)

AddeImageURL

public AddeImageURL(java.lang.String host,
                    java.lang.String requestType,
                    java.lang.String group,
                    java.lang.String descriptor,
                    java.lang.String locateKey,
                    java.lang.String locateValue,
                    java.lang.String placeValue,
                    int lines,
                    int elements,
                    int lmag,
                    int emag,
                    java.lang.String band,
                    java.lang.String unit,
                    int spacing)

Create an ADDE Image URL from the given spec

Parameters:

host - host to send to

requestType - type of request (REQ_IMAGEDATA, REQ_IMAGEDIR)

group - ADDE group

descriptor - ADDE descriptor

locateKey - locate key

locateValue - locate value

placeValue - place value

lines - number of lines

elements - number of elements

lmag - line magnification

emag - element magnification

band - band

unit - calibration unit

spacing - data size

Method Detail

getPlaceValue

public java.lang.String getPlaceValue()

Get the PLACE value

Returns:

the PLACE value

getLocateKey

public java.lang.String getLocateKey()

Get the locate key

Returns:

the locate key

getLocateValue

public java.lang.String getLocateValue()

Get the locate value

Returns:

the locate value

getLines

public int getLines()

Get the number of lines

Returns:

the number of lines

getElements

public int getElements()

Get the number of elements

Returns:

the number of elements

getElementMag

public int getElementMag()

Get the element magnification

Returns:

the element magnification

getLineMag

public int getLineMag()

Get the line magnification

Returns:

the line magnification

setLocateKey

public void setLocateKey(java.lang.String value)

Set the locate key

Parameters:

value - the locate key

setLocateValue

public void setLocateValue(java.lang.String value)

Set the locate value

Parameters:

value - the locate value

setPlaceValue

public void setPlaceValue(java.lang.String value)

Set the place value

Parameters:

value - the place value

setLines

public void setLines(int value)

Set the number of lines

Parameters:

value - the number of lines

setElements

public void setElements(int value)

Set the number of elements

Parameters:

value - the number of elements

setElementMag

public void setElementMag(int value)

Set the element magnification

Parameters:

value - the element magnification

setLineMag

public void setLineMag(int value)

Set the line magnification

Parameters:

value - the line magnification

setSpacing

public void setSpacing(int value)

Set the data size (SPAC)

Parameters:

value - the data size

getSpacing

public int getSpacing()

Get the data size (SPAC)

Returns:

the data size

setBand

public void setBand(java.lang.String value)

Set the band or band range

Parameters:

value - the band range or ALL. For REQ_IMAGEDATA, must be a single band

getBand

public java.lang.String getBand()

Get the band or band range

Returns:

the band range or ALL.

setUnit

public void setUnit(java.lang.String value)

Set the calibration unit

Parameters:

value - the calibration unit

getUnit

public java.lang.String getUnit()

Get the calibration unit

Returns:

calibration unit

setNavType

public void setNavType(java.lang.String value)

Set the navigation type

Parameters:

value - the navigation type (X or LALO)

getNavType

public java.lang.String getNavType()

Get the navigation type

Returns:

navigation type (default or LALO)

setId

public void setId(java.lang.String value)

Set the location ID for radar images

Parameters:

value - the location ID

getId

public java.lang.String getId()

Get the location ID for radar images

Returns:

location ID

setDatasetPosition

public void setDatasetPosition(int value)

Set the dataset position

Parameters:

value - the dataset position

getDatasetPosition

public int getDatasetPosition()

Get the dataset position

Returns:

dataset position

setStartDate

public void setStartDate(java.util.Date value)

Set the start date for the request

Parameters:

value - the starting date for the request

getStartDate

public java.util.Date getStartDate()

Get the start date for the request

Returns:

the start date for the request

setEndDate

public void setEndDate(java.util.Date value)

Set the end date for the request

Parameters:

value - the ending date for the request

getEndDate

public java.util.Date getEndDate()

Get the end date for the request

Returns:

the ending date for the request

setTimeCoverage

public void setTimeCoverage(java.lang.String value)

Set the time coverage

Parameters:

value - the time coverage

getTimeCoverage

public java.lang.String getTimeCoverage()

Set the time coverage

Returns:

the time coverage

setAuxValue

public void setAuxValue(java.lang.String value)

Set the AUX keyword value

Parameters:

value - the AUX keyword value (YES, NO or DEFAULT_VALUE)

getAuxValue

public java.lang.String getAuxValue()

Get the AUX keyword value

Returns:

the AUX keyword value (YES, NO or DEFAULT_VALUE)

setDocValue

public void setDocValue(java.lang.String value)

Set the DOC keyword value

Parameters:

value - the DOC keyword value (YES, NO or DEFAULT_VALUE)

getDocValue

public java.lang.String getDocValue()

Get the DOC keyword value

Returns:

the DOC keyword value (YES, NO or DEFAULT_VALUE)