gov.nasa.pds.report.processing

Class LogDetail

java.lang.Object

gov.nasa.pds.report.processing.LogDetail

Direct Known Subclasses:

DateTimeLogDetail, StringLogDetail

public abstract class LogDetail
extends Object

This is the basic data structure object that holds the value of a detail extracted from a line of a log.

Author:

resneck

Field Summary

Fields

Modifier and Type	Field and Description
protected String	emptyValue
protected String	name
protected String	pattern
protected boolean	required

Constructor Summary

Constructors

Constructor and Description
LogDetail(String name, String pattern, boolean required) Create a LogDetail object, specifying it's name, the RE pattern used to capture the detail, and whether a value is required for the detail that will be captured.

Method Summary

Methods

Modifier and Type	Method and Description
String	getEmptyValue() Get the String that is recognized in the input line as an empty value.
String	getName() Get the name of the detail contained in this object.
String	getPattern() Get the pattern used to capture the log detail.
abstract String	getType() Get the type (i.e.
boolean	isRequired() Indicate whether the detail to be captured in this object is required.
abstract void	reset() Reset the value contained within the LogDetail object.
void	setEmptyValue(String ev) Specify a log detail value that is recognized as empty.
abstract String	toString() Represent the value stored in the LogDetail as a String.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected String name

pattern

protected String pattern

required

protected boolean required

emptyValue

protected String emptyValue

Constructor Detail

LogDetail

public LogDetail(String name,
         String pattern,
         boolean required)

Create a LogDetail object, specifying it's name, the RE pattern used to capture the detail, and whether a value is required for the detail that will be captured.

Parameters:

name - The name of the detail contained in this object.

pattern - The pattern used to capture the detail from logs.

required - Whether a value is required for the containing line to be considered valid.

Method Detail

getName

public String getName()

Get the name of the detail contained in this object.

Returns:

The name of the log detail in a String.

getPattern

public String getPattern()

Get the pattern used to capture the log detail.

Returns:

The pattern used to capture the detail, represented as a String.

getType

public abstract String getType()

Get the type (i.e. implementation) of the LogDetail object, allowing the calling code to properly interact with the object without the use of crude instanceof statements.

Returns:

One of the "string" or "datetime" Strings.

isRequired

public boolean isRequired()

Indicate whether the detail to be captured in this object is required.

Returns:

A boolean if the detail is required.

setEmptyValue

public void setEmptyValue(String ev)

Specify a log detail value that is recognized as empty. For example, the dash (-) is usually treated as an empty value for most log details.

Parameters:

ev -

getEmptyValue

public String getEmptyValue()

Get the String that is recognized in the input line as an empty value.

Returns:

The empty value String.

toString

public abstract String toString()

Represent the value stored in the LogDetail as a String.

Overrides:

toString in class Object

Returns:

A string representing the value of the log detail.

reset

public abstract void reset()

Reset the value contained within the LogDetail object. This should be called after each line has been processed to ensure that no values are accidentally carried forward while processing subsequent lines.