org.tentackle.model.parser

Class Document

java.lang.Object

org.tentackle.model.parser.Document

public class Document
extends Object

The input document.

Author:

harald

Constructor Summary

Constructors

Constructor and Description
Document(String text) Creates a document.

Method Summary

Modifier and Type	Method and Description
int	getLineNumber(int offsetInDocument) Gets the line number for a given offset within the document.
List<Line>	getLines() Gets the parsed lines.
SourceInfo	getSourceInfo() Gets the source info.
String	getText() Gets the document text.
protected Line	nextLine(Line currentLine) Gets the next line.
protected List<Line>	parse() Parses the document and returns a list of lines.

Methods inherited from class java.lang.Object

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

Constructor Detail

Document

public Document(String text)

Creates a document.

Parameters:

text - the model specification source

Method Detail

getText

public String getText()

Gets the document text.

Returns:

the document text

getSourceInfo

public SourceInfo getSourceInfo()

Gets the source info.

Returns:

the info, null if unknown

getLines

public List<Line> getLines()
                    throws ModelException

Gets the parsed lines.

Returns:

the lines, never null

Throws:

ModelException - if parsing failed

getLineNumber

public int getLineNumber(int offsetInDocument)

Gets the line number for a given offset within the document.

Parameters:

offsetInDocument - the offset

Returns:

the linenumber starting at 1

parse

protected List<Line> parse()
                    throws ModelException

Parses the document and returns a list of lines.

Returns:

the list of lines, never null

Throws:

ModelException - if parsing failed

nextLine

protected Line nextLine(Line currentLine)
                 throws ModelException

Gets the next line.

Parameters:

currentLine - the current line, null if start of document

Returns:

the line, null if reached end of document

Throws:

ModelException - if parsing failed