alma.acs.logging.tools

Class LogConverter

java.lang.Object

alma.acs.logging.tools.LogConverter

Direct Known Subclasses:

CSVConverter, XMLConverter

public abstract class LogConverter
extends java.lang.Object

The base class of the converters of the logs.

It is possible:

• to select the field to write in the converted log
• repeat the same field several time
• define the order of the fields in the converted string

Note that the format of the XML is not customizable i.e. the selected columns and their order will be ignored while converting.

Since:

ACS 8.1.0

Author:

acaproni

Field Summary

Fields

Modifier and Type	Field and Description
static char	ADDITIONAL_DATA_ID Additional data is not a field of the log so its value is specified here as a constant char
protected java.lang.String	colIndex The string representing the columns and their order.

Constructor Summary

Constructors

Constructor and Description
LogConverter() Default constructor: the converted string will contain all the fields.
LogConverter(java.util.Collection<LogField> fields, boolean additionlData) Constructor
LogConverter(java.lang.String cols) Constructor

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	convert(ILogEntry log) Convert the log to a string of the given format
abstract java.lang.String	getHeader() Generate the header for the given converter.
void	setCols(java.util.Collection<LogField> columns, boolean additionlData) Set the columns to write in the converted string
void	setCols(java.lang.String columns) Set the columns to write in the converted string.

Methods inherited from class java.lang.Object

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

Field Detail

ADDITIONAL_DATA_ID

public static final char ADDITIONAL_DATA_ID

Additional data is not a field of the log so its value is specified here as a constant char

See Also:

Constant Field Values

colIndex

protected java.lang.String colIndex

The string representing the columns and their order.

colIndex is composed of chars identifying the column and their position. Each char is is a LogField.id or ADDITIONAL_DATA_ID.

For example if colIndex=="0f1j" then the converted string contains entries with like that: timestamp, message, log type, addData 1, addData2...addDataN because LogField.TIMESTAMP.id=0, LogFiled.LOGMESSAGE=f, LogField.ENTRYTYPE.id=1 and ADDITIONAL_DATA_ID=j.

Note that this is ignored while converting to XML!

See Also:

LogField}, LogConverter.colIndexVector

Constructor Detail

LogConverter

public LogConverter()

Default constructor: the converted string will contain all the fields.

LogConverter

public LogConverter(java.lang.String cols)

Constructor

Parameters:

cols - A string describing the columns and their position in the converted String

LogConverter

public LogConverter(java.util.Collection<LogField> fields,
                    boolean additionlData)

Constructor

This constructor only allows to have additional data appened at the end of the other fields.

Parameters:

fields - A collection describing the columns and their position in the converted String

additionlData - true if the additional data must be appended in the last position of the converted string

Method Detail

setCols

public void setCols(java.lang.String columns)

Set the columns to write in the converted string.

Parameters:

columns - A string of columns; if null or empty then colIndexs contain all the fields plus the additional data

See Also:

colIndex

setCols

public void setCols(java.util.Collection<LogField> columns,
                    boolean additionlData)

Set the columns to write in the converted string

Parameters:

columns - A vector of LogField representing the field to write in the converted string

additionlData - true if the additional data must be appended in the last position of the converted string

See Also:

colIndexVector

convert

public abstract java.lang.String convert(ILogEntry log)

Convert the log to a string of the given format

Parameters:

log - The log to convert to a String

Returns:

An ASCII string with the selected format

getHeader

public abstract java.lang.String getHeader()

Generate the header for the given converter.

If no header is needed, the heder return an empty string.

Returns: