QueryParams (THREDDS Data Server (TDS) 4.3.15 API)

java.lang.Object
- thredds.server.ncSubset.QueryParams

```
public class QueryParams
extends Object
```
Query parameter parsing for Netcdf Subset Service

Author:

caron

Field Summary

Fields
Modifier and Type	Field and Description
`List<String>`	`accept`
`String`	`acceptType`
`static String`	`CdmRemote`
`static String`	`CSV`
`double`	`east`
`StringBuilder`	`errs`
`boolean`	`fatal`
`boolean`	`hasBB`
`boolean`	`hasDateRange`
`boolean`	`hasLatlonPoint`
`boolean`	`hasStns`
`boolean`	`hasTimePoint`
`boolean`	`hasVerticalCoord`
`int`	`horizStride`
`static String`	`HTML`
`double`	`lat`
`double`	`lon`
`static String`	`NETCDF`
`static String`	`NETCDFS`
`double`	`north`
`String`	`queryString`
`static String`	`RAW`
`double`	`south`
`List<String>`	`stns`
`DateType`	`time`
`TimeDuration`	`time_duration`
`DateType`	`time_end`
`int`	`time_latest`
`DateType`	`time_start`
`int`	`timeStride`
`List<String>`	`vars`
`double`	`vertCoord`
`int`	`vertStride`
`boolean`	`wantAllVariables`
`double`	`west`
`static String`	`XML`

Constructor Summary

Constructors
Constructor and Description

QueryParams()

Constructors
Constructor and Description
`QueryParams()`

Method Summary

Methods
Modifier and Type	Method and Description
`LatLonRect`	`getBB()`
`CalendarDateRange`	`getCalendarDateRange()`
`DateType`	`parseDate(javax.servlet.http.HttpServletRequest req, String key)`
`double`	`parseDouble(javax.servlet.http.HttpServletRequest req, String key)`
`int`	`parseInt(javax.servlet.http.HttpServletRequest req, String key)`
`double`	`parseLat(javax.servlet.http.HttpServletRequest req, String key)`
`List<String>`	`parseList(javax.servlet.http.HttpServletRequest req, String key)` parse KVP for key=value or key=value,value,...
`List<String>`	`parseList(javax.servlet.http.HttpServletRequest req, String key, String[][] valids, String defValue)` Used for accept parse KVP for key=value or key=value,value,...
`double`	`parseLon(javax.servlet.http.HttpServletRequest req, String key)`
`boolean`	`parseQuery(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, String[] acceptOK)` Parse request
`TimeDuration`	`parseW3CDuration(javax.servlet.http.HttpServletRequest req, String key)`
`String`	`toString()`
`void`	`writeErr(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, String s, int code)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

RAW
```
public static final String RAW
```
See Also:
Constant Field Values

XML
```
public static final String XML
```
See Also:
Constant Field Values

HTML
```
public static final String HTML
```
See Also:
Constant Field Values

CSV
```
public static final String CSV
```
See Also:
Constant Field Values

NETCDF
```
public static final String NETCDF
```
See Also:
Constant Field Values

NETCDFS
```
public static final String NETCDFS
```
See Also:
Constant Field Values

CdmRemote
```
public static final String CdmRemote
```
See Also:
Constant Field Values

queryString
```
public String queryString
```

accept
```
public List<String> accept
```

acceptType
```
public String acceptType
```

wantAllVariables
```
public boolean wantAllVariables
```

vars
```
public List<String> vars
```

hasBB
```
public boolean hasBB
```

hasStns
```
public boolean hasStns
```

hasLatlonPoint
```
public boolean hasLatlonPoint
```

north
```
public double north
```

south
```
public double south
```

east
```
public double east
```

west
```
public double west
```

lat
```
public double lat
```

lon
```
public double lon
```

stns
```
public List<String> stns
```

horizStride
```
public int horizStride
```

vertStride
```
public int vertStride
```

timeStride
```
public int timeStride
```

hasVerticalCoord
```
public boolean hasVerticalCoord
```

vertCoord
```
public double vertCoord
```

hasDateRange
```
public boolean hasDateRange
```

hasTimePoint
```
public boolean hasTimePoint
```

time_start
```
public DateType time_start
```

time_end
```
public DateType time_end
```

time
```
public DateType time
```

time_duration
```
public TimeDuration time_duration
```

time_latest
```
public int time_latest
```

errs
```
public StringBuilder errs
```

fatal
```
public boolean fatal
```

Constructor Detail
- QueryParams
```
public QueryParams()
```

Method Detail

toString
```
public String toString()
```
Overrides:

toString in class Object

parseQuery

public boolean parseQuery(javax.servlet.http.HttpServletRequest req,
                 javax.servlet.http.HttpServletResponse res,
                 String[] acceptOK)
                   throws IOException

Parse request

Parameters:: req - HTTP request; res - HTTP response; acceptOK - array of acceptable accept types, in order. First one is default
Returns:: true if params are ok
Throws:: IOException - if I/O error

parseDate

public DateType parseDate(javax.servlet.http.HttpServletRequest req,
                 String key)

parseW3CDuration

public TimeDuration parseW3CDuration(javax.servlet.http.HttpServletRequest req,
                            String key)

parseDouble

public double parseDouble(javax.servlet.http.HttpServletRequest req,
                 String key)

parseInt

public int parseInt(javax.servlet.http.HttpServletRequest req,
           String key)

parseLat

public double parseLat(javax.servlet.http.HttpServletRequest req,
              String key)

parseLon

public double parseLon(javax.servlet.http.HttpServletRequest req,
              String key)

parseList
```
public List<String> parseList(javax.servlet.http.HttpServletRequest req,
                     String key)
```
parse KVP for key=value or key=value,value,...

Parameters:
req - HTTP request
key - key to look for

Returns:
list of values, may be empty

parseList

public List<String> parseList(javax.servlet.http.HttpServletRequest req,
                     String key,
                     String[][] valids,
                     String defValue)

Used for accept parse KVP for key=value or key=value,value,...

Parameters:: req - HTTP request; key - key to look for; valids - list of valid keywords; defValue - default value
Returns:: list of values, use default if not otherwise specified

getBB
```
public LatLonRect getBB()
```

getCalendarDateRange

public CalendarDateRange getCalendarDateRange()

writeErr

public void writeErr(javax.servlet.http.HttpServletRequest req,
            javax.servlet.http.HttpServletResponse res,
            String s,
            int code)
              throws IOException

Throws:: IOException

Class QueryParams

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RAW

XML

HTML

CSV

NETCDF

NETCDFS

CdmRemote

queryString

accept

acceptType

wantAllVariables

vars

hasBB

hasStns

hasLatlonPoint

north

south

east

west

lat

lon

stns

horizStride

vertStride

timeStride

hasVerticalCoord

vertCoord

hasDateRange

hasTimePoint

time_start

time_end

time

time_duration

time_latest

errs

fatal

Constructor Detail

QueryParams

Method Detail

toString

parseQuery

parseDate

parseW3CDuration

parseDouble

parseInt

parseLat

parseLon

parseList

parseList

getBB

getCalendarDateRange

writeErr