org.das2.qstream

Class SerialStreamFormatter

java.lang.Object

org.das2.qstream.SerialStreamFormatter

public class SerialStreamFormatter
extends java.lang.Object

We need a class that can format a stream serially. SimpleStreamFormatter needs the whole dataset, which really misses the point with QStreams, that you can process and create data streams serially on the server side. The das2stream codes were first coded with this use case, but QStreams were not and because of this a good serial generator was never created. See the main method for an example of how this is used. Note this class is not thread-safe and assumes that only one thread will be working on the stream. This may change.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	asciiTypes
protected boolean	bigEndian
static int	DEFAULT_TIME_DIGITS
static java.lang.String	INOUTFORM_INLINE
static java.lang.String	INOUTFORM_ONE_RECORD
static java.lang.String	INOUTFORM_STREAMING

Constructor Summary

Constructors

Constructor and Description
SerialStreamFormatter()

Method Summary

Modifier and Type	Method and Description
protected StreamDescriptor	doStreamDescriptor(java.lang.String name) send out the streamDescriptor, which contains just the name of the stream's default dataset.
void	format(java.lang.String name, QDataSet ds1, java.lang.String inoutForm) format the dataset which is part of a join dataset.
void	format(java.lang.String joinName, java.lang.String name, QDataSet ds1, java.lang.String inoutForm) format the dataset, maybe sending a descriptor if it hasn't been sent already.
void	init(java.lang.String name, StreamHandler sh) initialize, sending data directly via the StreamHandler interface.
void	init(java.lang.String name, java.nio.channels.WritableByteChannel out) the name of the default dataset.
boolean	isAsciiTypes()
boolean	isBigEndian()
void	join(java.lang.String name, int rank, java.util.Map<java.lang.String,java.lang.Object> props)
static void	main(java.lang.String[] args)
void	maybeFormat(java.lang.String name, QDataSet ds1, java.lang.String inoutForm) format the dataset, maybe sending a descriptor if it hasn't been sent already.
void	retire(java.lang.String name) allow the stream to recycle the name.
void	setAsciiTypes(boolean asciiTypes)
void	setBigEndian(boolean bigEndian)
void	setTransferType(java.lang.String name, TransferType tt) explicitly set the transfer type.
void	setUnitTransferType(Units u, TransferType tt) explicitly set the transfer type used to transfer data that is convertible to this unit.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TIME_DIGITS

public static final int DEFAULT_TIME_DIGITS

See Also:

Constant Field Values

INOUTFORM_INLINE

public static final java.lang.String INOUTFORM_INLINE

See Also:

Constant Field Values

INOUTFORM_ONE_RECORD

public static final java.lang.String INOUTFORM_ONE_RECORD

See Also:

Constant Field Values

INOUTFORM_STREAMING

public static final java.lang.String INOUTFORM_STREAMING

See Also:

Constant Field Values

asciiTypes

protected boolean asciiTypes

bigEndian

protected boolean bigEndian

Constructor Detail

SerialStreamFormatter

public SerialStreamFormatter()

Method Detail

isAsciiTypes

public boolean isAsciiTypes()

setAsciiTypes

public void setAsciiTypes(boolean asciiTypes)

isBigEndian

public boolean isBigEndian()

setBigEndian

public void setBigEndian(boolean bigEndian)

doStreamDescriptor

protected StreamDescriptor doStreamDescriptor(java.lang.String name)

send out the streamDescriptor, which contains just the name of the stream's default dataset.

Parameters:

name -

init

public void init(java.lang.String name,
                 java.nio.channels.WritableByteChannel out)
          throws java.io.IOException,
                 StreamException

the name of the default dataset.

Parameters:

name -

Throws:

java.io.IOException

StreamException

init

public void init(java.lang.String name,
                 StreamHandler sh)
          throws java.io.IOException,
                 StreamException

initialize, sending data directly via the StreamHandler interface. This avoids parsing and formatting the XML.

Parameters:

name - the name of the default dataset.

Throws:

java.io.IOException

StreamException

setUnitTransferType

public void setUnitTransferType(Units u,
                                TransferType tt)

explicitly set the transfer type used to transfer data that is convertible to this unit.

Parameters:

name -

tt -

setTransferType

public void setTransferType(java.lang.String name,
                            TransferType tt)

explicitly set the transfer type.

Parameters:

name -

tt -

maybeFormat

public void maybeFormat(java.lang.String name,
                        QDataSet ds1,
                        java.lang.String inoutForm)
                 throws java.io.IOException,
                        StreamException

format the dataset, maybe sending a descriptor if it hasn't been sent already. ds1 may be null in this function, in which case nothing needs to be done.

Parameters:

name - the name for the dataset of which ds1 is all or a slice of, or null.

ds1 -

inline -

Throws:

java.io.IOException

StreamException

format

public void format(java.lang.String joinName,
                   java.lang.String name,
                   QDataSet ds1,
                   java.lang.String inoutForm)
            throws java.io.IOException,
                   StreamException

format the dataset, maybe sending a descriptor if it hasn't been sent already.

Parameters:

joinName - the name to which we join the dataset.

name - the name for the dataset of which ds1 is all or a slice of, or null.

ds1 -

inoutForm - one of "inline", "oneRecord", or "streaming"

Throws:

java.io.IOException

StreamException

format

public void format(java.lang.String name,
                   QDataSet ds1,
                   java.lang.String inoutForm)
            throws java.io.IOException,
                   StreamException

format the dataset which is part of a join dataset.

Parameters:

name - the name for the dataset of which ds1 is all or a slice of, or null.

ds1 -

inline - if true, then the entire dataset will be present.

Throws:

java.io.IOException

StreamException

join

public void join(java.lang.String name,
                 int rank,
                 java.util.Map<java.lang.String,java.lang.Object> props)
          throws StreamException,
                 java.io.IOException

Throws:

StreamException

java.io.IOException

retire

public void retire(java.lang.String name)

allow the stream to recycle the name. new packets with this name will issue a new packetDescriptor.

Parameters:

name -

main

public static void main(java.lang.String[] args)
                 throws java.io.FileNotFoundException,
                        java.io.IOException,
                        StreamException

Throws:

java.io.FileNotFoundException

java.io.IOException

StreamException