stella.rmi

Class FileDump

java.lang.Object

util.PropertyContainer

util.PropertyResources

util.rmi.RmiPropertyContainer

util.rmi.AbstractRmiListener

stella.rmi.FileDump

All Implemented Interfaces:

Cloneable, Remote, EventListener, RmiDataListener, ExitCleaning, PropertySupplying, ResourceSupplying, RmiEventListener, RmiListener, RmiPropertyBearing

public class FileDump
extends AbstractRmiListener
implements RmiDataListener

A rmi-based data listener. The data received is dumped into a ascii-file. In the basic version, the only properties used are the KEY_FILE and the KEY_BIND. The latter one points to the binding name of the remote caster. If the file key is not present it is constructed from the binding name by stripping the host information from the binding name and adding the DEFEXTENSION to it.

Nested Class Summary

Nested classes/interfaces inherited from class util.PropertyResources

PropertyResources.Load, PropertyResources.URLResource

Field Summary

Fields

Modifier and Type	Field and Description
private static String	DEFEXTENSION The default dump file name.
private BufferedWriter	dump The stream the data is writtn to.
static String	KEY_BIND The key pointing to the binding name of the rmi-data caster.
static String	KEY_FILE The key pointing to the output file.
static String	KEY_PATH The key pointing to the output dir.
private static DecimalFormat	MJD A formatter for the mjd.
private double	nan A double that replaces NaN's from the data event.
private boolean	virgin A flag indicating that the dump file is new.

Fields inherited from class util.rmi.AbstractRmiListener

KEY_ALIVE, KEY_EXPORTPORT, KEY_INIT, KEY_LISTENERNAME, KEY_RETRY, KEY_RETRYSLEEP, KEY_SHUTDOWNDELAY

Fields inherited from class util.PropertyResources

KEY_NOINITONCREATE, POSTFIX_ALPHABET, POSTFIX_BYTES, POSTFIX_DIR, POSTFIX_EXT, POSTFIX_FILE, POSTFIX_LIST, POSTFIX_MODTIME, POSTFIX_URL

Fields inherited from class util.PropertyContainer

KEY_LISTSEPARATOR, KEY_MAPKEYVALUECHAR, KEY_MAPSEPARATOR

Fields inherited from interface util.ResourceSupplying

KEY_URLRESOURCES, KEY_URLUSECONFIG, KEY_URLUSECURRENT, KEY_URLUSEHOME

Fields inherited from interface util.PropertySupplying

CONFIG, KEY_CLASS

Constructor Summary

Constructors

Constructor and Description
FileDump(Map prop) Constructs a new file dump instance.

Method Summary

Modifier and Type	Method and Description
protected boolean	deregisterAtCaster(RmiCaster caster, Class ignored) Deregisters at the appropriate caster.
static void	main(String[] arg) Adds the first command line argument as the binding name.
private boolean	openStream() Opens the file as a stream for writing.
protected boolean	registerAtCaster(RmiCaster caster, Class ignored) Registers at the appropriate caster.
void	rmiDataAvailable(DataEvent de) The data receiving edge.
private void	writeHead(DataEvent de) Writes some header information.

Methods inherited from class util.rmi.AbstractRmiListener

allBound, blockBinding, blockBinding, disconnect, exit, getIP, getListenerName, isConnected, listenerName, releaseBinding, releaseBinding, rescanned, startBinding, startBinding

Methods inherited from class util.rmi.RmiPropertyContainer

containsRemoteProperty, getRemoteProperties, getRemoteProperty, setRemoteProperty

Methods inherited from class util.PropertyResources

clone, createFrom, createFrom, createFrom, createInstance, getApplet, getAsResources, getLocate, getPropertiesToKey, getPropertiesToKey, getResource, getResourceAsStream, getResourceFromKey, getResources, hasLocalURLs, initProperties, keyCreate, keyCreate, reload, setApplet

Methods inherited from class util.PropertyContainer

augment, augment, augment, augment, augment, defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsEnums, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, isNew, parseObject, parseObject, reload, removeProperty, requires, setObject, setProperties, setProperty, stringProperties, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface util.rmi.RmiEventListener

getListenerName

Methods inherited from interface util.rmi.RmiListener

disconnect, isConnected

Methods inherited from interface util.PropertySupplying

defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, parseObject, removeProperty, setObject, setProperty, stringProperties

Field Detail

KEY_PATH

public static final String KEY_PATH

The key pointing to the output dir.

See Also:

Constant Field Values

KEY_FILE

public static final String KEY_FILE

The key pointing to the output file.

See Also:

Constant Field Values

KEY_BIND

public static final String KEY_BIND

The key pointing to the binding name of the rmi-data caster.

See Also:

Constant Field Values

DEFEXTENSION

private static final String DEFEXTENSION

The default dump file name.

See Also:

Constant Field Values

dump

private BufferedWriter dump

The stream the data is writtn to.

virgin

private boolean virgin

A flag indicating that the dump file is new.

nan

private double nan

A double that replaces NaN's from the data event. NaN is the default.

MJD

private static final DecimalFormat MJD

A formatter for the mjd.

Constructor Detail

FileDump

public FileDump(Map prop)
         throws IOException

Constructs a new file dump instance. If the file name is not set the default name, constructed with DEFEXTENSION is asumed.

Throws:

IllegalArgumentException - If no binding-to property is given.

IOException

Method Detail

rmiDataAvailable

public void rmiDataAvailable(DataEvent de)
                      throws RemoteException

The data receiving edge. This method should return fast, which is hopefully acieved by writing to a buffered stream.

Specified by:

rmiDataAvailable in interface RmiDataListener

Throws:

RemoteException

registerAtCaster

protected boolean registerAtCaster(RmiCaster caster,
                                   Class ignored)

Registers at the appropriate caster.

Specified by:

registerAtCaster in class AbstractRmiListener

deregisterAtCaster

protected boolean deregisterAtCaster(RmiCaster caster,
                                     Class ignored)

Deregisters at the appropriate caster.

Specified by:

deregisterAtCaster in class AbstractRmiListener

openStream

private boolean openStream()
                    throws IOException

Opens the file as a stream for writing. If the file exists it is opened in append mode. For newly created dump files the method writeHead(stella.DataEvent) is called.

To ensure proper closing of the file, a shutdown-hook is added to the system.

Returns:

True if the file was just created.

Throws:

IOException

writeHead

private void writeHead(DataEvent de)
                throws IOException

Writes some header information.

Throws:

IOException - If the stream could not be writtn.

main

public static void main(String[] arg)
                 throws IOException

Adds the first command line argument as the binding name.

Throws:

IOException