org.daisy.dotify.api.obfl

Interface ObflParser

public interface ObflParser

Provides an OBFL-parser. The parser reads an OBFL-file and places its contents in a formatter instance.

Method Summary

Modifier and Type	Method and Description
java.util.List<MetaDataItem>	getMetaData() Gets a list of meta data items collected by the latest call to parse(XMLEventReader, Formatter).
void	parse(javax.xml.stream.XMLEventReader input, Formatter formatter) Parses the input places its contents in the supplied formatter.

Method Detail

parse

void parse(javax.xml.stream.XMLEventReader input,
           Formatter formatter)
    throws FormatterException,
           ObflParserException

Parses the input places its contents in the supplied formatter.

Parameters:

input - the OBFL

formatter - the formatter

Throws:

FormatterException - if there is a problem writing contents to the formatter

ObflParserException - if there is a problem reading the OBFL

getMetaData

java.util.List<MetaDataItem> getMetaData()

Gets a list of meta data items collected by the latest call to parse(XMLEventReader, Formatter).

Returns:

returns a list of meta data items