com.cosylab.logging.engine.log

Interface ILogEntry

All Known Implementing Classes:

LogEntry, LogEntryXML

public interface ILogEntry

The interface for all the log entry. There are two kinds of log entries, one holding an XML node and another one lighter that has to be used whenever a Node is not required. The interface contains the common methods of each log entry class. The interface extends the Serializable whose methods are used to read/write the logs from the cache

Author:

acaproni

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ILogEntry.AdditionalData Each additional data is a couple The list of additional data (see below) stores objects of this class

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DATA_ELEMENT_TAG_NAME
static java.lang.String	HEADER_ELEMENT_TAG_NAME
static java.lang.String	LOG_ELEMENT_TAG_NAME
static java.lang.String	NAME_ATTRIBUTE_NAME

Method Summary

Modifier and Type	Method and Description
void	addData(java.lang.String name, java.lang.String value) Add data to this log It is a couple,
java.util.Vector<ILogEntry.AdditionalData>	getAdditionalData()
java.lang.Object	getField(LogField field)
LogTypeHelper	getType()
boolean	hasDatas()
java.lang.String	toString()
java.lang.String	toXMLString()

Field Detail

DATA_ELEMENT_TAG_NAME

static final java.lang.String DATA_ELEMENT_TAG_NAME

See Also:

Constant Field Values

HEADER_ELEMENT_TAG_NAME

static final java.lang.String HEADER_ELEMENT_TAG_NAME

See Also:

Constant Field Values

LOG_ELEMENT_TAG_NAME

static final java.lang.String LOG_ELEMENT_TAG_NAME

See Also:

Constant Field Values

NAME_ATTRIBUTE_NAME

static final java.lang.String NAME_ATTRIBUTE_NAME

See Also:

Constant Field Values

Method Detail

toXMLString

java.lang.String toXMLString()

Returns:

The XML string representing the object

toString

java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

A string to dump the log

hasDatas

boolean hasDatas()

Returns:

true if the log has additional data

getField

java.lang.Object getField(LogField field)

Parameters:

fieldIndex -

Returns:

Return the object in the field of the passed index

getType

LogTypeHelper getType()

Returns:

The type of the log

addData

void addData(java.lang.String name,
             java.lang.String value)

Add data to this log It is a couple,

Parameters:

name - The name, i.e. the key of the pair

value - The value of the field

getAdditionalData

java.util.Vector<ILogEntry.AdditionalData> getAdditionalData()

Returns:

a Vector of AdditionalData null if if the log does not contain any additional data