com.cosylab.logging.engine.log

Class LogEntry

java.lang.Object

com.cosylab.logging.engine.log.LogEntry

All Implemented Interfaces:

ILogEntry

public class LogEntry
extends java.lang.Object
implements ILogEntry

Objects of this class holds implements the ILogEntry interface representing a generic log record. This class does not contain any reference to XML parsers

Author:

acaproni

Nested Class Summary

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

ILogEntry.AdditionalData

Field Summary

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
LogEntry(LogEntryXML logXML) Build a LogEntry from a LogEntryXML
LogEntry(java.lang.Long milliseconds, java.lang.Integer entrytype, java.lang.String file, java.lang.Integer line, java.lang.String routine, java.lang.String host, java.lang.String process, java.lang.String context, java.lang.String thread, java.lang.String logid, java.lang.Integer priority, java.lang.String uri, java.lang.String stackid, java.lang.Integer stacklevel, java.lang.String logmessage, java.lang.String srcObject, java.lang.String audience, java.lang.String array, java.lang.String antenna, java.util.Vector<ILogEntry.AdditionalData> addDatas) Builds a LogEntry object from the value of its fields All the fields are defined in the ILogEntry interface.

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()
protected void	setField(LogField field, java.lang.Object value) Sets the specified field.
java.lang.String	toString() Return a string representation of this entry
java.lang.String	toXMLString()

Methods inherited from class java.lang.Object

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

Constructor Detail

LogEntry

public LogEntry(java.lang.Long milliseconds,
                java.lang.Integer entrytype,
                java.lang.String file,
                java.lang.Integer line,
                java.lang.String routine,
                java.lang.String host,
                java.lang.String process,
                java.lang.String context,
                java.lang.String thread,
                java.lang.String logid,
                java.lang.Integer priority,
                java.lang.String uri,
                java.lang.String stackid,
                java.lang.Integer stacklevel,
                java.lang.String logmessage,
                java.lang.String srcObject,
                java.lang.String audience,
                java.lang.String array,
                java.lang.String antenna,
                java.util.Vector<ILogEntry.AdditionalData> addDatas)

Builds a LogEntry object from the value of its fields All the fields are defined in the ILogEntry interface.

Parameters:

milliseconds - The date

entrytype - The type

file - ...

line - ...

routine - ...

host - ...

process - ...

context - ...

thread - ...

logid - ...

priority - ...

uri - ...

stackid - ...

stacklevel - ...

logmessage - ...

srcObject - ...

audience - ...

array - ...

antenna - ...

addDatas - The additional data as a Vector The Vector contains in the even position the name and in the odd the value. It can be null.

See Also:

LogEntryXML.getAdditionalData, ILogEntry

LogEntry

public LogEntry(LogEntryXML logXML)

Build a LogEntry from a LogEntryXML

Parameters:

logXML - The log entry

See Also:

LogEntryXML

Method Detail

toXMLString

public java.lang.String toXMLString()

Specified by:

toXMLString in interface ILogEntry

Returns:

an XML string representing this log

hasDatas

public boolean hasDatas()

Specified by:

hasDatas in interface ILogEntry

Returns:

True if the log has additional data

getField

public java.lang.Object getField(LogField field)

Specified by:

getField in interface ILogEntry

Parameters:

field - The field to get

Returns:

The object of the given index

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 to set

value - java.lang.Object value to set

addData

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

Description copied from interface: ILogEntry

Add data to this log It is a couple,

Specified by:

addData in interface ILogEntry

Parameters:

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

value - The value of the field

toString

public java.lang.String toString()

Return a string representation of this entry

Specified by:

toString in interface ILogEntry

Overrides:

toString in class java.lang.Object

Returns:

A string to dump the log

getAdditionalData

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

Specified by:

getAdditionalData in interface ILogEntry

Returns:

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

See Also:

ILogEntry

getType

public LogTypeHelper getType()

Specified by:

getType in interface ILogEntry

Returns:

The type of the log

See Also:

ILogEntry