org.autoplot.datasource.capability.TimeSeriesBrowse

This capability allows DataSources that know how to produce data sets from a long time series to provide views of the DataSource for different times and resolutions. The getURI() method of the DataSource should return the original URI and getDataSet should return the original dataset. getURI if TimeSeriesBrowse should return the URI for the range and resolution specified. Note DataSources providing this capability must insert CacheTags into the QDataSets they produce.


PROB_NO_TIMERANGE_PROVIDED

problem message to use in reject when the timerange was not provided in the URI.


PROB_PARSE_ERROR_IN_TIMERANGE

problem message to use in reject when the timerange does not parse properly.


blurURI

blurURI( ) → String

return the URI without the timeSeriesBrowse settings, for use in .vap files and where the timerange is set elsewhere.

Returns:

the URI simplified by removing the timerange and resolution.

[search for examples] [view on GitHub] [view on old javadoc] [view source]


getTimeRange

getTimeRange( ) → DatumRange

get the time range for the current view of the timeseries. Note this may not be the same as getTimeRange

Returns:

the current time range.

[search for examples] [view on GitHub] [view on old javadoc] [view source]


getTimeResolution

getTimeResolution( ) → Datum

get the resolution for the current view of the timeseries. Note this may not be the same as setTimeResolution. Also, this may be null, indicating the native resolution is used.

Returns:

the resolution for the current view of the timeseries.

[search for examples] [view on GitHub] [view on old javadoc] [view source]


getURI

getURI( ) → String

return the URI for the current time range and resolution. This is also used to identify the dataset, so the same urls returned from here must return the same dataset!

Returns:

the URI to load this data.

[search for examples] [view on GitHub] [view on old javadoc] [view source]


setTimeRange

setTimeRange( DatumRange dr ) → void

set the time range for the desired view of the timeseries.

Parameters

dr - the new time range.

Returns:

void (returns nothing)

[search for examples] [view on GitHub] [view on old javadoc] [view source]


setTimeResolution

setTimeResolution( Datum d ) → void

set the resolution for the desired view of the timeseries.

Parameters

d - the time resolution

Returns:

void (returns nothing)

[search for examples] [view on GitHub] [view on old javadoc] [view source]


setURI

setURI( String suri ) → void

Added in effort to make it easier to set the timerange if we have a timerange already. This allows the timerange part of the URI to be set without having to understand the rest of it. set the URI, and possibly the timerange part.

Parameters

suri - a String

Returns:

void (returns nothing)

[search for examples] [view on GitHub] [view on old javadoc] [view source]