org.das2.qstream

Class StreamComment

java.lang.Object

org.das2.qstream.StreamComment

All Implemented Interfaces:

Descriptor

public class StreamComment
extends java.lang.Object
implements Descriptor

StreamComment allows comments to be put onto the stream. TODO: consider that comments should be sourced by the stream producer, but what about comments from filters? That is, if I'm a filter and I produce comments, should I throw out the comments I receive?

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TYPE_LOG log comments are of the form:
static java.lang.String	TYPE_TASK_PROGRESS task progress comments are either of the form:

Constructor Summary

Constructors

Constructor and Description
StreamComment(java.lang.String type, java.lang.String message)

Method Summary

Modifier and Type	Method and Description
org.w3c.dom.Element	getDomElement()
void	setMessage(java.lang.String message)
void	setType(java.lang.String type)

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_TASK_PROGRESS

public static final java.lang.String TYPE_TASK_PROGRESS

task progress comments are either of the form:

 
   [xx]000000<comment type='taskProgress' message='0 of 100'>   or
   [xx]000000<comment type='taskProgress' message='0 of -1'> for indeterminate
 
 

These are currently unimplemented!

See Also:

Constant Field Values

TYPE_LOG

public static final java.lang.String TYPE_LOG

log comments are of the form:

 
   [xx]000000<comment type='log:FINE' message='calc fine process'>   or
   [xx]000000<comment type='log:INFO' message='reading calibration'>
 
 

Note the log level should be requested by the client.

See Also:

Constant Field Values

Constructor Detail

StreamComment

public StreamComment(java.lang.String type,
                     java.lang.String message)

Method Detail

getDomElement

public org.w3c.dom.Element getDomElement()

Specified by:

getDomElement in interface Descriptor

setType

public void setType(java.lang.String type)

setMessage

public void setMessage(java.lang.String message)