org.brains2b.struct.absolute

Class PositionRule

java.lang.Object

org.brains2b.struct.StructRule

org.brains2b.struct.absolute.PositionRule

public class PositionRule
extends StructRule

[short comment] [long comment]

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

Constructor Summary

Constructors

Constructor and Description
PositionRule(int begin, int end, java.lang.String objectId) Constructor to define a start and end position and the object id
PositionRule(int begin, java.lang.String out) Constructor to define a start and the object id

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

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

Constructor Detail

PositionRule

public PositionRule(int begin,
                    int end,
                    java.lang.String objectId)

Constructor to define a start and end position and the object id

Parameters:

begin - int, begin position of this value

end - int, end position of this value

objectId - String id for the value read

PositionRule

public PositionRule(int begin,
                    java.lang.String out)

Constructor to define a start and the object id

The end will be the end-of-the line

Parameters:

begin - int, begin position of this value

out - String id for the value read

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