org.brains2b.struct.absolute

Class PositionGroup

java.lang.Object

org.brains2b.struct.StructRule

org.brains2b.struct.absolute.PositionGroup

All Implemented Interfaces:

StructGroup

public class PositionGroup
extends StructRule
implements StructGroup

PositionGroup is a Group that reads input line by line and applies all the rules in this group to that single line.

This would be the same as MarkGroup with BOL and EOL as beginning and end, but this one is a bit faster, while it does not need to check.

Keep in mind that StructRule.isFinished() and StructRule.isFound() are always the same and that the rules of this Group need to match the content of the line for this group to be found and finished.

Mostly used with PositionRule

Since:

Struct 0.30

Version:

$Revision$ $Date$

Author:

dennis@brains2b.nl

Field Summary

Fields inherited from class org.brains2b.struct.StructRule

BOL, EMPTY_LINE, EOB, EOL, m_attribute, m_out, m_terminate, SPACE

Fields inherited from interface org.brains2b.struct.StructGroup

MAP, XML

Constructor Summary

Constructors

Constructor and Description
PositionGroup() Constructor
PositionGroup(int outputType) Constructor
PositionGroup(java.lang.String objectId, int outputType) Constructor

Method Summary

Modifier and Type	Method and Description
void	add(StructRule rule) add a rule to this Group.
void	addTransformat(Transformat format) add a Transformat to this rule
protected void	clearBuffer() general method to clear a buffer which an implementation of a StructRule can implement to keep all data between StructRule.isFound() and StructRule.isFinished().
java.lang.Object	getObject() get the Object created as a result of the input matching this group.
int	getOutputType() the type of output StructGroup.getObject() will deliver if the rules are matched to the output
void	readline(java.lang.String line) read a line from the parser for processing, without tracking the line number
void	readline(java.lang.String line, int lineno) read a line from the parser for processing, with tracking the line number
void	setParent(StructGroup parent) set the parent for this rule

Methods inherited from class org.brains2b.struct.StructRule

getParent, getTransformats, insertTransformat, isFinished, isFound, isTerminate, removeWhitespace, reset, set, setFinished, setFound

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.brains2b.struct.StructGroup

getTransformats, isFinished, isFound, reset

Constructor Detail

PositionGroup

public PositionGroup()

Constructor

outputType is set to XML by default

PositionGroup

public PositionGroup(int outputType)

Constructor

Parameters:

outputType - int set type to (XML|MAP)

PositionGroup

public PositionGroup(java.lang.String objectId,
                     int outputType)

Constructor

Parameters:

objectId - Object, the id of the Object to create

outputType - int, set type to (XML|MAP)

Method Detail

readline

public 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 StructRule.isFound() and StructRule.isFinished()

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

Specified by:

readline in interface StructGroup

Specified by:

readline in class StructRule

Parameters:

line - String, the line to be read

See Also:

StructRule.readline(String, int), StructParser

readline

public 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 StructRule.isFound() and StructRule.isFinished()

Specified by:

readline in interface StructGroup

Specified by:

readline in class StructRule

Parameters:

line - String, the line to be read

lineno - int, the linenumber of this line

See Also:

StructParser

clearBuffer

protected void clearBuffer()

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

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

Specified by:

clearBuffer in class StructRule

See Also:

StructRule.reset()

addTransformat

public void addTransformat(Transformat format)

Description copied from class: StructRule

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

Overrides:

addTransformat in class StructRule

Parameters:

format - Transformat

add

public void add(StructRule rule)

add a rule to this Group. This rule will only be checked against the input if the StructGroup.isFound() is true and until StructGroup.isFinished() is true.

Specified by:

add in interface StructGroup

Parameters:

rule - StructRule, the rule to add to this group

getObject

public java.lang.Object getObject()

get the Object created as a result of the input matching this group.

Specified by:

getObject in interface StructGroup

Returns:

Object, the Object will be a type of (BEAN|XML|PROPERTIES) as defined. This value can be null if StructGroup.isFound() is never true for this group and might not be correctly set if StructGroup.isFinished() never is true

getOutputType

public int getOutputType()

the type of output StructGroup.getObject() will deliver if the rules are matched to the output

Specified by:

getOutputType in interface StructGroup

Returns:

int either one of the constants (XML|BEAN|PROPERTIES)

setParent

public void setParent(StructGroup parent)

set the parent for this rule

Specified by:

setParent in interface StructGroup

Overrides:

setParent in class StructRule

Parameters:

parent - StructGroup the parent to use