org.brains2b.struct

Class PlaceHolderGroup

java.lang.Object

org.brains2b.struct.PlaceHolderGroup

All Implemented Interfaces:

StructGroup

public class PlaceHolderGroup
extends java.lang.Object
implements StructGroup

PlaceHolderGroup is a StructGroup that can hold an object, either an StructElement or other Object and apply a set of rules to an input to add this information to the Object

This group is intended to parse a Single line or block of text to an Object which is already located in memory, while the normal StructGroup implementations create new instances of Objects

Version:

$Revision$ $Date$

Author:

dennis@brains2b.nl

Field Summary

Fields inherited from interface org.brains2b.struct.StructGroup

MAP, XML

Constructor Summary

Constructors

Constructor and Description
PlaceHolderGroup(java.lang.Object o) Constructor for PlaceHolderGroup.

Method Summary

Modifier and Type	Method and Description
void	add(StructRule rule) add a rule to this Group.
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
java.util.List	getTransformats() get the List of Transformats added to this Group.
boolean	isFinished() check if the end of this group is found in the input
boolean	isFound() check if the beginning of this group is found.
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	reset() reset this group to a state were the input can be processed from the beginning.
void	setParent(StructGroup group) set the parent for this Group

Methods inherited from class java.lang.Object

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

Constructor Detail

PlaceHolderGroup

public PlaceHolderGroup(java.lang.Object o)

Constructor for PlaceHolderGroup.

Parameters:

o - Object, the object to add the results of the rules to.

Method Detail

isFinished

public boolean isFinished()

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

Specified by:

isFinished in interface StructGroup

Returns:

boolean, true if the end of the input is found

See Also:

StructGroup.isFound()

isFound

public boolean isFound()

check if the beginning of this group is found.

All input will be processed inside this group as long as isFinished is false

Specified by:

isFound in interface StructGroup

Returns:

boolean, true if the beginning of the group is found

See Also:

StructGroup.isFinished()

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

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

Specified by:

readline in interface StructGroup

Parameters:

line - String, the line to be read

See Also:

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

Specified by:

readline in interface StructGroup

Parameters:

line - String, the line to be read

lineno - int, the linenumber of this line

See Also:

StructParser

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)

getTransformats

public java.util.List getTransformats()

get the List of Transformats added to this Group.

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

For SimpleTransformat adding this to the group will mean this rule will be applied to all rules added to this group

Specified by:

getTransformats in interface StructGroup

Returns:

List of Transformat

reset

public void reset()

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

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

After calling reset StructGroup.isFound() and StructGroup.isFinished() should both be false and StructGroup.getObject() should return null

Specified by:

reset in interface StructGroup

setParent

public void setParent(StructGroup group)

Description copied from interface: StructGroup

set the parent for this Group

Specified by:

setParent in interface StructGroup

Parameters:

group - StructGroup the parent to use