org.brains2b.struct

Class StructRule

java.lang.Object

org.brains2b.struct.StructRule

Direct Known Subclasses:

IndexedRule, MarkRule, PositionGroup, PositionRule, RepeatGroup

public abstract class StructRule
extends java.lang.Object

Abstract class that defines a rule for Struct. A rule sets a value to an id for either an (XML|MAP)

Version:

$Revision$ $Date$

Author:

dennis@brains2b.nl

Field Summary

Fields

Modifier and Type	Field and Description
static Position	BOL a default constant for defining a beginning of a line
static Position	EMPTY_LINE a default constant for defining an empty line
static Position	EOB
static Position	EOL a default constant for defining an end of a line
protected boolean	m_attribute
protected java.lang.Object	m_out
protected boolean	m_terminate
static Position	SPACE a default constant for defining a beginning a whitespace

Constructor Summary

Constructors

Constructor and Description
StructRule()

Method Summary

Modifier and Type	Method and Description
void	addTransformat(Transformat format) add a Transformat to this rule
protected abstract void	clearBuffer() general method to clear a buffer which an implementation of a StructRule can implement to keep all data between isFound() and isFinished().
StructGroup	getParent() get the parent group of which this rule is a part
java.util.List	getTransformats() get the List of Transformats applicable to this Rule.
void	insertTransformat(int pos, Transformat format)
boolean	isFinished() check if the end of this rule is found in the input
boolean	isFound() check if the beginning of this rule is found.
boolean	isTerminate()
abstract void	readline(java.lang.String line) read a line from the parser for processing, without tracking the line number
abstract void	readline(java.lang.String line, int lineno) read a line from the parser for processing, with tracking the line number
static int	removeWhitespace(java.lang.String line, int begin, int end) get the index within the line after detected whitespaces between begin and end
void	reset() reset this rule to a state were the input can be processed from the beginning.
protected void	set(java.lang.Object objectId, java.lang.String value) set the value created from the input to the Object created by the parent, identified within that Object by objectId.
void	setFinished(boolean finished) set the indicator that the end of this rule is found in the input
void	setFound(boolean found) set the indicator that the beginning of this rule is found.
void	setParent(StructGroup parent) set the parent for this rule

Methods inherited from class java.lang.Object

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

Field Detail

BOL

public static final Position BOL

a default constant for defining a beginning of a line

EOL

public static final Position EOL

a default constant for defining an end of a line

EMPTY_LINE

public static final Position EMPTY_LINE

a default constant for defining an empty line

SPACE

public static final Position SPACE

a default constant for defining a beginning a whitespace

EOB

public static final Position EOB

m_out

protected java.lang.Object m_out

m_attribute

protected boolean m_attribute

m_terminate

protected boolean m_terminate

Constructor Detail

StructRule

public StructRule()

Method Detail

readline

public abstract void readline(java.lang.String line)

read a line from the parser for processing, without tracking the line number

The StructParser supplies the input line for line. This does not limit the rules to one line. This is only dependant on isFound() and isFinished()

This method calls readline(String, int) with lineno=-1 and will ignore lineno for information purposes

Parameters:

line - String, the line to be read

See Also:

readline(String, int), StructParser

readline

public abstract void readline(java.lang.String line,
                              int lineno)

read a line from the parser for processing, with tracking the line number

The StructParser supplies the input line for line. This does not limit the rules to one line. This is only dependant on isFound() and isFinished()

Parameters:

line - String, the line to be read

lineno - int, the linenumber of this line

See Also:

StructParser

clearBuffer

protected abstract void clearBuffer()

general method to clear a buffer which an implementation of a StructRule can implement to keep all data between isFound() and isFinished().

This method is called from reset to clear the buffer between two independant uses of this rule

See Also:

reset()

reset

public void reset()

reset this rule to a state were the input can be processed from the beginning.

This method is called to reuse this rule for subsequent calls after a rule has finished clearing all data related to previous matching of this group.

After calling reset isFound() and isFinished() will both be false and clearBuffer() will be called

isFinished

public boolean isFinished()

check if the end of this rule is found in the input

Returns:

boolean, true if the end of the input is found

See Also:

isFound()

isFound

public boolean isFound()

check if the beginning of this rule is found.

Returns:

boolean, true if the beginning of the group is found

See Also:

isFinished()

setFinished

public void setFinished(boolean finished)

set the indicator that the end of this rule is found in the input

Parameters:

finished - boolean, true if the end of the input is found

See Also:

isFinished()

setFound

public void setFound(boolean found)

set the indicator that the beginning of this rule is found.

Parameters:

found - boolean, true if the beginning of the group is found

See Also:

isFound()

getParent

public StructGroup getParent()

get the parent group of which this rule is a part

Returns:

StructGroup

setParent

public void setParent(StructGroup parent)

set the parent for this rule

Parameters:

parent - StructGroup the parent to use

insertTransformat

public void insertTransformat(int pos,
                              Transformat format)

removeWhitespace

public static final int removeWhitespace(java.lang.String line,
                                         int begin,
                                         int end)

get the index within the line after detected whitespaces between begin and end

Parameters:

line - String, the line to test

begin - int, the begin index to test for whitespace

end - int, the end index to test for whitespaces

Returns:

int, the index within the line after all whitespaces started at begin

addTransformat

public void addTransformat(Transformat format)

add a Transformat to this rule

A transformater is a class which will be called to format the values from an input to a value for the output. With an implementation one can do simple transformations SimpleTransformat like trimming whitespaces or setting the value to uppercase or do complex transformations ComplexTransformat changing multiple values in a resulting Object

Parameters:

format - Transformat

Throws:

java.lang.NullPointerException - if the transformat is null

getTransformats

public java.util.List getTransformats()

get the List of Transformats applicable to this Rule.

SimpleTransformats which are applicable to the StructGroup will also be applicable to this rule and thus will be returned by this function.

A transformater is a class which will be called to format the values from an input to a value for the output. With an implementation one can do simple transformations SimpleTransformat like trimming whitespaces or setting the value to uppercase or do complex transformations ComplexTransformat changing multiple values in a resulting Object

Returns:

List of Transformat

set

protected void set(java.lang.Object objectId,
                   java.lang.String value)

set the value created from the input to the Object created by the parent, identified within that Object by objectId. ObjectId should be seen as a attribute of (sub)element name for XML, and a property name for a Bean or Properties output type set on the parent.

Parameters:

objectId - Object, always a String but for reasons of implementation of StructGroup supplied here as an Object

value - String, the value to set to the Object

isTerminate

public boolean isTerminate()