org.brains2b.struct.mark

Class ParameterGroup

java.lang.Object

org.brains2b.struct.StructRule

org.brains2b.struct.mark.MarkRule

org.brains2b.struct.mark.MarkGroup

org.brains2b.struct.mark.ParameterGroup

All Implemented Interfaces:

StructGroup

public class ParameterGroup
extends MarkGroup

Split a list separated by a given separator into different rules, that can be handled as separate rules

To add a StructRule to a Parameter group you have to set it to a specific index within that group. So the first occurence when the separator is found should be treated with the StructRule set for index 1, etc. Using the default MarkGroup.add(StructRule) operation will add the rule at the last index within the rules.

If not for all occurrences of the separator a rule is definied the value between the separators are just ignored.

The group itself is treated as a seperate element

ParameterRule is used for splitting a list of values with a separator with the same StructRule

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
ParameterGroup(Position start, Position end, Position seperator, java.lang.Object object, boolean useGroup) Constructor for ParameterGroup
ParameterGroup(Position start, Position end, Position seperator, java.lang.Object object, boolean useGroup, int outputType) Constructor for ParameterGroup
ParameterGroup(java.lang.String start, Position end, java.lang.String seperator, java.lang.Object out) Constructor for ParameterGroup
ParameterGroup(java.lang.String start, java.lang.String end, java.lang.String seperator, java.lang.Object out) Constructor for ParamterGroup.

Method Summary

Modifier and Type	Method and Description
void	add(int index, StructRule rule) add a StructRule at a specific Index
protected void	applyRules(int lineno) not implemented
java.lang.Object	getObject() get the Object created as a result of the input matching this group.
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.MarkGroup

add, addAttribute, addAttribute, addAttribute, addAttribute, addStatic, addStaticAttribute, addTransformat, createObject, getOutputType, getRules, insertTransformat

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

ParameterGroup

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

Constructor for ParamterGroup.

Parameters:

start -

end -

seperator -

out -

ParameterGroup

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

Constructor for ParameterGroup

Parameters:

start -

end -

seperator -

out -

ParameterGroup

public ParameterGroup(Position start,
                      Position end,
                      Position seperator,
                      java.lang.Object object,
                      boolean useGroup)

Constructor for ParameterGroup

Parameters:

start -

end -

seperator -

object -

useGroup -

ParameterGroup

public ParameterGroup(Position start,
                      Position end,
                      Position seperator,
                      java.lang.Object object,
                      boolean useGroup,
                      int outputType)

Constructor for ParameterGroup

Parameters:

start -

end -

seperator -

object -

useGroup -

Method Detail

applyRules

protected void applyRules(int lineno)

not implemented

Overrides:

applyRules in class MarkGroup

See Also:

MarkGroup.applyRules(int)

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

Overrides:

readline in class MarkGroup

Parameters:

line - String, the line to be read

lineno - int, the linenumber of this line

See Also:

StructParser

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

Overrides:

getObject in class MarkGroup

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()

add

public void add(int index,
                StructRule rule)

add a StructRule at a specific Index

If the rules between the elements are not defined null is inserted for the rules in between.

Parameters:

index - int

rule - StructRule