## org.das2.dataset.DataSetDescriptor

DataSetDescriptors are a source from where datasets are produced. These uniquely identify a data set that is parameteric. Typically, the parameter is time, so for example, there might be a DataSetDescriptor for "discharge of the Iowa River measured at Iowa City." Clients of the class get DataSets from the DataSetDescriptor via the getDataSet( Start, End, Resolution ) method. So for example, you might ask what is the discharge from June 1 to August 31st, 2005, at a resolution of 1 day. Presently, it's implicit that this means to give bin averages of the data.

DataSetDescriptors are identified with a URL-like string: {@code http://www-pw.physics.uiowa.edu/das/das2Server?das2_1/cluster/wbd/r_wbd_dsn_cfd&spacecraft%3Dc1%26antenna%3DEy}

The protocol of the string indicates how the DataSetDescriptor is to be constructed, and presently there are:

       http     a das2Server provides the specification of the datasetdescriptor.
       class    refers to a loadable java class that is an instanceof DataSetDescriptor and
                has the method newDataSetDescriptor( Map params ) throws DasException

## addDataSetUpdateListener

addDataSetUpdateListener( org.das2.dataset.DataSetUpdateListener listener ) → void

### Parameters

listener - a DataSetUpdateListener

### Returns:

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

## create

create( String dataSetID ) → org.das2.dataset.DataSetDescriptor

creates a DataSetDescriptor for the given identification string. The identification string is a URL-like string, for example http://www-pw.physics.uiowa.edu/das/das2Server?das2_1/cluster/wbd/r_wbd_dsn_cfd&spacecraft%3Dc1%26antenna%3DEy The protocol of the string indicates how the DataSetDescriptor is to be constructed, and presently there are:

       http     a das2Server provides the specification of the DataSetDescriptor, and a
                StreamDataSetDescriptor is created.
       class    refers to a loadable java class that is an instanceof DataSetDescriptor and
                has the method newDataSetDescriptor( Map params )

Note that DataSetDescriptors are stateless, the same DataSetDescriptor object may be returned to multiple clients.

### Parameters

dataSetID - the URL-like identifier.

### Returns:

the DataSetDescriptor for the id.
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## drawListIcon

drawListIcon( java.awt.Graphics2D g, int x, int y ) → void

### Parameters

g - a Graphics2D
x - an int
y - an int

### Returns:

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

## getDataSet

getDataSet( Datum start, Datum end, Datum resolution, ProgressMonitor monitor ) → org.das2.dataset.DataSet

Retrieve the dataset for this interval and resolution. The contract for this function is that identical start,end,resolution parameters will yield an identical dataSet, except for when an DataSetUpdate has been fired in the meantime. null for the data resolution indicates that the data should be returned at its "intrinsic resolution" if such a resolution exists.

### Parameters

start - a Datum
end - a Datum
resolution - a Datum
monitor - a ProgressMonitor

### Returns:

org.das2.dataset.DataSet
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getDataSetCache

getDataSetCache( ) → org.das2.dataset.DataSetCache

### Returns:

the DataSetCache object used to store cached copies of the DataSets created by this object.
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getDataSetID

getDataSetID( ) → String

### Returns:

the string that uniquely identifies this dataset.
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getListIcon

getListIcon( ) → javax.swing.Icon

### Returns:

javax.swing.Icon
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getListLabel

getListLabel( ) → String

### Returns:

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

## getProperty

getProperty( String name ) → Object

Returns the value of the property with the specified name

### Parameters

name - The name of the property requested

### Returns:

The value of the requested property as an Object
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getXUnits

getXUnits( ) → Units

### Returns:

the x units of the DataSetDescriptor that parameterize the data. This is used to identify dataSet requests.
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## removeDataSetUpdateListener

removeDataSetUpdateListener( org.das2.dataset.DataSetUpdateListener listener ) → void

### Parameters

listener - a DataSetUpdateListener

### Returns:

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

## requestDataSet

requestDataSet( Datum start, Datum end, Datum resolution, ProgressMonitor monitor, Object lockObject ) → void

Requests that a dataSet be loaded, and that the dataSet be returned via a DataSetUpdate event. The @param lockObject is an object that is dependent on the load, for example, the DasCanvas, and will be passed in to the request processor. If the dataSet is available in interactive time, then the dataSetUpdate may be fired on the same thread as the request is made.

### Parameters

start - a Datum
end - a Datum
resolution - a Datum
monitor - a ProgressMonitor
lockObject - an Object

### Returns:

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

## requestDataSet

requestDataSet( Datum start, Datum end, Datum resolution, ProgressMonitor monitor, Object lockObject, org.das2.dataset.DataSetUpdateListener listener ) → void

Request the dataset, and the dataset is returned only to the listener.

### Parameters

start - a Datum
end - a Datum
resolution - a Datum
monitor - a ProgressMonitor
lockObject - object that is waiting for the result of this load, used to block other tasks which use that object.
listener - a DataSetUpdateListener

### Returns:

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

## reset

reset( ) → void

clear any state that's developed, in particular any data caches. Note this currently deletes all cached datasets, regardless of the DataSetDescriptor that produced them.

### Returns:

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

## setDefaultCaching

setDefaultCaching( boolean value ) → void

defaultCaching means that the abstract DataSetDescriptor is allowed to handle repeat getDataSet calls by returning a cached dataset. If a dataSetUpdate event is thrown, the defaultCache is reset. Use caution when using this. Note that caching may only be turned off with this call.

### Parameters

value - a boolean

### Returns:

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