Package ucar.nc2.ft2.coverage

Class SubsetParams

java.lang.Object

ucar.nc2.ft2.coverage.SubsetParams

public class SubsetParams
extends Object

Describes a subset of a Coverage. Coordinate values only, no indices.

Since:

5/6/2015

See Also:

"docs/website/tds/reference/services/CdmrfParams.adoc"

Field Summary

Fields

Modifier and Type	Field	Description
static String	ensCoord
static String	horizStride
static String	latlonBB
static String	latlonPoint
static String	projBB
static String	runtime
static String	runtimeAll
static String	runtimeLatest
static String	stations
static String	time
static String	timeAll
static String	timeOffset
static String	timeOffsetAll
static String	timeOffsetDate
static String	timeOffsetFirst
static String	timeOffsetIntv
static String	timeOffsetUnit
static String	timePresent
static String	timeRange
static String	timeStride
static String	timeWindow
static String	variables
static String	vertCoord
static String	vertIntv
static String	vertRange

Constructor Summary

Constructors

Constructor	Description
SubsetParams()

Method Summary

Modifier and Type	Method	Description
void	encodeForCdmrfDataRequest(Formatter f, String varname)
Object	get(String key)
Double	getDouble(String key)
Double	getEnsCoord()
Set<Map.Entry<String,Object>>	getEntries()
Integer	getInteger(String key)
Set<String>	getKeys()
LatLonRect	getLatLonBoundingBox()
LatLonPoint	getLatLonPoint()
ProjectionRect	getProjectionRect()
CalendarDate	getRunTime()
List<String>	getStations()
CalendarDate	getTime()
Double	getTimeOffset()
double[]	getTimeOffsetIntv()
CalendarDateRange	getTimeRange()
CalendarPeriod	getTimeWindow()
List<String>	getVariables()
Double	getVertCoord()
double[]	getVertCoordIntv()
double[]	getVertRange()
boolean	hasTimeOffsetIntvParam()
boolean	hasTimeOffsetParam()
boolean	hasTimeParam()
boolean	isTrue(String key)
SubsetParams	set(String key, Object value)
SubsetParams	setEnsCoord(double coord)
SubsetParams	setHorizStride(int stride)
SubsetParams	setLatLonBoundingBox(LatLonRect llbb)
SubsetParams	setLatLonPoint(LatLonPoint pt)
SubsetParams	setProjectionRect(ProjectionRect projRect)
SubsetParams	setRunTime(CalendarDate date)
SubsetParams	setStations(List<String> stns)
SubsetParams	setTime(CalendarDate date)
SubsetParams	setTimeOffset(double offset)
SubsetParams	setTimeOffsetIntv(double[] timeCoordIntv)
SubsetParams	setTimePresent()
SubsetParams	setTimeRange(CalendarDateRange dateRange)
SubsetParams	setVariables(List<String> vars)
SubsetParams	setVertCoord(double coord)
SubsetParams	setVertCoordIntv(double[] vertCoordIntv)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

variables

public static final String variables

See Also:

Constant Field Values

latlonBB

public static final String latlonBB

See Also:

Constant Field Values

projBB

public static final String projBB

See Also:

Constant Field Values

horizStride

public static final String horizStride

See Also:

Constant Field Values

latlonPoint

public static final String latlonPoint

See Also:

Constant Field Values

stations

public static final String stations

See Also:

Constant Field Values

time

public static final String time

See Also:

Constant Field Values

timeRange

public static final String timeRange

See Also:

Constant Field Values

timeStride

public static final String timeStride

See Also:

Constant Field Values

timePresent

public static final String timePresent

See Also:

Constant Field Values

timeAll

public static final String timeAll

See Also:

Constant Field Values

timeWindow

public static final String timeWindow

See Also:

Constant Field Values

runtime

public static final String runtime

See Also:

Constant Field Values

runtimeLatest

public static final String runtimeLatest

See Also:

Constant Field Values

runtimeAll

public static final String runtimeAll

See Also:

Constant Field Values

timeOffset

public static final String timeOffset

See Also:

Constant Field Values

timeOffsetFirst

public static final String timeOffsetFirst

See Also:

Constant Field Values

timeOffsetAll

public static final String timeOffsetAll

See Also:

Constant Field Values

timeOffsetIntv

public static final String timeOffsetIntv

See Also:

Constant Field Values

vertCoord

public static final String vertCoord

See Also:

Constant Field Values

vertIntv

public static final String vertIntv

See Also:

Constant Field Values

vertRange

public static final String vertRange

See Also:

Constant Field Values

ensCoord

public static final String ensCoord

See Also:

Constant Field Values

timeOffsetDate

public static final String timeOffsetDate

See Also:

Constant Field Values

timeOffsetUnit

public static final String timeOffsetUnit

See Also:

Constant Field Values

Constructor Detail

SubsetParams

public SubsetParams()

Method Detail

encodeForCdmrfDataRequest

public void encodeForCdmrfDataRequest(Formatter f,
                                      String varname)

getEntries

public Set<Map.Entry<String,Object>> getEntries()

getKeys

public Set<String> getKeys()

set

public SubsetParams set(String key,
                        Object value)

get

public Object get(String key)

isTrue

public boolean isTrue(String key)

getDouble

public Double getDouble(String key)

getInteger

public Integer getInteger(String key)

toString

public String toString()

Overrides:

toString in class Object

hasTimeParam

public boolean hasTimeParam()

hasTimeOffsetParam

public boolean hasTimeOffsetParam()

hasTimeOffsetIntvParam

public boolean hasTimeOffsetIntvParam()

setHorizStride

public SubsetParams setHorizStride(int stride)

getLatLonBoundingBox

public LatLonRect getLatLonBoundingBox()

setLatLonBoundingBox

public SubsetParams setLatLonBoundingBox(LatLonRect llbb)

getProjectionRect

public ProjectionRect getProjectionRect()

setProjectionRect

public SubsetParams setProjectionRect(ProjectionRect projRect)

getLatLonPoint

public LatLonPoint getLatLonPoint()

setLatLonPoint

public SubsetParams setLatLonPoint(LatLonPoint pt)

getStations

public List<String> getStations()

setStations

public SubsetParams setStations(List<String> stns)

getVariables

public List<String> getVariables()

setVariables

public SubsetParams setVariables(List<String> vars)

setTime

public SubsetParams setTime(CalendarDate date)

getTime

public CalendarDate getTime()

setTimePresent

public SubsetParams setTimePresent()

getTimeRange

public CalendarDateRange getTimeRange()

setTimeRange

public SubsetParams setTimeRange(CalendarDateRange dateRange)

getRunTime

public CalendarDate getRunTime()

setRunTime

public SubsetParams setRunTime(CalendarDate date)

getTimeWindow

public CalendarPeriod getTimeWindow()

getVertRange

public double[] getVertRange()

getVertCoord

public Double getVertCoord()

setVertCoord

public SubsetParams setVertCoord(double coord)

getEnsCoord

public Double getEnsCoord()

setEnsCoord

public SubsetParams setEnsCoord(double coord)

setVertCoordIntv

public SubsetParams setVertCoordIntv(double[] vertCoordIntv)

getVertCoordIntv

public double[] getVertCoordIntv()

setTimeOffset

public SubsetParams setTimeOffset(double offset)

getTimeOffset

public Double getTimeOffset()

setTimeOffsetIntv

public SubsetParams setTimeOffsetIntv(double[] timeCoordIntv)

getTimeOffsetIntv

public double[] getTimeOffsetIntv()