org.apache.fop.layout.hyphenation
Class PatternParser

java.lang.Object
  org.xml.sax.helpers.DefaultHandler
      org.apache.fop.layout.hyphenation.PatternParser

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler, PatternConsumer

public class PatternParser

extends DefaultHandler

implements PatternConsumer

A SAX document handler to read and parse hyphenation patterns from a XML file.

Author:

Carlos Villegas

Constructor Summary

PatternParser()

PatternParser(PatternConsumer consumer)

Method Summary

void	addClass(String c) Add a character class.
void	addException(String w, ArrayList e) Add a hyphenation exception.
void	addPattern(String p, String v) Add hyphenation patterns.
void	characters(char[] ch, int start, int length) Characters.
void	endElement(String uri, String local, String raw)
void	error(SAXParseException ex) Error.
void	fatalError(SAXParseException ex) Fatal error.
protected static InputSource	fileInputSource(String filename) create an InputSource from a file name
protected String	getExceptionWord(ArrayList ex)
protected static String	getInterletterValues(String pat)
protected static String	getPattern(String word)
static void	main(String[] args)
protected ArrayList	normalizeException(ArrayList ex)
void	parse(String filename)
protected String	readToken(StringBuffer chars)
void	setConsumer(PatternConsumer consumer)
void	startElement(String uri, String local, String raw, Attributes attrs) Start element.
void	warning(SAXParseException ex) Warning.

Methods inherited from class org.xml.sax.helpers.DefaultHandler

endDocument, endPrefixMapping, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl

Methods inherited from class java.lang.Object

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

Constructor Detail

PatternParser

public PatternParser()
              throws HyphenationException

PatternParser

public PatternParser(PatternConsumer consumer)
              throws HyphenationException

Method Detail

setConsumer

public void setConsumer(PatternConsumer consumer)

parse

public void parse(String filename)
           throws HyphenationException

Throws:

HyphenationException

fileInputSource

protected static InputSource fileInputSource(String filename)
                                      throws HyphenationException

create an InputSource from a file name

Parameters:

filename - the name of the file

Returns:

the InputSource created

Throws:

HyphenationException

readToken

protected String readToken(StringBuffer chars)

getPattern

protected static String getPattern(String word)

normalizeException

protected ArrayList normalizeException(ArrayList ex)

getExceptionWord

protected String getExceptionWord(ArrayList ex)

getInterletterValues

protected static String getInterletterValues(String pat)

startElement

public void startElement(String uri,
                         String local,
                         String raw,
                         Attributes attrs)

Start element.

Specified by:

startElement in interface ContentHandler

endElement

public void endElement(String uri,
                       String local,
                       String raw)

Specified by:

endElement in interface ContentHandler

characters

public void characters(char[] ch,
                       int start,
                       int length)

Characters.

Specified by:

characters in interface ContentHandler

warning

public void warning(SAXParseException ex)

Warning.

Specified by:

warning in interface ErrorHandler

error

public void error(SAXParseException ex)

Error.

Specified by:

error in interface ErrorHandler

fatalError

public void fatalError(SAXParseException ex)
                throws SAXException

Fatal error.

Specified by:

fatalError in interface ErrorHandler

Throws:

SAXException

addClass

public void addClass(String c)

Description copied from interface: PatternConsumer

Add a character class. A character class defines characters that are considered equivalent for the purpose of hyphenation (e.g. "aA"). It usually means to ignore case.

Specified by:

addClass in interface PatternConsumer

addException

public void addException(String w,
                         ArrayList e)

Description copied from interface: PatternConsumer

Add a hyphenation exception. An exception replaces the result obtained by the algorithm for cases for which this fails or the user wants to provide his own hyphenation. A hyphenatedword is a ArrayList of alternating String's and Hyphen instances

Specified by:

addException in interface PatternConsumer

addPattern

public void addPattern(String p,
                       String v)

Description copied from interface: PatternConsumer

Add hyphenation patterns.

Specified by:

addPattern in interface PatternConsumer

Parameters:

p -

v - interletter values expressed as a string of digit characters.

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception