org.das2.qstream

Class StreamDescriptor

java.lang.Object

org.das2.qstream.StreamDescriptor

All Implemented Interfaces:

Descriptor

public class StreamDescriptor
extends java.lang.Object
implements Descriptor

Description of the Stream, and manages resources for the stream.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	asciiTypes stream uses just ascii format types.
protected java.nio.ByteOrder	byteOrder

Constructor Summary

Constructors

Constructor and Description
StreamDescriptor(javax.xml.parsers.DocumentBuilderFactory factory)

Method Summary

Modifier and Type	Method and Description
void	addDescriptor(Descriptor pd) add the descriptor to the stream, manually assigning it an id
void	addDescriptor(Descriptor pd, int descriptorId) add the descriptor to the stream, with the given ID.
int	descriptorId(Descriptor pd) get the id for the descriptor.
java.nio.ByteOrder	getByteOrder()
org.w3c.dom.Element	getDomElement()
boolean	hasDescriptor(Descriptor pd0, int descriptorId) If a second PacketDescriptor contains the same descriptor information, then the PacketDescriptor can be dropped.
boolean	isAsciiTypes()
org.w3c.dom.Document	newDocument(Descriptor descriptor) get the XML document that will contain the descriptor.
void	retireDescriptor(Descriptor pd) indicate that no more packets will be sent with this descriptor.
void	send(Descriptor pd, java.nio.channels.WritableByteChannel out)
void	setAsciiTypes(boolean asciiTypes)
void	setByteOrder(java.nio.ByteOrder byteOrder)
void	setDomElement(org.w3c.dom.Element element)

Methods inherited from class java.lang.Object

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

Field Detail

byteOrder

protected java.nio.ByteOrder byteOrder

asciiTypes

protected boolean asciiTypes

stream uses just ascii format types.

Constructor Detail

StreamDescriptor

public StreamDescriptor(javax.xml.parsers.DocumentBuilderFactory factory)

Method Detail

addDescriptor

public void addDescriptor(Descriptor pd)

add the descriptor to the stream, manually assigning it an id

Parameters:

pd -

hasDescriptor

public boolean hasDescriptor(Descriptor pd0,
                             int descriptorId)

If a second PacketDescriptor contains the same descriptor information, then the PacketDescriptor can be dropped. This was introduced when two daily streams appended did not create a valid stream. It has the descriptor if: * the number is the same * the planes within are the same ids.

Parameters:

pd0 -

descriptorId -

Returns:

addDescriptor

public void addDescriptor(Descriptor pd,
                          int descriptorId)

add the descriptor to the stream, with the given ID.

Parameters:

pd -

descriptorId -

descriptorId

public int descriptorId(Descriptor pd)

get the id for the descriptor. Note packetDescriptors contain the id, but this is not used.

Parameters:

pd - the packet descriptor.

Returns:

the id

Throws:

java.lang.IllegalArgumentException - when the Descriptor is not found.

retireDescriptor

public void retireDescriptor(Descriptor pd)

indicate that no more packets will be sent with this descriptor. This will free up the number so it can be reused.

Parameters:

pd - the descriptor.

send

public void send(Descriptor pd,
                 java.nio.channels.WritableByteChannel out)
          throws StreamException,
                 java.io.IOException

Throws:

StreamException

java.io.IOException

newDocument

public org.w3c.dom.Document newDocument(Descriptor descriptor)
                                 throws javax.xml.parsers.ParserConfigurationException

get the XML document that will contain the descriptor. Note that a QStream will have many XML documents, one for each descriptor. This keeps track of the documents for each descriptor.

Parameters:

descriptor - the descriptor

Returns:

the Document, which will have elements added to it.

Throws:

javax.xml.parsers.ParserConfigurationException

setDomElement

public void setDomElement(org.w3c.dom.Element element)

getDomElement

public org.w3c.dom.Element getDomElement()

Specified by:

getDomElement in interface Descriptor

getByteOrder

public java.nio.ByteOrder getByteOrder()

setByteOrder

public void setByteOrder(java.nio.ByteOrder byteOrder)

isAsciiTypes

public boolean isAsciiTypes()

setAsciiTypes

public void setAsciiTypes(boolean asciiTypes)