org.jlab.coda.eventViewer

Class cMsgHandler

java.lang.Object

org.jlab.coda.eventViewer.cMsgHandler

public class cMsgHandler
extends java.lang.Object

This class handles all cMsg communications using a singleton pattern. It is expecting each message to contain bytes corresponding to an evio event in the byteArray field. It also looks for an xml format dictionary in a String payload item called "dictionary" (case sensitive). The endianness of the byte array is set in cMsg by the setByteArrayEndian method and, of course, must be set by the sender.

Author:

timmer Oct 19, 2009

Constructor Summary

Constructors

Constructor and Description
cMsgHandler()

Method Summary

Modifier and Type	Method and Description
void	addEvent(org.jlab.coda.jevio.EvioEvent event) Add the given event to the event list.
void	clearList() Clear the entire event list - all events.
void	clearList(int numberToDelete) Clear the specified number of latest events from the list.
void	connect(java.lang.String udl) Connect to the specified cmsg server.
javax.swing.JPanel	createCmsgPanel() Create the panel/menuitem used to handle communications with a cmsg server.
void	disconnect() Disconnect from the cMsg server if any connection exists.
int	getCurrentEventIndex() Get the index of the current event (starting at 0).
org.jlab.coda.hipo.CompressionType	getDataCompressionType() Get the compression type of data being viewed.
org.jlab.coda.jevio.EvioEvent	getEvent(int index) Get the specified event, index beginning at 1.
Filter	getEventFilter() Get the event filter to use on each event before adding to list.
int	getEvioVersion() Get the evio version of data being viewed.
int	getListLimit() Get the maximum number of events that the list will hold.
int	getListSize() Get the size of the event list.
org.jlab.coda.jevio.EvioEvent	getNextEvent() Get the next evio event from the list or null if none.
org.jlab.coda.jevio.EvioEvent	getPrevEvent() Get the previous evio event from the list or null if none.
java.lang.String	getSubject() Get current subscription's subject.
java.lang.String	getType() Get current subscription's type.
boolean	hasNextEvent() Is there another evio event, after the one previously obtained, in the list?
void	resetCurrentEventIndex() Reset the index of the current event to -1.
void	setEventFilter(Filter eventFilter) Set the event filter to use on each event before adding to list.
void	setEventNum(int eventNum) Set the event number.
void	setListLimit(int limit) Set the maximum number of events that the list will hold.
boolean	subscribe(java.lang.String subject, java.lang.String type) Subscribe to the given subject and type.

Methods inherited from class java.lang.Object

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

Constructor Detail

cMsgHandler

public cMsgHandler()

Method Detail

getEvioVersion

public int getEvioVersion()

Get the evio version of data being viewed.

Returns:

evio version of data being viewed.

getDataCompressionType

public org.jlab.coda.hipo.CompressionType getDataCompressionType()

Get the compression type of data being viewed.

Returns:

compression type of data being viewed.

getEventFilter

public Filter getEventFilter()

Get the event filter to use on each event before adding to list.

Returns:

the event filter to use on each event before adding to list.

setEventFilter

public void setEventFilter(Filter eventFilter)

Set the event filter to use on each event before adding to list.

Parameters:

eventFilter - filter to use on each event before adding to list.

getSubject

public java.lang.String getSubject()

Get current subscription's subject.

Returns:

current subscription's subject.

getType

public java.lang.String getType()

Get current subscription's type.

Returns:

current subscription's type.

disconnect

public void disconnect()

Disconnect from the cMsg server if any connection exists.

connect

public void connect(java.lang.String udl)
             throws org.jlab.coda.cMsg.cMsgException

Connect to the specified cmsg server.

Parameters:

udl - UDL used to specify a cmsg server to connect to

Throws:

org.jlab.coda.cMsg.cMsgException - if connection cannot be made

subscribe

public boolean subscribe(java.lang.String subject,
                         java.lang.String type)
                  throws org.jlab.coda.cMsg.cMsgException

Subscribe to the given subject and type. If no connection to a cMsg server exists, nothing is done. If an identical subscription already exists nothing is done. If an older subscription exists, it is replaced by the new one.

Parameters:

subject - subject to subscribe to.

type - type to subscribe to.

Returns:

true if the subscription exists or was made, else false.

Throws:

org.jlab.coda.cMsg.cMsgException - if subscription fails

addEvent

public void addEvent(org.jlab.coda.jevio.EvioEvent event)

Add the given event to the event list. If the list is full, nothing is added. If the event does not make it past the filter, nothing is added.

Parameters:

event - Evio event to add to event list.

getEvent

public org.jlab.coda.jevio.EvioEvent getEvent(int index)

Get the specified event, index beginning at 1.

Parameters:

index - index into event list beginning at 1.

Returns:

EvioEvent object at given index in event list; or null if no object at that index

getNextEvent

public org.jlab.coda.jevio.EvioEvent getNextEvent()

Get the next evio event from the list or null if none.

Returns:

next evio event from the list or null if none.

hasNextEvent

public boolean hasNextEvent()

Is there another evio event, after the one previously obtained, in the list?

Returns:

true if there is an event, after the one previously obtained, in the list, else false.

getPrevEvent

public org.jlab.coda.jevio.EvioEvent getPrevEvent()

Get the previous evio event from the list or null if none.

Returns:

previous evio event from the list or null if none.

getListSize

public int getListSize()

Get the size of the event list.

Returns:

size of the event list.

getCurrentEventIndex

public int getCurrentEventIndex()

Get the index of the current event (starting at 0). Used to determine what is next and what is previous.

Returns:

index of the current event (starting at 0).

resetCurrentEventIndex

public void resetCurrentEventIndex()

Reset the index of the current event to -1. Used to determine what is next and what is previous.

setEventNum

public void setEventNum(int eventNum)

Set the event number. Newly added events have numbers starting with the given value.

Parameters:

eventNum - newly added events have numbers starting with this value

clearList

public void clearList()

Clear the entire event list - all events.

clearList

public void clearList(int numberToDelete)

Clear the specified number of latest events from the list.

Parameters:

numberToDelete - number of latest events to delete from the list.

getListLimit

public int getListLimit()

Get the maximum number of events that the list will hold.

Returns:

maximum number of events that the list will hold.

setListLimit

public void setListLimit(int limit)

Set the maximum number of events that the list will hold. Does nothing if limit < 1. Will set it to a max of 1000. If reducing the size of the current limit, it will clear any events beyond the new limit.

Parameters:

limit - maximum number of events that the list will hold.

createCmsgPanel

public javax.swing.JPanel createCmsgPanel()

Create the panel/menuitem used to handle communications with a cmsg server.

Returns:

the panel/menuitem used to handle communications with a cmsg server.