org.brains2b.struct.mark

Class MarkGroup

java.lang.Object

org.brains2b.struct.StructRule

org.brains2b.struct.mark.MarkRule

org.brains2b.struct.mark.MarkGroup

All Implemented Interfaces:

StructGroup

Direct Known Subclasses:

NestedGroup, ParameterGroup, WithinGroup

public class MarkGroup
extends MarkRule
implements StructGroup

MarkGroup is a StructParser element which represents a structure which itself can consist of multiple groups and rules for parsing.

The rules belonging to this must fall within the start and end tag of this rule

Version:

$Revision$ $Date$

Author:

dennis@brains2b.nl

Field Summary

Fields inherited from class org.brains2b.struct.mark.MarkRule

LEFTQUOTE, m_endPos, m_startPos

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
MarkGroup(Position start, Position end, java.lang.Object out)
MarkGroup(Position start, Position end, java.lang.Object out, int outputType)
MarkGroup(Position start, java.lang.String end, java.lang.Object out) Constructor for MarkGroup.
MarkGroup(Position start, java.lang.String end, java.lang.Object out, int outputType)
MarkGroup(java.lang.String start, Position endPos, java.lang.Object out) Constructor
MarkGroup(java.lang.String start, Position endPos, java.lang.Object out, int outputType) Constructor
MarkGroup(java.lang.String start, java.lang.String end, java.lang.Object out) Constructor for MarkGroup.
MarkGroup(java.lang.String start, java.lang.String end, java.lang.Object out, int outputType)

Method Summary

Modifier and Type	Method and Description
void	add(StructRule rule) add a rule to this Group.
void	addAttribute(Position endPos, java.lang.Object o)
void	addAttribute(Position end, java.lang.Object o, Transformat format)
void	addAttribute(java.lang.String end, java.lang.Object o)
void	addAttribute(java.lang.String end, java.lang.Object o, Transformat format)
void	addStatic(java.lang.String name, java.lang.Object o)
void	addStaticAttribute(java.lang.String name, java.lang.Object o)
void	addTransformat(Transformat format) add a Transformat to this rule
protected void	applyRules(int lineno)
protected void	createObject(java.lang.Object out)
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
protected java.util.List	getRules()
void	insertTransformat(int pos, Transformat format)
void	readline(java.lang.String line, int lineno) read a line from the parser for processing, with tracking the line number

Methods inherited from class org.brains2b.struct.mark.MarkRule

clearBuffer, findQuote, getBuffer, isAttribute, isWord, readline, setAttribute, setBuffer, terminate

Methods inherited from class org.brains2b.struct.StructRule

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

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, readline, reset, setParent

Constructor Detail

MarkGroup

public MarkGroup(java.lang.String start,
                 java.lang.String end,
                 java.lang.Object out)

Constructor for MarkGroup.

Parameters:

start -

end -

out -

MarkGroup

public MarkGroup(Position start,
                 Position end,
                 java.lang.Object out)

MarkGroup

public MarkGroup(java.lang.String start,
                 Position endPos,
                 java.lang.Object out)

Constructor

The output type is set to default: XML

Parameters:

start - String, the Mark at which to start

endPos - Position, The mark(s) at which this group ends

out - Object to which this group should be attached

Since:

Struct 0.22

MarkGroup

public MarkGroup(Position start,
                 java.lang.String end,
                 java.lang.Object out)

Constructor for MarkGroup.

Parameters:

start -

end -

out -

MarkGroup

public MarkGroup(java.lang.String start,
                 Position endPos,
                 java.lang.Object out,
                 int outputType)

Constructor

Parameters:

start - String, the Mark at which to start

endPos - Position, The mark(s) at which this group ends

out - Object to which this group should be attached

outputType - int, one of the defined output types

Since:

Struct 0.22

MarkGroup

public MarkGroup(java.lang.String start,
                 java.lang.String end,
                 java.lang.Object out,
                 int outputType)

MarkGroup

public MarkGroup(Position start,
                 java.lang.String end,
                 java.lang.Object out,
                 int outputType)

MarkGroup

public MarkGroup(Position start,
                 Position end,
                 java.lang.Object out,
                 int outputType)

Method Detail

addStaticAttribute

public void addStaticAttribute(java.lang.String name,
                               java.lang.Object o)

addAttribute

public void addAttribute(java.lang.String end,
                         java.lang.Object o)

addAttribute

public void addAttribute(Position endPos,
                         java.lang.Object o)

addAttribute

public void addAttribute(java.lang.String end,
                         java.lang.Object o,
                         Transformat format)

addAttribute

public void addAttribute(Position end,
                         java.lang.Object o,
                         Transformat format)

readline

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

Description copied from class: StructRule

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

Overrides:

readline in class MarkRule

Parameters:

line - String, the line to be read

lineno - int, the linenumber of this line

See Also:

StructParser

applyRules

protected void applyRules(int lineno)

add

public void add(StructRule rule)

Description copied from interface: StructGroup

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

See Also:

StructGroup.add(StructRule)

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

insertTransformat

public void insertTransformat(int pos,
                              Transformat format)

Overrides:

insertTransformat in class StructRule

addStatic

public void addStatic(java.lang.String name,
                      java.lang.Object o)

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)

createObject

protected void createObject(java.lang.Object out)

getObject

public java.lang.Object getObject()

Description copied from interface: StructGroup

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

See Also:

StructGroup.getObject()

getRules

protected java.util.List getRules()