ACS-10.0 Java API: com.cosylab.logging.engine.log.ILogEntry Interface Reference

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

List of all members.

Classes
class	AdditionalData
Public Member Functions
String	toXMLString ()
String	toString ()
boolean	hasDatas ()
Object	getField (LogField field)
LogTypeHelper	getType ()
void	addData (String name, String value)
Vector< AdditionalData >	getAdditionalData ()
Static Public Attributes
static final String	DATA_ELEMENT_TAG_NAME = "Data"
static final String	HEADER_ELEMENT_TAG_NAME = "Header"
static final String	LOG_ELEMENT_TAG_NAME = "Log"
static final String	NAME_ATTRIBUTE_NAME = "Name"

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 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.

Referenced by alma.acs.logging.table.TablePopupMenu.actionPerformed().

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.

Referenced by alma.acs.logging.tools.CSVConverter.convert(), alma.acs.logging.table.reduction.SourceAntennaRule.getReducedLog(), alma.acs.logging.table.reduction.AntennaRule.getReducedLog(), com.cosylab.logging.client.DetailedLogTable.setupContent(), and com.cosylab.logging.client.cache.LogFileCache.toCacheString().

Object com.cosylab.logging.engine.log.ILogEntry.getField ( LogField 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.

Referenced by alma.acs.logging.table.reduction.AntennaRule.AntennaRule(), alma.acs.logging.table.reduction.SourceAntennaRule.applyRule(), alma.acs.logging.table.reduction.AntennaRule.applyRule(), com.cosylab.logging.engine.Filter.applyTo(), alma.acs.logging.tools.CSVConverter.convert(), alma.acs.logging.table.reduction.SourceAntennaRule.getReducedLog(), alma.acs.logging.table.reduction.AntennaRule.getReducedLog(), alma.acs.logging.table.LogEntryTableModelBase.getValueAt(), alma.acs.logging.tools.LogFileSplitter.logEntryReceived(), com.cosylab.logging.engine.audience.SciLogAudience.matches(), com.cosylab.logging.engine.audience.OperatorAudience.matches(), alma.acs.logging.errorbrowser.Engine.run(), com.cosylab.logging.client.DetailedLogTable.setupContent(), alma.acs.logging.table.TablePopupMenu.show(), alma.acs.logging.table.reduction.SourceAntennaRule.SourceAntennaRule(), com.cosylab.logging.client.cache.LogFileCache.toCacheString(), and alma.acs.logging.table.LogEntryTable.zoom().

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.

Referenced by alma.acs.logtools.monitor.LogDetailsDispatcher.logEntryReceived(), com.cosylab.logging.engine.LogMatcher.match(), com.cosylab.logging.engine.audience.SciLogAudience.matches(), and com.cosylab.logging.engine.audience.OperatorAudience.matches().

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.

Referenced by alma.acs.logging.tools.CSVConverter.convert(), alma.acs.logging.table.LogEntryTable.getExtraInfo(), alma.acs.logging.table.LogEntryTableModelBase.getValueAt(), and com.cosylab.logging.client.cache.LogFileCache.toCacheString().

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.

Referenced by alma.acs.logging.tools.XMLConverter.convert(), com.cosylab.logging.engine.ACS.ACSLogRetrieval.run(), and alma.acs.logging.engine.LogReceiver.startCaptureLogs().

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

All Classes Namespaces Files Functions Variables Enumerations Properties