org.autoplot.dom.DataSourceController

Controller node manages a DataSourceFilter node.

DataSourceController( org.autoplot.ApplicationModel model, org.autoplot.dom.DataSourceFilter dsf )

PROP_RAWPROPERTIES

raw properties provided by the datasource after the data load.

PROP_TSB

PROP_TSBSURI

PROP_CACHING

PROP_DATASOURCE

object that can provide data sets and capabilities.

PROP_DATASET

PROP_FILLDATASET

PROP_EXCEPTION

PROP_HISTOGRAM

PROP_PROPERTIES

PROP_FILLPROPERTIES

PROP_REDUCEDATASETSTRING

PROP_URINEEDSRESOLUTION

true if the URI has been changed, and must be resolved into a DataSource.

PROP_DATASETNEEDSLOADING

true is the DataSource has been changed, and we need to reload.

PROP_RESETDIMENSIONS

true if the data source is changed and we need to reset the dimension names when we get our first data set.

cancel

cancel( ) → void

cancel the loading process.

Returns:

void (returns nothing)

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

doFillValidRange

doFillValidRange( ) → void

look in the metadata for fill and valid range.

Returns:

void (returns nothing)

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

getApplication( ) → org.autoplot.dom.Application [view source]

getAppliedFiltersString

getAppliedFiltersString( ) → String

return documentation of any processes applied to the data within the DataSourceFilter. This will be an empty string when no processes were applied. See getFilters which specified which should be applied.

Returns:

reduceDataSetString the string, which may be empty but will not be null.

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

getCaching( ) → org.autoplot.datasource.capability.Caching [view source]
getDataSet( ) → QDataSet [view source]

getDataSource

getDataSource( ) → org.autoplot.datasource.DataSource

return the controller's current datasource. This was synchronized, but this would mean that external clients could not query what the current source was. Since this is only reading the variable, this seems harmless. Note, findbugs prompted the code change, not an observed bug. TODO: there is probably a better way to do this, synchronizing properly on several objects.

Returns:

the controller's current datasource.

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

getException( ) → java.lang.Exception [view source]
getFillDataSet( ) → QDataSet [view source]
getFillProperties( ) → java.util.Map [view source]
getHistogram( ) → QDataSet [view source]

getMaxSliceIndex

Deprecated: this is leftover from an ancient version of the code. getProperties( ) → java.util.Map [view source]
getRawProperties( ) → java.util.Map [view source]
getTimeSeriesBrowseController( ) → org.autoplot.dom.TimeSeriesBrowseController [view source]
getTsb( ) → org.autoplot.datasource.capability.TimeSeriesBrowse [view source]
getTsbSuri( ) → String [view source]
isDataSetNeedsLoading( ) → boolean [view source]
isPendingChanges( ) → boolean [view source]
isResetDimensions( ) → boolean [view source]

isTimeSeries

isTimeSeries( QDataSet ds ) → boolean

return true if the dataset is rank 1 or greater, and has timetags for the xtagsDataSet. This will often be DEPEND_0, but for JoinDataSets which are like an array of datasets, each dataset would have DEPEND_0.

Parameters

ds - any dataset

Returns:

true if the dataset is rank 1 or greater, and has timetags for the xtagsDataSet.

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

isUriNeedsResolution( ) → boolean [view source]
pendingChanges( java.util.Map changes ) → void [view source]

resetDataSource

resetDataSource( boolean valueWasAdjusting, org.autoplot.datasource.DataSource dataSource ) → void

This might be considered the heart of the DataSourceController. This is where TimeSeriesBrowse is set up as well as Caching. This might also be a good spot to make sure we are not on the event thread, and this is being studied.

Parameters

valueWasAdjusting - true if the app was loading a vap, or locked because of changes.
dataSource - a DataSource

Returns:

void (returns nothing)

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

resetSuri

resetSuri( String suri, ProgressMonitor mon ) → void

Set the data source URI, forcing a reload if it is the same.

Parameters

suri - a String
mon - a ProgressMonitor

Returns:

void (returns nothing)

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

setAppliedFiltersString

setAppliedFiltersString( String appliedFilters ) → void

set the documentation of any processes applied to the data within the DataSourceFilter. This will be an empty string when no processes were applied. See getFilters which specified which should be applied.

Parameters

appliedFilters - a String

Returns:

void (returns nothing)

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

setCaching( org.autoplot.datasource.capability.Caching caching ) → void [view source]

setDataSet

setDataSet( QDataSet dataSet ) → void

see setDataSetInternal, which does autoranging, etc. TODO: fix this and the fillDataSet stuff...

Parameters

dataSet - a QDataSet

Returns:

void (returns nothing)

See Also:

setDataSetInternal(QDataSet)


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

setDataSetInternal

setDataSetInternal( QDataSet ds ) → void

set the dataset for the DataSourceFilter.

Parameters

ds - the dataset

Returns:

void (returns nothing)

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

setDataSetInternal

setDataSetInternal( QDataSet ds, java.util.Map rawProperties, boolean immediately ) → void

set the new dataset, do autoranging and autolabelling. preconditions:

postconditions:

Parameters

ds - the dataset.
rawProperties - additional properties provided by the data source.
immediately - if false, then this is done after the application is done adjusting.

Returns:

void (returns nothing)

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

setDataSetNeedsLoading( boolean dataSetNeedsLoading ) → void [view source]
setDataSource( org.autoplot.datasource.DataSource dataSource ) → void [view source]
setException( java.lang.Exception exception ) → void [view source]
setFillDataSet( QDataSet fillDataSet ) → void [view source]
setFillProperties( java.util.Map fillProperties ) → void [view source]
setHistogram( QDataSet histogram ) → void [view source]
setProperties( java.util.Map properties ) → void [view source]
setRawProperties( java.util.Map rawProperties ) → void [view source]
setResetDimensions( boolean resetDimensions ) → void [view source]

setSuri

setSuri( String suri, ProgressMonitor mon ) → void

Set the data source URI.

Parameters

suri - a String
mon - a ProgressMonitor

Returns:

void (returns nothing)

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

setTsb( org.autoplot.datasource.capability.TimeSeriesBrowse tsb ) → void [view source]
setTsbSuri( String tsbSuri ) → void [view source]
setUriNeedsResolution( boolean uriNeedsResolution ) → void [view source]
toString( ) → String [view source]

update

update( ) → void

update the model and view using the new DataSource to create a new dataset. This calls update(false), indicating this was not triggered in response to a human event.

Returns:

void (returns nothing)

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

update

update( boolean user ) → void

update the model and view using the new DataSource to create a new dataset.

Parameters

user - true if this is in response to a user action (e.g. not FilePollUpdates)

Returns:

void (returns nothing)

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