com.cosylab.logging.engine.log

Class LogEntryXML

java.lang.Object

com.cosylab.logging.engine.log.LogEntryXML

All Implemented Interfaces:

ILogEntry

public final class LogEntryXML
extends java.lang.Object
implements ILogEntry

This is the container class for generic Log Entries. Attributes, messages and Data(s) are obtained via public variables. Properties, used for management of LogEntries can be obtained via accessor and mutator methods. This class is used when parsing nodes. The class is used when a file is read or a node is received by the push consumer.

Note on reuse of equal Strings, Integers etc: The XML parser currently produces separate instances of the same Strings, so that a lot of memory would be used up unnecessarily. This class reuses String objects for its field values, but does not exchange the String instances that are referenced by the log Node. That current design will only yield a memory advantage if the LogEntryXML instance is not kept permanently in the application, but instead its fields are read and the values transfered (without the DOM Node) to an object of another class. Ale: please check if there are other Srings that could be reused based on stringPool, and if we should use also a pool for Integers, at least for log levels since they are always the same few.

Nested Class Summary

Nested classes/interfaces inherited from interface com.cosylab.logging.engine.log.ILogEntry

ILogEntry.AdditionalData

Field Summary

Fields

Modifier and Type	Field and Description
VectorNodeList	complexLogEntryMessage

Fields inherited from interface com.cosylab.logging.engine.log.ILogEntry

DATA_ELEMENT_TAG_NAME, HEADER_ELEMENT_TAG_NAME, LOG_ELEMENT_TAG_NAME, NAME_ATTRIBUTE_NAME

Constructor Summary

Constructors

Constructor and Description
LogEntryXML(org.w3c.dom.Node log) This constructor is called by the DOMParser.
LogEntryXML(java.util.Random random) This costructor is used only for testing purposes.
LogEntryXML(java.lang.String stackId, int stackLevel)

Method Summary

Modifier and Type	Method and Description
void	addData(java.lang.String name, java.lang.String value) Add a data node to this log: value
static LogEntryXML	generateRandomLog(java.util.Random random)
java.util.Vector<ILogEntry.AdditionalData>	getAdditionalData() The vector return contains only strings and it is formed in this way: name value name value name value...
org.w3c.dom.NodeList	getDatas() Data Nodes are returned as a org.w3c.dom.NodeList.
java.lang.String	getEntryTypeAsString() Returns the type of this Object as String.
java.lang.Object	getField(LogField f) Returns a specific field according to field name constants.
org.w3c.dom.Node	getNode()
LogTypeHelper	getType()
boolean	hasDatas() Check if the log entry has datas
boolean	isLogEntryMessageSimple() This boolean tag specifies whether LogEntryMessage is simple or not: logEntryMessageSimple = true: Log message is a single String.
static boolean	isValidLogEntryType(int index) Insert the method's description here.
static void	printNode(org.w3c.dom.Node logNode, int depth) Recursively prints the struct of the node
protected void	setField(LogField field, java.lang.Object value) Sets the specified field.
java.lang.String	toString() Returns a String representation of the log.
java.lang.String	toXMLString() Return the object as XML string

Methods inherited from class java.lang.Object

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

Field Detail

complexLogEntryMessage

public VectorNodeList complexLogEntryMessage

Constructor Detail

LogEntryXML

public LogEntryXML(java.lang.String stackId,
                   int stackLevel)
            throws org.w3c.dom.DOMException

Throws:

org.w3c.dom.DOMException

LogEntryXML

public LogEntryXML(java.util.Random random)

This costructor is used only for testing purposes. It is called by com.cosylab.logging.engine.simulator.simulatorRemoteAccess It generates a random LogEntryXML

LogEntryXML

public LogEntryXML(org.w3c.dom.Node log)
            throws org.w3c.dom.DOMException

This constructor is called by the DOMParser.

Parameters:

log - org.w3c.Node

Throws:

org.w3c.dom.DOMException

Method Detail

generateRandomLog

public static LogEntryXML generateRandomLog(java.util.Random random)

hasDatas

public boolean hasDatas()

Check if the log entry has datas

Specified by:

hasDatas in interface ILogEntry

Returns:

ture datas is not null

getDatas

public org.w3c.dom.NodeList getDatas()

Data Nodes are returned as a org.w3c.dom.NodeList. If data(s) are not present, null is returned.

getNode

public org.w3c.dom.Node getNode()

getEntryTypeAsString

public java.lang.String getEntryTypeAsString()

Returns the type of this Object as String. "Undeclared" id type is not specified.

Returns:

String

getField

public java.lang.Object getField(LogField f)

Returns a specific field according to field name constants. Creation date: (11/21/2001 18:16:03)

Specified by:

getField in interface ILogEntry

Parameters:

fieldIndex - int index of the field to return

Returns:

java.lang.Object

getType

public LogTypeHelper getType()

Specified by:

getType in interface ILogEntry

Returns:

The type of the log

See Also:

ILogEntry

isLogEntryMessageSimple

public boolean isLogEntryMessageSimple()

This boolean tag specifies whether LogEntryMessage is simple or not:

• logEntryMessageSimple = true: Log message is a single String. It is obtained via String logEntry.simpleLogEntryMessage. Value is null if message is not present.
• logEntryMessageSimple = false: Log message is more complex, it is an XML org.w3c.dom.NodeList. It is obtained via org.w3c.dom.NodeList logEntry.complexLogEntryMessage. Value is null if message is simple.

isValidLogEntryType

public static final boolean isValidLogEntryType(int index)

Insert the method's description here. Creation date: (12/4/2001 12:21:35)

Parameters:

index - int

Returns:

boolean

setField

protected void setField(LogField field,
                        java.lang.Object value)

Sets the specified field. This method is protected since the fields are not to be modified. The only time this is called is during initialization. Creation date: (11/21/2001 18:35:10)

Parameters:

field - The field

value - java.lang.Object value to set

toString

public java.lang.String toString()

Returns a String representation of the log.

Specified by:

toString in interface ILogEntry

Overrides:

toString in class java.lang.Object

Returns:

A string to dump the log

printNode

public static void printNode(org.w3c.dom.Node logNode,
                             int depth)

Recursively prints the struct of the node

Parameters:

logNode - The node to print

toXMLString

public java.lang.String toXMLString()

Return the object as XML string

Specified by:

toXMLString in interface ILogEntry

Returns:

The XML string representing the object

getAdditionalData

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

The vector return contains only strings and it is formed in this way: name value name value name value... i.e. it is a plain representation of couples of values

Specified by:

getAdditionalData in interface ILogEntry

Returns:

a Vector of String with the key and value of each additional data If the log does not contain any additional data, returns null

addData

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

Add a data node to this log: value

Specified by:

addData in interface ILogEntry

Parameters:

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

value - The value of the field