<h2>org.das2.dataset.DataSetDescriptor</h2><p>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. <p>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} </p> <p>The protocol of the string indicates how the DataSetDescriptor is to be constructed, and presently there are: <pre> 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 </pre></p> <hr> <a name="addDataSetUpdateListener"></a> <h2>addDataSetUpdateListener</h2> addDataSetUpdateListener( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/dataset/DataSetUpdateListener.html'>org.das2.dataset.DataSetUpdateListener</a> listener ) → void <p></p> <h3>Parameters</h3> listener - a DataSetUpdateListener <h3>Returns:</h3> void (returns nothing) <br><br> <a href="https://github.com/autoplot/dev/search?q=addDataSetUpdateListener&unscoped_q=addDataSetUpdateListener">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/dataset/DataSetDescriptor.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/dataset/DataSetDescriptor.html#addDataSetUpdateListener">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/dataset/DataSetDescriptor.java">[view source]</a> <br> <br> <hr> <a name="create"></a> <h2>create</h2> create( <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> dataSetID ) → <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/dataset/DataSetDescriptor.html'>org.das2.dataset.DataSetDescriptor</a> <p>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: <pre> 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 ) </pre> Note that DataSetDescriptors are stateless, the same DataSetDescriptor object may be returned to multiple clients.</p> <h3>Parameters</h3> dataSetID - the URL-like identifier. <h3>Returns:</h3> the DataSetDescriptor for the id. <br><br> <a href="https://github.com/autoplot/dev/search?q=create&unscoped_q=create">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/dataset/DataSetDescriptor.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/dataset/DataSetDescriptor.html#create">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/dataset/DataSetDescriptor.java">[view source]</a> <br> <br> <hr> <a name="drawListIcon"></a> <h2>drawListIcon</h2> drawListIcon( <a href='https://docs.oracle.com/javase/8/docs/api/java/awt/Graphics2D.html'>java.awt.Graphics2D</a> g, int x, int y ) → void <p></p> <h3>Parameters</h3> g - a Graphics2D <br> x - an int <br> y - an int <h3>Returns:</h3> void (returns nothing) <br><br> <a href="https://github.com/autoplot/dev/search?q=drawListIcon&unscoped_q=drawListIcon">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/dataset/DataSetDescriptor.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/dataset/DataSetDescriptor.html#drawListIcon">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/dataset/DataSetDescriptor.java">[view source]</a> <br> <br> <hr> <a name="getDataSet"></a> <h2>getDataSet</h2> getDataSet( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Datum.html'>Datum</a> start, <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Datum.html'>Datum</a> end, <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Datum.html'>Datum</a> resolution, <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/util/monitor/ProgressMonitor.html'>ProgressMonitor</a> monitor ) → <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/dataset/DataSet.html'>org.das2.dataset.DataSet</a> <p>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.</p> <h3>Parameters</h3> start - a Datum <br> end - a Datum <br> resolution - a Datum <br> monitor - a ProgressMonitor <h3>Returns:</h3> org.das2.dataset.DataSet <br><br> <a href="https://github.com/autoplot/dev/search?q=getDataSet&unscoped_q=getDataSet">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/dataset/DataSetDescriptor.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/dataset/DataSetDescriptor.html#getDataSet">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/dataset/DataSetDescriptor.java">[view source]</a> <br> <br> <hr> <a name="getDataSetCache"></a> <h2>getDataSetCache</h2> getDataSetCache( ) → <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/dataset/DataSetCache.html'>org.das2.dataset.DataSetCache</a> <p></p> <h3>Returns:</h3> the DataSetCache object used to store cached copies of the DataSets created by this object. <br><br> <a href="https://github.com/autoplot/dev/search?q=getDataSetCache&unscoped_q=getDataSetCache">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/dataset/DataSetDescriptor.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/dataset/DataSetDescriptor.html#getDataSetCache">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/dataset/DataSetDescriptor.java">[view source]</a> <br> <br> <hr> <a name="getDataSetID"></a> <h2>getDataSetID</h2> getDataSetID( ) → <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> <p></p> <h3>Returns:</h3> the string that uniquely identifies this dataset. <br><br> <a href="https://github.com/autoplot/dev/search?q=getDataSetID&unscoped_q=getDataSetID">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/dataset/DataSetDescriptor.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/dataset/DataSetDescriptor.html#getDataSetID">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/dataset/DataSetDescriptor.java">[view source]</a> <br> <br> <hr> <a name="getListIcon"></a> <h2>getListIcon</h2> getListIcon( ) → <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/javax/swing/Icon.html'>javax.swing.Icon</a> <p></p> <h3>Returns:</h3> javax.swing.Icon <br><br> <a href="https://github.com/autoplot/dev/search?q=getListIcon&unscoped_q=getListIcon">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/dataset/DataSetDescriptor.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/dataset/DataSetDescriptor.html#getListIcon">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/dataset/DataSetDescriptor.java">[view source]</a> <br> <br> <hr> <a name="getListLabel"></a> <h2>getListLabel</h2> getListLabel( ) → <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> <p></p> <h3>Returns:</h3> java.lang.String <br><br> <a href="https://github.com/autoplot/dev/search?q=getListLabel&unscoped_q=getListLabel">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/dataset/DataSetDescriptor.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/dataset/DataSetDescriptor.html#getListLabel">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/dataset/DataSetDescriptor.java">[view source]</a> <br> <br> <hr> <a name="getProperty"></a> <h2>getProperty</h2> getProperty( <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> name ) → <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html'>Object</a> <p>Returns the value of the property with the specified name</p> <h3>Parameters</h3> name - The name of the property requested <h3>Returns:</h3> The value of the requested property as an Object <br><br> <a href="https://github.com/autoplot/dev/search?q=getProperty&unscoped_q=getProperty">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/dataset/DataSetDescriptor.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/dataset/DataSetDescriptor.html#getProperty">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/dataset/DataSetDescriptor.java">[view source]</a> <br> <br> <hr> <a name="getXUnits"></a> <h2>getXUnits</h2> getXUnits( ) → <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Units.html'>Units</a> <p></p> <h3>Returns:</h3> the x units of the DataSetDescriptor that parameterize the data. This is used to identify dataSet requests. <br><br> <a href="https://github.com/autoplot/dev/search?q=getXUnits&unscoped_q=getXUnits">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/dataset/DataSetDescriptor.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/dataset/DataSetDescriptor.html#getXUnits">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/dataset/DataSetDescriptor.java">[view source]</a> <br> <br> <hr> <a name="removeDataSetUpdateListener"></a> <h2>removeDataSetUpdateListener</h2> removeDataSetUpdateListener( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/dataset/DataSetUpdateListener.html'>org.das2.dataset.DataSetUpdateListener</a> listener ) → void <p></p> <h3>Parameters</h3> listener - a DataSetUpdateListener <h3>Returns:</h3> void (returns nothing) <br><br> <a href="https://github.com/autoplot/dev/search?q=removeDataSetUpdateListener&unscoped_q=removeDataSetUpdateListener">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/dataset/DataSetDescriptor.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/dataset/DataSetDescriptor.html#removeDataSetUpdateListener">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/dataset/DataSetDescriptor.java">[view source]</a> <br> <br> <hr> <a name="requestDataSet"></a> <h2>requestDataSet</h2> requestDataSet( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Datum.html'>Datum</a> start, <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Datum.html'>Datum</a> end, <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Datum.html'>Datum</a> resolution, <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/util/monitor/ProgressMonitor.html'>ProgressMonitor</a> monitor, <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html'>Object</a> lockObject ) → void <p>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.</p> <h3>Parameters</h3> start - a Datum <br> end - a Datum <br> resolution - a Datum <br> monitor - a ProgressMonitor <br> lockObject - an Object <h3>Returns:</h3> void (returns nothing) <br><br> <a href="https://github.com/autoplot/dev/search?q=requestDataSet&unscoped_q=requestDataSet">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/dataset/DataSetDescriptor.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/dataset/DataSetDescriptor.html#requestDataSet">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/dataset/DataSetDescriptor.java">[view source]</a> <br> <br> requestDataSet( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Datum.html'>Datum</a> start, <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Datum.html'>Datum</a> end, <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Datum.html'>Datum</a> resolution, <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/util/monitor/ProgressMonitor.html'>ProgressMonitor</a> monitor, <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html'>Object</a> lockObject, <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/dataset/DataSetUpdateListener.html'>org.das2.dataset.DataSetUpdateListener</a> listener ) → void<br> <hr> <a name="reset"></a> <h2>reset</h2> reset( ) → void <p>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.</p> <h3>Returns:</h3> void (returns nothing) <br><br> <a href="https://github.com/autoplot/dev/search?q=reset&unscoped_q=reset">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/dataset/DataSetDescriptor.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/dataset/DataSetDescriptor.html#reset">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/dataset/DataSetDescriptor.java">[view source]</a> <br> <br> <hr> <a name="setDefaultCaching"></a> <h2>setDefaultCaching</h2> setDefaultCaching( boolean value ) → void <p>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.</p> <h3>Parameters</h3> value - a boolean <h3>Returns:</h3> void (returns nothing) <br><br> <a href="https://github.com/autoplot/dev/search?q=setDefaultCaching&unscoped_q=setDefaultCaching">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/dataset/DataSetDescriptor.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/dataset/DataSetDescriptor.html#setDefaultCaching">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/dataset/DataSetDescriptor.java">[view source]</a> <br> <br>