Package org.apache.fop.hyphenation

Class PatternParser

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.apache.fop.hyphenation.PatternParser

All Implemented Interfaces:

PatternConsumer, ContentHandler, DTDHandler, EntityResolver, ErrorHandler

public class PatternParser
extends DefaultHandler
implements PatternConsumer

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

This work was authored by Carlos Villegas (cav@uniscope.co.jp).

Field Summary

Fields

Modifier and Type	Field	Description
private PatternConsumer	consumer
private int	currElement
(package private) static final int	ELEM_CLASSES
(package private) static final int	ELEM_EXCEPTIONS
(package private) static final int	ELEM_HYPHEN
(package private) static final int	ELEM_PATTERNS
private String	errMsg
private ArrayList	exception
private boolean	hasClasses
private char	hyphenChar
private XMLReader	parser
private PrintStream	testOut
private StringBuffer	token

Constructor Summary

Constructors

Constructor	Description
PatternParser()	Construct a pattern parser.
PatternParser(PatternConsumer consumer)	Construct a pattern parser.

Method Summary

Modifier and Type	Method	Description
void	addClass(String c)	For testing purposes only.
void	addException(String w, ArrayList e)	For testing purposes only.
void	addPattern(String p, String v)	For testing purposes only.
void	characters(char[] ch, int start, int length)
void	closeTestOut()	Close test out file.
(package private) static XMLReader	createParser()	Creates a SAX parser using JAXP
void	endElement(String uri, String local, String raw)
void	error(SAXParseException ex)
void	fatalError(SAXParseException ex)
private String	getExceptionWord(ArrayList ex)
protected void	getExternalClasses()
private static String	getInterletterValues(String pat)
private String	getLocationString(SAXParseException ex)	Returns a string of the location.
private static String	getPattern(String word)
static void	main(String[] args)	Main entry point when used as an application.
private ArrayList	normalizeException(ArrayList ex)
void	parse(File file)	Parses a hyphenation pattern file.
void	parse(String filename)	Parses a hyphenation pattern file.
void	parse(InputSource source)	Parses a hyphenation pattern file.
private String	readToken(StringBuffer chars)
void	setTestOut(PrintStream testOut)	Set test out stream.
void	startElement(String uri, String local, String raw, Attributes attrs)
void	warning(SAXParseException ex)

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

Field Details

parser

private XMLReader parser

currElement

private int currElement

consumer

private PatternConsumer consumer

token

private StringBuffer token

exception

private ArrayList exception

hyphenChar

private char hyphenChar

errMsg

private String errMsg

hasClasses

private boolean hasClasses

ELEM_CLASSES

static final int ELEM_CLASSES

See Also:

• Constant Field Values

ELEM_EXCEPTIONS

static final int ELEM_EXCEPTIONS

See Also:

• Constant Field Values

ELEM_PATTERNS

static final int ELEM_PATTERNS

See Also:

• Constant Field Values

ELEM_HYPHEN

static final int ELEM_HYPHEN

See Also:

• Constant Field Values

testOut

private PrintStream testOut

Constructor Details

PatternParser

public PatternParser()
              throws HyphenationException

Construct a pattern parser.

Throws:

HyphenationException - if a hyphenation exception is raised

PatternParser

public PatternParser(PatternConsumer consumer)
              throws HyphenationException

Construct a pattern parser.

Parameters:

consumer - a pattern consumer

Throws:

HyphenationException - if a hyphenation exception is raised

Method Details

parse

public void parse(String filename)
           throws HyphenationException

Parses a hyphenation pattern file.

Parameters:

filename - the filename

Throws:

HyphenationException - In case of an exception while parsing

parse

public void parse(File file)
           throws HyphenationException

Parses a hyphenation pattern file.

Parameters:

file - the pattern file

Throws:

HyphenationException - In case of an exception while parsing

parse

public void parse(InputSource source)
           throws HyphenationException

Parses a hyphenation pattern file.

Parameters:

source - the InputSource for the file

Throws:

HyphenationException - In case of an exception while parsing

createParser

static XMLReader createParser()

Creates a SAX parser using JAXP

Returns:

the created SAX parser

readToken

private String readToken(StringBuffer chars)

getPattern

private static String getPattern(String word)

normalizeException

private ArrayList normalizeException(ArrayList ex)

getExceptionWord

private String getExceptionWord(ArrayList ex)

getInterletterValues

private static String getInterletterValues(String pat)

getExternalClasses

protected void getExternalClasses()
                           throws SAXException

Throws:

SAXException - if not caught

startElement

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

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class DefaultHandler

Throws:

SAXException

endElement

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

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class DefaultHandler

characters

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

Specified by:

characters in interface ContentHandler

Overrides:

characters in class DefaultHandler

warning

public void warning(SAXParseException ex)

Specified by:

warning in interface ErrorHandler

Overrides:

warning in class DefaultHandler

error

public void error(SAXParseException ex)

Specified by:

error in interface ErrorHandler

Overrides:

error in class DefaultHandler

fatalError

public void fatalError(SAXParseException ex)
                throws SAXException

Specified by:

fatalError in interface ErrorHandler

Overrides:

fatalError in class DefaultHandler

Throws:

SAXException

getLocationString

private String getLocationString(SAXParseException ex)

Returns a string of the location.

addClass

public void addClass(String c)

For testing purposes only. 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

Parameters:

c - character group

addException

public void addException(String w,
 ArrayList e)

For testing purposes only. 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 vector of alternating String's and Hyphen instances

Specified by:

addException in interface PatternConsumer

Parameters:

w - word to add as an exception

e - pre-hyphenated word

addPattern

public void addPattern(String p,
 String v)

For testing purposes only. Add hyphenation patterns.

Specified by:

addPattern in interface PatternConsumer

Parameters:

p - the pattern

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

setTestOut

public void setTestOut(PrintStream testOut)

Set test out stream.

Parameters:

testOut - the testOut to set

closeTestOut

public void closeTestOut()

Close test out file.

main

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

Main entry point when used as an application.

Parameters:

args - array of command line arguments

Throws:

Exception - in case of uncaught exception