com.manning.hip.common

Class ApacheCommonLogParser

java.lang.Object

com.manning.hip.common.ApacheCommonLogParser

All Implemented Interfaces:

Serializable

public class ApacheCommonLogParser
extends Object
implements Serializable

A modified form of CSVParser which handles the Apache Log file format. By default it assumes that the tokens are delimited by space or tab. Contiguous space/tab characters are skipped over. A token that contains "-" either in quotes or not in quotes is taken to mean that no value exists, so a null is inserted in the array for them.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static char	DEFAULT_ESCAPE_CHARACTER The default escape character to use if none is supplied to the constructor.
static boolean	DEFAULT_IGNORE_LEADING_WHITESPACE The default leading whitespace behavior to use if none is supplied to the constructor
static char	DEFAULT_QUOTE_CHARACTER The default quote character to use if none is supplied to the constructor.
static char[]	DEFAULT_SEPARATOR The default separators to use if none is supplied to the constructor.
static boolean	DEFAULT_STRICT_QUOTES The default strict quote behavior to use if none is supplied to the constructor
static int	INITIAL_READ_SIZE
static char	NULL_CHARACTER This is the "null" character - if a value is set to this then it is ignored.

Constructor Summary

Constructors

Constructor and Description
ApacheCommonLogParser() Constructs CSVParser using a comma for the separator.
ApacheCommonLogParser(char[] separators) Constructs CSVParser with supplied separator.
ApacheCommonLogParser(char[] separators, char quotechar) Constructs CSVParser with supplied separator and quote char.
ApacheCommonLogParser(char[] separators, char quotechar, char escape) Constructs CSVReader with supplied separator and quote char.
ApacheCommonLogParser(char[] separators, char quotechar, char escape, boolean strictQuotes) Constructs CSVReader with supplied separator and quote char.
ApacheCommonLogParser(char[] separators, char quotechar, char escape, boolean strictQuotes, boolean ignoreLeadingWhiteSpace) Constructs CSVReader with supplied separator and quote char.

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	isAllWhiteSpace(CharSequence sb) precondition: sb.length() > 0
protected boolean	isNextCharacterEscapable(String nextLine, boolean inQuotes, int i) precondition: the current character is an escape
boolean	isPending()
String[]	parseLine(String nextLine)
String[]	parseLineMulti(String nextLine)
boolean	separatorChar(char c)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SEPARATOR

public static final char[] DEFAULT_SEPARATOR

The default separators to use if none is supplied to the constructor.

INITIAL_READ_SIZE

public static final int INITIAL_READ_SIZE

See Also:

Constant Field Values

DEFAULT_QUOTE_CHARACTER

public static final char DEFAULT_QUOTE_CHARACTER

The default quote character to use if none is supplied to the constructor.

See Also:

Constant Field Values

DEFAULT_ESCAPE_CHARACTER

public static final char DEFAULT_ESCAPE_CHARACTER

The default escape character to use if none is supplied to the constructor.

See Also:

Constant Field Values

DEFAULT_STRICT_QUOTES

public static final boolean DEFAULT_STRICT_QUOTES

The default strict quote behavior to use if none is supplied to the constructor

See Also:

Constant Field Values

DEFAULT_IGNORE_LEADING_WHITESPACE

public static final boolean DEFAULT_IGNORE_LEADING_WHITESPACE

The default leading whitespace behavior to use if none is supplied to the constructor

See Also:

Constant Field Values

NULL_CHARACTER

public static final char NULL_CHARACTER

This is the "null" character - if a value is set to this then it is ignored. I.E. if the quote character is set to null then there is no quote character.

See Also:

Constant Field Values

Constructor Detail

ApacheCommonLogParser

public ApacheCommonLogParser()

Constructs CSVParser using a comma for the separator.

ApacheCommonLogParser

public ApacheCommonLogParser(char[] separators)

Constructs CSVParser with supplied separator.

Parameters:

separators - the delimiter to use for separating entries.

ApacheCommonLogParser

public ApacheCommonLogParser(char[] separators,
                     char quotechar)

Constructs CSVParser with supplied separator and quote char.

Parameters:

separators - the delimiter to use for separating entries

quotechar - the character to use for quoted elements

ApacheCommonLogParser

public ApacheCommonLogParser(char[] separators,
                     char quotechar,
                     char escape)

Constructs CSVReader with supplied separator and quote char.

Parameters:

separators - the delimiter to use for separating entries

quotechar - the character to use for quoted elements

escape - the character to use for escaping a separator or quote

ApacheCommonLogParser

public ApacheCommonLogParser(char[] separators,
                     char quotechar,
                     char escape,
                     boolean strictQuotes)

Constructs CSVReader with supplied separator and quote char. Allows setting the "strict quotes" flag

Parameters:

separators - the delimiter to use for separating entries

quotechar - the character to use for quoted elements

escape - the character to use for escaping a separator or quote

strictQuotes - if true, characters outside the quotes are ignored

ApacheCommonLogParser

public ApacheCommonLogParser(char[] separators,
                     char quotechar,
                     char escape,
                     boolean strictQuotes,
                     boolean ignoreLeadingWhiteSpace)

Constructs CSVReader with supplied separator and quote char. Allows setting the "strict quotes" and "ignore leading whitespace" flags

Parameters:

separators - the delimiter to use for separating entries

quotechar - the character to use for quoted elements

escape - the character to use for escaping a separator or quote

strictQuotes - if true, characters outside the quotes are ignored

ignoreLeadingWhiteSpace - if true, white space in front of a quote in a field is ignored

Method Detail

isPending

public boolean isPending()

Returns:

true if something was left over from last call(s)

parseLineMulti

public String[] parseLineMulti(String nextLine)
                        throws IOException

Throws:

IOException

parseLine

public String[] parseLine(String nextLine)
                   throws IOException

Throws:

IOException

separatorChar

public boolean separatorChar(char c)

isNextCharacterEscapable

protected boolean isNextCharacterEscapable(String nextLine,
                               boolean inQuotes,
                               int i)

precondition: the current character is an escape

Parameters:

nextLine - the current line

inQuotes - true if the current context is quoted

i - current index in line

Returns:

true if the following character is a quote

isAllWhiteSpace

protected boolean isAllWhiteSpace(CharSequence sb)

precondition: sb.length() > 0

Parameters:

sb - A sequence of characters to examine

Returns:

true if every character in the sequence is whitespace