com.lightysoft.logmx.mgr

Class LogEntriesInfoProvider

java.lang.Object

com.lightysoft.logmx.mgr.LogFileParser

com.lightysoft.logmx.mgr.LogEntriesInfoProvider

All Implemented Interfaces:

Cloneable

public abstract class LogEntriesInfoProvider
extends LogFileParser

Instances of this class provide extra information on log entries extracted by a LogFileManager that supports entries extraction (see LogFileManager.supportLogEntriesExtraction()).

Since log entries extraction (performed by a Manager) doesn't involve any Log Parser, LogMX needs a way to handle some log entries specific information like date format, or user-defined fields (information usually handled by the LogFileParser that parses the log text).
This is why this abstract class extends LogFileParser, providing a stub for features irrelevant to entries extraction (like parsing a line of text).

Since:

LogMX v5.2.0, Manager Specification Version 1.2

Author:

LightySoft

See Also:

ManagerSpecVersion

Constructor Summary

Constructors

Constructor and Description
LogEntriesInfoProvider()

Method Summary

Modifier and Type	Method and Description
String	getParserName() This implementation returns a specific name to indicate that this is not a really Parser, but a stub used to extract entries.
String	getSupportedFileType() This implementation returns a specific file type to indicate that this is not a really Parser, but a stub used to extract entries.
protected void	parseLine(String pLine) This implementation does nothing, its purpose it to avoid implementations of this class to have to implement this method.

Methods inherited from class com.lightysoft.logmx.mgr.LogFileParser

addEntry, createNewEntry, getAbsoluteEntryDate, getDescriptionForUser, getEntryStringRepresentation, getGUIName, getLastParsedLineNumber, getLocale, getLogFileManager, getParsedFileName, getRelativeEntryDate, getUserDefinedFieldDesription, getUserDefinedFields, getUserDefinedFieldsClasses, getVersionInfo, init, isEmitterFieldProvided, isLevelFieldProvided, removeLastEntry

Methods inherited from class java.lang.Object

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

Constructor Detail

LogEntriesInfoProvider

public LogEntriesInfoProvider()

Method Detail

parseLine

protected final void parseLine(String pLine)
                        throws Exception

This implementation does nothing, its purpose it to avoid implementations of this class to have to implement this method.

Specified by:

parseLine in class LogFileParser

Parameters:

pLine - New line to process by Parser (should not contain \n or \r).
If this parameter is null, that means the LogFileManager has no more line to read.

Throws:

Exception - If an unexpected error occurs while Parser processed new line. LogMX will then notify the user with a dialog box and will try to parse the file with the next parser

Since:

LogMX v5.2.0, Manager Specification Version 1.2

See Also:

LogFileParser.parseLine(java.lang.String)

getParserName

public String getParserName()

This implementation returns a specific name to indicate that this is not a really Parser, but a stub used to extract entries. Its purpose it to avoid implementations of this class to have to implement this method.

Specified by:

getParserName in class LogFileParser

Returns:

Parser name

Since:

LogMX v5.2.0, Manager Specification Version 1.2

See Also:

LogFileParser.getParserName()

getSupportedFileType

public String getSupportedFileType()

This implementation returns a specific file type to indicate that this is not a really Parser, but a stub used to extract entries. Its purpose it to avoid implementations of this class to have to implement this method.

Specified by:

getSupportedFileType in class LogFileParser

Returns:

Parser supported file type(s) description

Since:

LogMX v5.2.0, Manager Specification Version 1.2

See Also:

LogFileParser.getSupportedFileType()