com::cosylab::logging::engine::log::ILogEntry Interface Reference

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

[legend]List of all members.

Public Types
enum	Field {   TimeStamp, class, TimeStamp, Type,   class, null, Object, class,   SourceObject, File, class, File,   Line, class, Line, Routine,   class, Routine, Host, class,   Host, Process, class, Process,   Context, class, Context, Thread,   class, Thread, ID, class,   LogId, Priority, class, Priority,   URI, class, URI, ID,   class, StackId, Level, class,   StackLevel, Message, class, null,   Audience, class, Audience, Array,   class, Array, Antenna, class,   name, fClass, null }
Public Member Functions
String	toXMLString ()
String	toString ()
boolean	hasDatas ()
Object	getField (Field field)
LogTypeHelper	getType ()
void	addData (String name, String value)
Vector< AdditionalData >	getAdditionalData ()
Static Public Attributes
final String	DATA_ELEMENT_TAG_NAME = "Data"
final String	HEADER_ELEMENT_TAG_NAME = "Header"
final String	LOG_ELEMENT_TAG_NAME = "Log"
final String	NAME_ATTRIBUTE_NAME = "Name"
Package Types

---

Detailed Description

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

---

Member Enumeration Documentation

enum com::cosylab::logging::engine::log::ILogEntry::Field

An enumerated describing each field of the log. This allows to have all the attributes describing the fields written together limiting the chance of typos, errors and so on. NOTE: before introducing this enum each filed has an integer, the entryType. This integer can be obtained with the ordinal() method of enum. Author: acaproni Enumeration values: TimeStamp  class  TimeStamp  Type  class  null  Return a Field from its name Returns: The field with the given name or null if a field with that name does not exist Object  class  SourceObject  File  class  File  Line  class  Line  Routine  class  Routine  Host  class  Host  Process  class  Process  Context  class  Context  Thread  class  Thread  ID  class  LogId  Priority  class  Priority  URI  class  URI  ID  class  StackId  Level  class  StackLevel  Message  class  null  Return a Field from its name Returns: The field with the given name or null if a field with that name does not exist Audience  class  Audience  Array  class  Array  Antenna  class  name  Constructor Parameters: type  The type of this fields name  The name of the field fClass  The class of the field tag  The name of the XML tag containing this attribute (null for non tag attributes like the log message) fClass  null  Return a Field from its name Returns: The field with the given name or null if a field with that name does not exist

---

Member Function Documentation

void com::cosylab::logging::engine::log::ILogEntry::addData (  String  name, String  value )

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 Implemented in com::cosylab::logging::engine::log::LogEntry, and com::cosylab::logging::engine::log::LogEntryXML.

Vector<AdditionalData> com::cosylab::logging::engine::log::ILogEntry::getAdditionalData (   )

Returns: a Vector of AdditionalData null if if the log does not contain any additional data Implemented in com::cosylab::logging::engine::log::LogEntry, and com::cosylab::logging::engine::log::LogEntryXML.

Object com::cosylab::logging::engine::log::ILogEntry::getField (  Field  field  )

Parameters: fieldIndex  Returns: Return the object in the field of the passed index Implemented in com::cosylab::logging::engine::log::LogEntry, and com::cosylab::logging::engine::log::LogEntryXML.

LogTypeHelper com::cosylab::logging::engine::log::ILogEntry::getType (   )

Returns: The type of the log Implemented in com::cosylab::logging::engine::log::LogEntry, and com::cosylab::logging::engine::log::LogEntryXML.

boolean com::cosylab::logging::engine::log::ILogEntry::hasDatas (   )

Returns: true if the log has additional data Implemented in com::cosylab::logging::engine::log::LogEntry, and com::cosylab::logging::engine::log::LogEntryXML.

String com::cosylab::logging::engine::log::ILogEntry::toString (   )

Returns: A string to dump the log Implemented in com::cosylab::logging::engine::log::LogEntry, and com::cosylab::logging::engine::log::LogEntryXML.

String com::cosylab::logging::engine::log::ILogEntry::toXMLString (   )

Returns: The XML string representing the object Implemented in com::cosylab::logging::engine::log::LogEntry, and com::cosylab::logging::engine::log::LogEntryXML.

---

Member Data Documentation

final String com::cosylab::logging::engine::log::ILogEntry::DATA_ELEMENT_TAG_NAME = "Data" [static]

final String com::cosylab::logging::engine::log::ILogEntry::HEADER_ELEMENT_TAG_NAME = "Header" [static]

final String com::cosylab::logging::engine::log::ILogEntry::LOG_ELEMENT_TAG_NAME = "Log" [static]

final String com::cosylab::logging::engine::log::ILogEntry::NAME_ATTRIBUTE_NAME = "Name" [static]

---

The documentation for this interface was generated from the following file:

• ILogEntry.java

---