Module datarush.library

Package com.pervasive.datarush.operators.io.textfile

Class Log4jLogFormat

java.lang.Object

com.pervasive.datarush.operators.io.textfile.AbstractRegexLogFormat

com.pervasive.datarush.operators.io.textfile.Log4jLogFormat

All Implemented Interfaces:

LogFormat

public class Log4jLogFormat
extends AbstractRegexLogFormat

Describes the format of a log4j log file. Should use the same string specified in the log4j.properties file for *.layout.ConversionPattern as the format pattern. See org.apache.log4j.EnhancedPatternLayout for more information on valid format patterns.

Nested Class Summary

Nested classes/interfaces inherited from class com.pervasive.datarush.operators.io.textfile.AbstractRegexLogFormat

AbstractRegexLogFormat.RegexParser

Field Summary

Fields

Modifier and Type	Field	Description
protected RecordTextSchema<?>	schema

Fields inherited from class com.pervasive.datarush.operators.io.textfile.AbstractRegexLogFormat

formatPattern, logType

Constructor Summary

Constructors

Constructor	Description
Log4jLogFormat()	Create a log format for accessing log4j log data.
Log4jLogFormat(String formatPattern)	Create a log format for accessing log4j log data.

Method Summary

Modifier and Type	Method	Description
DataFormat.DataParser	createParser(ParsingOptions options, CharsetEncoding charEncoding, String newline)
List<String>	getCustomLevelDefinitions()	Gets the custom level definitions.
RecordTextSchema<?>	getSchema()	Gets the record schema of the source.
RecordTokenType	getType()	Gets the record type associated with the format.
boolean	isSplittable()	Indicates if the format supports parsing of subsections of a file.
protected void	refreshSchema()	Refresh and recalculate the schema.
void	setCustomLevelDefinitions(List<String> customLevelDefinitions)	Sets the custom level definitions.
void	setFormatPattern(String formatPattern)	Set the value used for the log format pattern

Methods inherited from class com.pervasive.datarush.operators.io.textfile.AbstractRegexLogFormat

analyzeFormat, getFormatPattern, getLogType, setAnalysis

Methods inherited from class java.lang.Object

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

Field Detail

schema

protected RecordTextSchema<?> schema

Constructor Detail

Log4jLogFormat

public Log4jLogFormat()

Create a log format for accessing log4j log data.

Log4jLogFormat

public Log4jLogFormat(String formatPattern)

Create a log format for accessing log4j log data.

Parameters:

formatPattern - the log4j pattern that determines the schema

Method Detail

setCustomLevelDefinitions

public void setCustomLevelDefinitions(List<String> customLevelDefinitions)

Sets the custom level definitions. The default level names are: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Parameters:

customLevelDefinitions - the custom level definition list

getCustomLevelDefinitions

public List<String> getCustomLevelDefinitions()

Gets the custom level definitions.

Returns:

the list of custom level names

setFormatPattern

public void setFormatPattern(String formatPattern)

Description copied from class: AbstractRegexLogFormat

Set the value used for the log format pattern

Specified by:

setFormatPattern in interface LogFormat

Overrides:

setFormatPattern in class AbstractRegexLogFormat

Parameters:

formatPattern - the value to use as the format pattern

getType

public RecordTokenType getType()

Description copied from interface: LogFormat

Gets the record type associated with the format. Records produced by the associated parser or consumed by the associated formatter will be of this type.

For many formats, this may be derived from a schema object describing the format layout.

Returns:

the format's record type

getSchema

public RecordTextSchema<?> getSchema()

Description copied from class: AbstractRegexLogFormat

Gets the record schema of the source.

Specified by:

getSchema in class AbstractRegexLogFormat

Returns:

the record schema of the source

refreshSchema

protected void refreshSchema()

Description copied from class: AbstractRegexLogFormat

Refresh and recalculate the schema. This is usually done after changing a setting.

Specified by:

refreshSchema in class AbstractRegexLogFormat

isSplittable

public boolean isSplittable()

Description copied from interface: LogFormat

Indicates if the format supports parsing of subsections of a file.

A format should only return true if it can, at least in some situations, support this sort of parsing. If a format requires reading the entire file, it must return false.

If a format is not splittable, a file in the format cannot be parsed in parallel; however, individual files can still be parsed independently in parallel, as when reading the contents of a directory or using a file globbing pattern.

Specified by:

isSplittable in interface LogFormat

Overrides:

isSplittable in class AbstractRegexLogFormat

Returns:

true if the format supports parsing only a portion of the file, false otherwise

createParser

public DataFormat.DataParser createParser(ParsingOptions options,
                                          CharsetEncoding charEncoding,
                                          String newline)