com.lightysoft.logmx.business

Class ParsedEntry

java.lang.Object

com.lightysoft.logmx.business.ParsedEntry

public abstract class ParsedEntry
extends Object

This class is used to store information for each log entry found by a parser in a log file. An 'entry' is a logging event that may contain 'fields' like a date, a level, a message, a thread, an emitter, or any other user-defined field(s)

Since:

LogMX v1.0

Author:

LightySoft

See Also:

LogFileParser

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ParsedEntry() Internal constructor, parsers should NOT use this constructor but LogFileParser.createNewEntry() instead.

Method Summary

Modifier and Type	Method and Description
String	getDate() Return entry Date found by parser in file
String	getEmitter() Return entry Emitter found by parser in file
String	getLevel() Return entry Level found by parser in file
String	getMessage() Return entry Message found by parser in file
String	getThread() Return entry Thread found by parser in file
Map<String,Object>	getUserDefinedFields() Return the Map that holds all user-defined fields stored by the parser for this entry, given by their name (e.g.
void	setDate(String pDate) Set entry Date found by parser in file
void	setEmitter(String pEmitter) Set entry Emitter found by parser in file
void	setLevel(String pLevel) Set entry Level found by parser in file
void	setMessage(String pMessage) Set entry Message found by parser in file
void	setThread(String pThread) Set entry Thread found by parser in file
void	setUserDefinedFields(Map<String,Object> pUserDefinedFields) Set the Map that holds all user-defined fields stored by the parser for this entry, given by their name (e.g.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParsedEntry

protected ParsedEntry()

Internal constructor, parsers should NOT use this constructor but LogFileParser.createNewEntry() instead.

Since:

LogMX v1.0

Method Detail

getEmitter

public String getEmitter()

Return entry Emitter found by parser in file

Returns:

Entry Emitter found by parser in file

Since:

LogMX v1.0

setEmitter

public void setEmitter(String pEmitter)

Set entry Emitter found by parser in file

Parameters:

pEmitter - Entry Emitter found by parser in file

Since:

LogMX v1.0

getDate

public String getDate()

Return entry Date found by parser in file

Returns:

Entry Date found by parser in file

Since:

LogMX v1.0

setDate

public void setDate(String pDate)

Set entry Date found by parser in file

Parameters:

pDate - Entry Date found by parser in file

Since:

LogMX v1.0

getLevel

public String getLevel()

Return entry Level found by parser in file

Returns:

Entry Level found by parser in file

Since:

LogMX v1.0

setLevel

public void setLevel(String pLevel)

Set entry Level found by parser in file

Parameters:

pLevel - Entry Level found by parser in file

Since:

LogMX v1.0

getMessage

public String getMessage()

Return entry Message found by parser in file

Returns:

Entry Message found by parser in file

Since:

LogMX v1.0

setMessage

public void setMessage(String pMessage)

Set entry Message found by parser in file

Parameters:

pMessage - Entry Message found by parser in file

Since:

LogMX v1.0

getThread

public String getThread()

Return entry Thread found by parser in file

Returns:

Entry Thread found by parser in file

Since:

LogMX v1.0

setThread

public void setThread(String pThread)

Set entry Thread found by parser in file

Parameters:

pThread - Entry Thread found by parser in file

Since:

LogMX v1.0

getUserDefinedFields

public Map<String,Object> getUserDefinedFields()

Return the Map that holds all user-defined fields stored by the parser for this entry, given by their name (e.g. line in source file, ClientID, relative timestamp, ... or anything else). This Map is null by default. If you need user-defined fields, first initialize this Map using setUserDefinedFields(Map) for each entry, then use Map.put(Object, Object) on this Map.

Returns:

Map that holds all user-defined fields stored by the parser for this entry, given by their name

Since:

LogMX v2.0.0

setUserDefinedFields

public void setUserDefinedFields(Map<String,Object> pUserDefinedFields)

Set the Map that holds all user-defined fields stored by the parser for this entry, given by their name (e.g. line in source file, ClientID, relative timestamp, ... or anything else). This Map is null by default. If you need user-defined fields, first initialize this Map using this method for each entry, then use Map.put(Object, Object) on this Map.

Parameters:

pUserDefinedFields - Map that holds all user-defined fields stored by the parser for this entry, given by their name

Since:

LogMX v2.0.0