net.sourceforge.esw.service.log
Class CleanLogDatum

java.lang.Object
  |
  +--net.sourceforge.esw.service.log.CleanLogDatum

All Implemented Interfaces:

ILogDatum, java.io.Serializable

public class CleanLogDatum

extends java.lang.Object

implements ILogDatum

Describes an instance of logged data, used by an ILog instance to log data.

This wrapper / decorator cleans the data being passed to insure compatable JDBC data.

Using this interface is the perferred way to log data into an ILog instance. The allows the ILog instance to know exactly where to get all the info it needs to log data.

See Also:

ILog, Serialized Form

Field Summary

protected ILogDatum

datum

Constructor Summary

CleanLogDatum(ILogDatum aDatum)
Creates a new CleanLogDatum instance

Method Summary

java.lang.String	getApplicationID() Returns the identifier for the type of data being logged via this ILogDatum instance.
INode	getData() Returns the INote instance that represents the data to be logged via this ILogDatum instance.
long	getDatumID() Returns a unique id for this LogDatum Instance.
java.lang.String	getDescription() Returns the String description of this ILogDatum instance.
int	getRank() Returns the rank of this ILogDatum instance's data to be used to consider priority amongst more than one ILogDatum instance.
java.util.Date	getWhen() Returns when this ILogDatum instance's data was considered to have occured at for logging purposes.
java.lang.String	getWhere() Returns where this ILogDatum instance's data was considered to have occured for logging purposes.

Methods inherited from class java.lang.Object

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

Field Detail

datum

protected ILogDatum datum

Constructor Detail

CleanLogDatum

public CleanLogDatum(ILogDatum aDatum)

Creates a new CleanLogDatum instance

Parameters:

aDatum - the ILogDatum instance to wrap and clean.

Method Detail

getWhen

public java.util.Date getWhen()

Returns when this ILogDatum instance's data was considered to have occured at for logging purposes. This is the when of the logged data.

Specified by:

getWhen in interface ILogDatum

Returns:

when the datum occured

getWhere

public java.lang.String getWhere()

Returns where this ILogDatum instance's data was considered to have occured for logging purposes. This is the where of the logged data.

Specified by:

getWhere in interface ILogDatum

Returns:

where the datum occured

getRank

public int getRank()

Returns the rank of this ILogDatum instance's data to be used to consider priority amongst more than one ILogDatum instance. This is the importance of the logged data.

Specified by:

getRank in interface ILogDatum

Returns:

the priority of this datum

getDescription

public java.lang.String getDescription()

Returns the String description of this ILogDatum instance. This is the simple what of the logged data.

Specified by:

getDescription in interface ILogDatum

Returns:

the String description of this ILogDatum instance.

getData

public INode getData()

Returns the INote instance that represents the data to be logged via this ILogDatum instance. This is the complex what of the logged data.

Specified by:

getData in interface ILogDatum

Returns:

the data of this ILogDataum instance.

getApplicationID

public java.lang.String getApplicationID()

Returns the identifier for the type of data being logged via this ILogDatum instance. This is the who of the logged data.

Specified by:

getApplicationID in interface ILogDatum

Returns:

the ID of the Application logging the data.

getDatumID

public long getDatumID()

Returns a unique id for this LogDatum Instance. Unique across all VMs

Specified by:

getDatumID in interface ILogDatum

Returns:

the id of this datum