<h2>org.das2.qstream.QDataSetStreamHandler</h2><p>reads a stream and produces QDataSets representing the data found on the stream. The stream is read in, and
 then getDataSet or getDataSet(name) is called to retrieve datasets.</p>
<h2>QDataSetStreamHandler( )</h2>
<p></p>

<hr>
<a name="BUILDER_JOIN_CHILDREN"></a>
<h2>BUILDER_JOIN_CHILDREN</h2>
<p></p>

<hr>
<a name="flattenJoin"></a>
<h2>flattenJoin</h2>
flattenJoin( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/qds/QDataSet.html'>QDataSet</a> ds ) &rarr; <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/qds/MutablePropertyDataSet.html'>org.das2.qds.MutablePropertyDataSet</a>

<p>since an appended series of rank 1 datasets will return as a rank 2 join, this utility provides a
 standard place to flatten it. This will also flatten DEPENDNAME_0.</p>

<h3>Parameters</h3>
ds - rank 2 or 3 join dataset.

<h3>Returns:</h3>
rank 1 or 2 dataset.
<br><br>
<a href="https://github.com/autoplot/dev/search?q=flattenJoin&unscoped_q=flattenJoin">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/qstream/QDataSetStreamHandler.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/qstream/QDataSetStreamHandler.html#flattenJoin">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/qstream/QDataSetStreamHandler.java">[view source]</a>
<br>
<br>
<hr>
<a name="getDataSet"></a>
<h2>getDataSet</h2>
getDataSet( <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> name ) &rarr; <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/qds/QDataSet.html'>QDataSet</a>

<p>return the dataset from the stream.</p>

<h3>Parameters</h3>
name - the name of the dataset to retrieve.

<h3>Returns:</h3>
the 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/qstream/QDataSetStreamHandler.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/qstream/QDataSetStreamHandler.html#getDataSet">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/qstream/QDataSetStreamHandler.java">[view source]</a>
<br>
<br>
getDataSet(  ) &rarr; <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/qds/QDataSet.html'>QDataSet</a><br>
<hr>
<a name="getDataSetNames"></a>
<h2>getDataSetNames</h2>
getDataSetNames(  ) &rarr; <a href='https://docs.oracle.com/javase/8/docs/api/java/util/List.html'>java.util.List</a>

<p>return a list of available datasets</p>

<h3>Returns:</h3>
a java.util.List

<br><br>
<a href="https://github.com/autoplot/dev/search?q=getDataSetNames&unscoped_q=getDataSetNames">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/qstream/QDataSetStreamHandler.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/qstream/QDataSetStreamHandler.html#getDataSetNames">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/qstream/QDataSetStreamHandler.java">[view source]</a>
<br>
<br>
<hr>
<a name="getDataSetNamesAndDescriptions"></a>
<h2>getDataSetNamesAndDescriptions</h2>
getDataSetNamesAndDescriptions(  ) &rarr; <a href='https://docs.oracle.com/javase/8/docs/api/java/util/Map.html'>java.util.Map</a>

<p>return a list of available datasets and their label (or name if not available).</p>

<h3>Returns:</h3>
a java.util.Map

<br><br>
<a href="https://github.com/autoplot/dev/search?q=getDataSetNamesAndDescriptions&unscoped_q=getDataSetNamesAndDescriptions">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/qstream/QDataSetStreamHandler.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/qstream/QDataSetStreamHandler.html#getDataSetNamesAndDescriptions">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/qstream/QDataSetStreamHandler.java">[view source]</a>
<br>
<br>
<hr>
<a name="getReadPackets"></a>
<h2>getReadPackets</h2>
getReadPackets(  ) &rarr; boolean

<p>if true, then packets are interpreted.</p>

<h3>Returns:</h3>
a boolean

<br><br>
<a href="https://github.com/autoplot/dev/search?q=getReadPackets&unscoped_q=getReadPackets">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/qstream/QDataSetStreamHandler.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/qstream/QDataSetStreamHandler.html#getReadPackets">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/qstream/QDataSetStreamHandler.java">[view source]</a>
<br>
<br>
<hr>
<a name="isFlattenableJoin"></a>
<h2>isFlattenableJoin</h2>
isFlattenableJoin( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/qds/QDataSet.html'>QDataSet</a> ds ) &rarr; boolean

<p>If the dataset is a join of appendable datasets, then we can append them to reduce the rank by 1 and
 make one long time series. These datasets should be equivalent, however most of the system doesn't
 implement this (and probably never will). So this is a bit of a kludge, where I don't want to flatten a
 dataset automatically, but we probably want to.</p>

<h3>Parameters</h3>
ds - a join dataset of rank 2 or rank 3.

<h3>Returns:</h3>
true if the data can be joined.
<br><br>
<a href="https://github.com/autoplot/dev/search?q=isFlattenableJoin&unscoped_q=isFlattenableJoin">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/qstream/QDataSetStreamHandler.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/qstream/QDataSetStreamHandler.html#isFlattenableJoin">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/qstream/QDataSetStreamHandler.java">[view source]</a>
<br>
<br>
<hr>
<a name="packet"></a>
<h2>packet</h2>
packet( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/qstream/PacketDescriptor.html'>org.das2.qstream.PacketDescriptor</a> pd, <a href='https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html'>java.nio.ByteBuffer</a> data ) &rarr; void

<p></p>

<h3>Parameters</h3>
pd - a PacketDescriptor
<br>
data - a ByteBuffer

<h3>Returns:</h3>
void (returns nothing)

<br><br>
<a href="https://github.com/autoplot/dev/search?q=packet&unscoped_q=packet">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/qstream/QDataSetStreamHandler.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/qstream/QDataSetStreamHandler.html#packet">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/qstream/QDataSetStreamHandler.java">[view source]</a>
<br>
<br>
<hr>
<a name="packetDescriptor"></a>
<h2>packetDescriptor</h2>
packetDescriptor( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/qstream/PacketDescriptor.html'>org.das2.qstream.PacketDescriptor</a> pd ) &rarr; void

<p></p>

<h3>Parameters</h3>
pd - a PacketDescriptor

<h3>Returns:</h3>
void (returns nothing)

<br><br>
<a href="https://github.com/autoplot/dev/search?q=packetDescriptor&unscoped_q=packetDescriptor">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/qstream/QDataSetStreamHandler.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/qstream/QDataSetStreamHandler.html#packetDescriptor">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/qstream/QDataSetStreamHandler.java">[view source]</a>
<br>
<br>
<hr>
<a name="setReadPackets"></a>
<h2>setReadPackets</h2>
setReadPackets( boolean val ) &rarr; void

<p>set this is false if you just want to look at the empty dataset metadata.</p>

<h3>Parameters</h3>
val - a boolean

<h3>Returns:</h3>
void (returns nothing)

<br><br>
<a href="https://github.com/autoplot/dev/search?q=setReadPackets&unscoped_q=setReadPackets">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/qstream/QDataSetStreamHandler.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/qstream/QDataSetStreamHandler.html#setReadPackets">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/qstream/QDataSetStreamHandler.java">[view source]</a>
<br>
<br>
<hr>
<a name="streamClosed"></a>
<h2>streamClosed</h2>
streamClosed( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/qstream/StreamDescriptor.html'>org.das2.qstream.StreamDescriptor</a> sd ) &rarr; void

<p></p>

<h3>Parameters</h3>
sd - a StreamDescriptor

<h3>Returns:</h3>
void (returns nothing)

<br><br>
<a href="https://github.com/autoplot/dev/search?q=streamClosed&unscoped_q=streamClosed">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/qstream/QDataSetStreamHandler.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/qstream/QDataSetStreamHandler.html#streamClosed">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/qstream/QDataSetStreamHandler.java">[view source]</a>
<br>
<br>
<hr>
<a name="streamComment"></a>
<h2>streamComment</h2>
streamComment( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/qstream/StreamComment.html'>org.das2.qstream.StreamComment</a> se ) &rarr; void

<p></p>

<h3>Parameters</h3>
se - a StreamComment

<h3>Returns:</h3>
void (returns nothing)

<br><br>
<a href="https://github.com/autoplot/dev/search?q=streamComment&unscoped_q=streamComment">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/qstream/QDataSetStreamHandler.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/qstream/QDataSetStreamHandler.html#streamComment">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/qstream/QDataSetStreamHandler.java">[view source]</a>
<br>
<br>
<hr>
<a name="streamDescriptor"></a>
<h2>streamDescriptor</h2>
streamDescriptor( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/qstream/StreamDescriptor.html'>org.das2.qstream.StreamDescriptor</a> sd ) &rarr; void

<p></p>

<h3>Parameters</h3>
sd - a StreamDescriptor

<h3>Returns:</h3>
void (returns nothing)

<br><br>
<a href="https://github.com/autoplot/dev/search?q=streamDescriptor&unscoped_q=streamDescriptor">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/qstream/QDataSetStreamHandler.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/qstream/QDataSetStreamHandler.html#streamDescriptor">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/qstream/QDataSetStreamHandler.java">[view source]</a>
<br>
<br>
<hr>
<a name="streamException"></a>
<h2>streamException</h2>
streamException( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/qstream/StreamException.html'>org.das2.qstream.StreamException</a> se ) &rarr; void

<p></p>

<h3>Parameters</h3>
se - a StreamException

<h3>Returns:</h3>
void (returns nothing)

<br><br>
<a href="https://github.com/autoplot/dev/search?q=streamException&unscoped_q=streamException">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/qstream/QDataSetStreamHandler.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/qstream/QDataSetStreamHandler.html#streamException">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/qstream/QDataSetStreamHandler.java">[view source]</a>
<br>
<br>