org.mpxj.primavera

Class StructuredTextParser

java.lang.Object

org.mpxj.primavera.StructuredTextParser

public class StructuredTextParser
extends Object

Parses structured text and returns a StructuredTextRecord representing the data encoded as structured text. See StructuredTextRecord for a brief description of the structured text format.

Field Summary

Fields

Modifier and Type	Field and Description
static Charset	DEFAULT_CHARSET

Constructor Summary

Constructors

Constructor and Description
StructuredTextParser()

Method Summary

Modifier and Type	Method and Description
StructuredTextRecord	parse(InputStream is) Parse structured text from an InputStream and return the resulting data.
StructuredTextRecord	parse(InputStream is, Charset charset) Parse structured text from an InputStream and return the resulting data.
StructuredTextRecord	parse(String text) Parse structured text from a String and return the resulting data.
void	setRaiseExceptionOnParseError(boolean raiseExceptionOnParseError) By default, if unexpected structure is encountered while parsing structured text, the parser will raise a StructuredTextParseException.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CHARSET

public static final Charset DEFAULT_CHARSET

Constructor Detail

StructuredTextParser

public StructuredTextParser()

Method Detail

setRaiseExceptionOnParseError

public void setRaiseExceptionOnParseError(boolean raiseExceptionOnParseError)

By default, if unexpected structure is encountered while parsing structured text, the parser will raise a StructuredTextParseException. In some cases the structured text already parsed will have yielded useful data. Setting this flag to true will allow the parser to fail silently and return as much of the data as it has been able to extract.

Parameters:

raiseExceptionOnParseError - set to true to ignore structure errors

parse

public StructuredTextRecord parse(InputStream is)

Parse structured text from an InputStream and return the resulting data. The default character set (Windows 1252) is used.

Parameters:

is - InputStream instance

Returns:

StructuredTextRecord instance

parse

public StructuredTextRecord parse(InputStream is,
                                  Charset charset)

Parse structured text from an InputStream and return the resulting data. The caller supplies the character set to be used.

Parameters:

is - InputStream instance

charset - character set to use

Returns:

StructuredTextRecord instance

parse

public StructuredTextRecord parse(String text)

Parse structured text from a String and return the resulting data.

Parameters:

text - String containing structured text

Returns:

StructuredTextRecord instance