## 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

getApplication( ) → org.autoplot.dom.Application

### Returns:

org.autoplot.dom.Application
[search for examples] [view on GitHub] [view on old javadoc] [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

getCaching( ) → org.autoplot.datasource.capability.Caching

### Returns:

org.autoplot.datasource.capability.Caching
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getDataSet

getDataSet( ) → QDataSet

### Returns:

org.das2.qds.QDataSet
[search for examples] [view on GitHub] [view on old javadoc] [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

getException( ) → java.lang.Exception

### Returns:

java.lang.Exception
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getFillDataSet

getFillDataSet( ) → QDataSet

### Returns:

org.das2.qds.QDataSet
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getFillProperties

getFillProperties( ) → java.util.Map

### Returns:

java.util.Map
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getHistogram

Deprecated: this function will be removed and put into the metadata tab.

## getMaxSliceIndex

Deprecated: this is leftover from an ancient version of the code.

## getProperties

getProperties( ) → java.util.Map

### Returns:

java.util.Map
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getRawProperties

getRawProperties( ) → java.util.Map

### Returns:

java.util.Map
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getTimeSeriesBrowseController

getTimeSeriesBrowseController( ) → org.autoplot.dom.TimeSeriesBrowseController

### Returns:

org.autoplot.dom.TimeSeriesBrowseController
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getTsb

getTsb( ) → org.autoplot.datasource.capability.TimeSeriesBrowse

### Returns:

org.autoplot.datasource.capability.TimeSeriesBrowse
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getTsbSuri

getTsbSuri( ) → String

### Returns:

java.lang.String
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## isDataSetNeedsLoading

isDataSetNeedsLoading( ) → boolean

### Returns:

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

## isPendingChanges

isPendingChanges( ) → boolean

### Returns:

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

## isResetDimensions

isResetDimensions( ) → boolean

### Returns:

boolean
[search for examples] [view on GitHub] [view on old javadoc] [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

isUriNeedsResolution( ) → boolean

### Returns:

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

## pendingChanges

pendingChanges( java.util.Map changes ) → void

### Parameters

changes - a java.util.Map

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [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

setCaching( org.autoplot.datasource.capability.Caching caching ) → void

### Parameters

caching - a Caching

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [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:

- autoplot is displaying any dataset.
- A new DataSource has been set, but the dataset is generally not from the DataSource.

postconditions:

- the dataset is set
- labels are set, axes are set.
- Labels reset might have triggered a timer that will redo layout.
- slice dimensions are set for dataset.

### 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

setDataSetNeedsLoading( boolean dataSetNeedsLoading ) → void

### Parameters

dataSetNeedsLoading - a boolean

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## setDataSource

setDataSource( org.autoplot.datasource.DataSource dataSource ) → void

### Parameters

dataSource - a DataSource

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## setException

setException( java.lang.Exception exception ) → void

### Parameters

exception - an Exception

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## setFillDataSet

setFillDataSet( QDataSet fillDataSet ) → void

### Parameters

fillDataSet - a QDataSet

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## setFillProperties

setFillProperties( java.util.Map fillProperties ) → void

### Parameters

fillProperties - a java.util.Map

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## setHistogram

Deprecated: this function will be removed and put into the metadata tab.

## setProperties

setProperties( java.util.Map properties ) → void

### Parameters

properties - a java.util.Map

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## setRawProperties

setRawProperties( java.util.Map rawProperties ) → void

### Parameters

rawProperties - a java.util.Map

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## setResetDimensions

setResetDimensions( boolean resetDimensions ) → void

### Parameters

resetDimensions - a boolean

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [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

setTsb( org.autoplot.datasource.capability.TimeSeriesBrowse tsb ) → void

### Parameters

tsb - a TimeSeriesBrowse

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## setTsbSuri

setTsbSuri( String tsbSuri ) → void

### Parameters

tsbSuri - a String

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## setUriNeedsResolution

setUriNeedsResolution( boolean uriNeedsResolution ) → void

### Parameters

uriNeedsResolution - a boolean

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## toString

toString( ) → String

### Returns:

java.lang.String
[search for examples] [view on GitHub] [view on old javadoc] [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]