com::cosylab::logging::engine::log::LogEntry Class Reference

Inheritance diagram for com::cosylab::logging::engine::log::LogEntry:

Collaboration diagram for com::cosylab::logging::engine::log::LogEntry:

Public Member Functions
	LogEntry (Long milliseconds, Integer entrytype, String file, Integer line, String routine, String host, String process, String context, String thread, String logid, Integer priority, String uri, String stackid, Integer stacklevel, String logmessage, String srcObject, String audience, String array, String antenna, Vector< AdditionalData > addDatas)
	LogEntry (LogEntryXML logXML)
String	toXMLString ()
boolean	hasDatas ()
Object	getField (LogField field)
void	addData (String name, String value)
String	toString ()
Vector< AdditionalData >	getAdditionalData ()
LogTypeHelper	getType ()
Protected Member Functions
void	setField (LogField field, Object value)
Private Member Functions
StringBuilder	getXMLDatas ()
Private Attributes
Long	date
LogTypeHelper	type
String	file
Integer	line
String	routine
String	host
String	process
String	context
String	thread
String	logId
Integer	priority
String	uri
String	stackId
Integer	stackLevel
String	logMessage
String	sourceObject
String	audience
String	array
String	antenna
Vector< LogEntry.AdditionalData >	additionalData = null

Detailed Description

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

Constructor & Destructor Documentation

com::cosylab::logging::engine::log::LogEntry::LogEntry	(	Long	milliseconds,
		Integer	entrytype,
		String	file,
		Integer	line,
		String	routine,
		String	host,
		String	process,
		String	context,
		String	thread,
		String	logid,
		Integer	priority,
		String	uri,
		String	stackid,
		Integer	stacklevel,
		String	logmessage,
		String	srcObject,
		String	audience,
		String	array,
		String	antenna,
		Vector< AdditionalData >	addDatas
	)			`[inline]`

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<String> The Vector contains in the even position the name and in the odd the value. It can be null.

See also:: LogEntryXML.getAdditionalData; ILogEntry

References additionalData, date, logId, logMessage, sourceObject, stackId, stackLevel, and type.

com::cosylab::logging::engine::log::LogEntry::LogEntry ( LogEntryXML logXML ) [inline]

Build a LogEntry from a LogEntryXML

Parameters:

logXML

The log entry

See also:: LogEntryXML

References additionalData, com::cosylab::logging::engine::log::LogEntryXML::getAdditionalData(), com::cosylab::logging::engine::log::LogEntryXML::getField(), and setField().

Member Function Documentation

void com::cosylab::logging::engine::log::LogEntry::addData	(	String	name,
		String	value
	)			`[inline]`

Add data to this log It is a couple, <name,value>

Parameters:

	name	The name, i.e. the key of the pair
	value	The value of the field

Implements com::cosylab::logging::engine::log::ILogEntry.

References additionalData.

Vector<AdditionalData> com::cosylab::logging::engine::log::LogEntry::getAdditionalData ( ) [inline]

See also:: ILogEntry

Implements com::cosylab::logging::engine::log::ILogEntry.

References additionalData.

Object com::cosylab::logging::engine::log::LogEntry::getField ( LogField field ) [inline]

Parameters:

field

The field to get

Returns:: The object of the given index

Implements com::cosylab::logging::engine::log::ILogEntry.

References antenna, array, audience, context, date, file, host, line, logId, logMessage, priority, process, routine, sourceObject, stackId, stackLevel, thread, type, and uri.

Referenced by toString(), and toXMLString().

LogTypeHelper com::cosylab::logging::engine::log::LogEntry::getType ( ) [inline]

See also:: ILogEntry

Implements com::cosylab::logging::engine::log::ILogEntry.

References type.

StringBuilder com::cosylab::logging::engine::log::LogEntry::getXMLDatas ( ) [inline, private]

Returns:: The XML representation of the additional data

References additionalData, com::cosylab::logging::engine::log::ILogEntry::AdditionalData::name, and com::cosylab::logging::engine::log::ILogEntry::AdditionalData::value.

Referenced by toXMLString().

boolean com::cosylab::logging::engine::log::LogEntry::hasDatas ( ) [inline]

Returns:: True if the log has additional data

Implements com::cosylab::logging::engine::log::ILogEntry.

References additionalData.

Referenced by toXMLString().

void com::cosylab::logging::engine::log::LogEntry::setField	(	LogField	field,
		Object	value
	)			`[inline, protected]`

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: