org.brains2b.struct.mark

Class MarkRule

java.lang.Object

org.brains2b.struct.StructRule

org.brains2b.struct.mark.MarkRule

Direct Known Subclasses:

BooleanRule, MarkGroup, ParameterRule, WithinRule

public class MarkRule
extends StructRule

[Short description] [Long description]

Version:

0.14.4 [15-05-2007]

Author:

dennis@brains2b.nl

Field Summary

Fields

Modifier and Type	Field and Description
protected static char[]	LEFTQUOTE
protected Position	m_endPos
protected Position	m_startPos

Fields inherited from class org.brains2b.struct.StructRule

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

Constructor Summary

Constructors

Constructor and Description
MarkRule(Position startPos, Position endPos, java.lang.Object out, boolean attribute)
MarkRule(Position startPos, java.lang.String end, java.lang.Object out, boolean attribute)
MarkRule(java.lang.String start, Position endPos, java.lang.Object out, boolean attribute)
MarkRule(java.lang.String start, java.lang.String end, java.lang.Object out, boolean attribute)

Method Summary

Modifier and Type	Method and Description
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().
protected static boolean	findQuote(java.lang.String line, int begin, int end)
java.lang.String	getBuffer()
boolean	isAttribute() check if the value from the input should be used as an attribute
protected boolean	isWord(java.lang.String mark)
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	setAttribute(boolean attribute) set indicator for the value from the input to be threated as attribute
protected void	setBuffer(java.lang.String line)
void	terminate()

Methods inherited from class org.brains2b.struct.StructRule

addTransformat, getParent, getTransformats, insertTransformat, 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

Field Detail

LEFTQUOTE

protected static final char[] LEFTQUOTE

m_startPos

protected Position m_startPos

m_endPos

protected Position m_endPos

Constructor Detail

MarkRule

public MarkRule(java.lang.String start,
                java.lang.String end,
                java.lang.Object out,
                boolean attribute)

MarkRule

public MarkRule(java.lang.String start,
                Position endPos,
                java.lang.Object out,
                boolean attribute)

MarkRule

public MarkRule(Position startPos,
                java.lang.String end,
                java.lang.Object out,
                boolean attribute)

MarkRule

public MarkRule(Position startPos,
                Position endPos,
                java.lang.Object out,
                boolean attribute)

Method Detail

readline

public void readline(java.lang.String line)

Description copied from class: StructRule

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 class StructRule

Parameters:

line - String, the line to be read

See Also:

StructRule.readline(String)

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 class StructRule

Parameters:

line - String, the line to be read

lineno - int, the linenumber of this line

See Also:

StructParser

findQuote

protected static final boolean findQuote(java.lang.String line,
                                         int begin,
                                         int end)

isWord

protected boolean isWord(java.lang.String mark)

setBuffer

protected void setBuffer(java.lang.String line)

getBuffer

public java.lang.String getBuffer()

clearBuffer

protected void clearBuffer()

Description copied from class: StructRule

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

isAttribute

public boolean isAttribute()

check if the value from the input should be used as an attribute

Returns:

boolean

setAttribute

public void setAttribute(boolean attribute)

set indicator for the value from the input to be threated as attribute

Parameters:

attribute - The attribute to set

terminate

public void terminate()