org.das2.stream
Class StreamDescriptor

java.lang.Object
  org.das2.stream.StreamDescriptor

All Implemented Interfaces:

java.lang.Cloneable, SkeletonDescriptor

public class StreamDescriptor
extends java.lang.Object
implements SkeletonDescriptor, java.lang.Cloneable

Represents the global properties of the stream, that are accessible to datasets within.

Constructor Summary

StreamDescriptor()

StreamDescriptor(org.w3c.dom.Element element)
Creates a new instance of StreamProperties

Method Summary

void	addYMulti(StreamMultiYDescriptor y)
void	addYScan(StreamYScanDescriptor y)
java.lang.Object	clone()
static java.lang.String	createHeader(org.w3c.dom.Document document)
static StreamDescriptor	createLegacyDescriptor(java.io.BufferedReader in)
java.lang.String	getCompression() Getter for property compression.
org.w3c.dom.Element	getDOMElement(org.w3c.dom.Document document)
java.util.Map	getProperties()
java.lang.Object	getProperty(java.lang.String name)
int	getSizeBytes()
StreamXDescriptor	getXDescriptor()
java.util.List	getYDescriptors()
static org.w3c.dom.Document	parseHeader(java.io.Reader header)
DatumVector	read(java.nio.ByteBuffer input)
void	setCompression(java.lang.String compression) Setter for property compression.
void	setProperty(java.lang.String name, java.lang.Object value)
void	setXDescriptor(StreamXDescriptor x)
void	write(DatumVector input, java.nio.ByteBuffer output)

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StreamDescriptor

public StreamDescriptor(org.w3c.dom.Element element)
                 throws StreamException

Creates a new instance of StreamProperties

Throws:

StreamException

StreamDescriptor

public StreamDescriptor()

Method Detail

getXDescriptor

public StreamXDescriptor getXDescriptor()

setXDescriptor

public void setXDescriptor(StreamXDescriptor x)

addYScan

public void addYScan(StreamYScanDescriptor y)

addYMulti

public void addYMulti(StreamMultiYDescriptor y)

getYDescriptors

public java.util.List getYDescriptors()

getProperty

public java.lang.Object getProperty(java.lang.String name)

Specified by:

getProperty in interface SkeletonDescriptor

getProperties

public java.util.Map getProperties()

Specified by:

getProperties in interface SkeletonDescriptor

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)

parseHeader

public static org.w3c.dom.Document parseHeader(java.io.Reader header)
                                        throws DasIOException,
                                               DasStreamFormatException

Throws:

DasIOException

DasStreamFormatException

getSizeBytes

public int getSizeBytes()

Specified by:

getSizeBytes in interface SkeletonDescriptor

read

public DatumVector read(java.nio.ByteBuffer input)

Specified by:

read in interface SkeletonDescriptor

write

public void write(DatumVector input,
                  java.nio.ByteBuffer output)

Specified by:

write in interface SkeletonDescriptor

createLegacyDescriptor

public static StreamDescriptor createLegacyDescriptor(java.io.BufferedReader in)
                                               throws java.io.IOException

Throws:

java.io.IOException

createHeader

public static java.lang.String createHeader(org.w3c.dom.Document document)
                                     throws DasIOException

Throws:

DasIOException

getCompression

public java.lang.String getCompression()

Getter for property compression.

Returns:

Value of property compression.

setCompression

public void setCompression(java.lang.String compression)

Setter for property compression.

Parameters:

compression - New value of property compression.

getDOMElement

public org.w3c.dom.Element getDOMElement(org.w3c.dom.Document document)

Specified by:

getDOMElement in interface SkeletonDescriptor

clone

public java.lang.Object clone()

Specified by:

clone in interface SkeletonDescriptor

Overrides:

clone in class java.lang.Object