Module datarush.library

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

Class ELFLogFormat

java.lang.Object

com.pervasive.datarush.operators.io.textfile.ELFLogFormat

All Implemented Interfaces:

LogFormat

public class ELFLogFormat
extends Object
implements LogFormat

Describes the format of a web server log in W3C Extended log format. The format pattern is a #Fields directive that specifies the fields.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	formatPattern
protected SupportedLogType	logType
protected RecordTextSchema<?>	schema

Constructor Summary

Constructors

Constructor	Description
ELFLogFormat()	Create a log format for accessing Extended Log Format data.
ELFLogFormat(String formatPattern)	Create a log format for accessing Extended Log Format data.

Method Summary

Modifier and Type	Method	Description
FormatAnalyzer.FormatAnalysis	analyzeFormat(Reader input)	Creates the analysis object based on the provided input.
DataFormat.DataParser	createParser(ParsingOptions options, CharsetEncoding charEncoding, String newline)
String	getFormatPattern()	Get the value used for the log format pattern
SupportedLogType	getLogType()	Get the SupportedLogType of this format.
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()
LogFormat	setAnalysis(FormatAnalyzer.FormatAnalysis analysis)	Sets the ELF analysis object to use to determine the schema and other meta-data.
void	setFormatPattern(String formatPattern)	Set the value used for the log format pattern

Methods inherited from class java.lang.Object

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

Field Details

formatPattern

protected String formatPattern

schema

protected RecordTextSchema<?> schema

logType

protected SupportedLogType logType

Constructor Details

ELFLogFormat

public ELFLogFormat()

Create a log format for accessing Extended Log Format data.

ELFLogFormat

public ELFLogFormat(String formatPattern)

Create a log format for accessing Extended Log Format data.

Parameters:

formatPattern - the fields directive that defines the schema

Method Details

getFormatPattern

public String getFormatPattern()

Get the value used for the log format pattern

Specified by:

getFormatPattern in interface LogFormat

Returns:

the text value of the format pattern

setFormatPattern

public void setFormatPattern(String formatPattern)

Set the value used for the log format pattern

Specified by:

setFormatPattern in interface LogFormat

Parameters:

formatPattern - the value to use as the format pattern

refreshSchema

protected void refreshSchema()

analyzeFormat

public FormatAnalyzer.FormatAnalysis analyzeFormat(Reader input)
                                            throws IOException,
ParseException

Description copied from interface: LogFormat

Creates the analysis object based on the provided input.

Specified by:

analyzeFormat in interface LogFormat

Parameters:

input - the input source to analyze

Returns:

the analysis object

Throws:

IOException

ParseException

setAnalysis

public LogFormat setAnalysis(FormatAnalyzer.FormatAnalysis analysis)

Sets the ELF analysis object to use to determine the schema and other meta-data.

Specified by:

setAnalysis in interface LogFormat

Parameters:

analysis - the ELF analysis object

getLogType

public SupportedLogType getLogType()

Description copied from interface: LogFormat

Get the SupportedLogType of this format.

Specified by:

getLogType in interface LogFormat

Returns:

the SupportedLogType this format implements

getSchema

public RecordTextSchema<?> getSchema()

Gets the record schema of the source.

Returns:

the record schema of the source

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.

Specified by:

getType in interface LogFormat

Returns:

the format's record type

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

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)

Specified by:

createParser in interface LogFormat