ch.qos.logback.core.joran.spi

Class SaxEventInterpreter

java.lang.Object

ch.qos.logback.core.joran.spi.SaxEventInterpreter

public class SaxEventInterpreter
extends Object

SaxEventInterpreter is Joran's driving class for handling "low-level" SAX events. It extends SAX DefaultHandler which invokes various actions according to predefined patterns.

Patterns are kept in a RuleStore which is programmed to store and then later produce the applicable actions for a given pattern.

The pattern corresponding to a top level <a> element is the string "a".

The pattern corresponding to an element <b> embedded within a top level <a> element is the string "a/b".

The pattern corresponding to an <b> and any level of nesting is "*/b. Thus, the * character placed at the beginning of a pattern serves as a wildcard for the level of nesting. Conceptually, this is very similar to the API of commons-digester. Joran offers several small advantages. First and foremost, it offers support for implicit actions which result in a significant leap in flexibility. Second, in our opinion better error reporting capability. Third, it is self-reliant. It does not depend on other APIs, in particular commons-logging which is too unreliable. Last but not least, Joran is quite tiny and is expected to remain so.

Author:

Ceki Gülcü

Constructor Summary

Constructors

Constructor and Description
SaxEventInterpreter(Context context, RuleStore rs, ElementPath initialElementPath)

Method Summary

Modifier and Type	Method and Description
void	addImplicitAction(Action ia)
void	addImplicitActions(List<Action> actionList)
void	characters(BodyEvent be)
SaxEventInterpreter	duplicate(ElementPath initial)
void	endElement(EndEvent endEvent)
ElementPath	getCopyOfElementPath()
EventPlayer	getEventPlayer()
InterpretationContext	getInterpretationContext()
Locator	getLocator()
RuleStore	getRuleStore()
void	setDocumentLocator(Locator l)
void	setInterpretationContextPropertiesMap(Map<String,String> propertiesMap)
void	startDocument()
void	startElement(StartEvent se)

Methods inherited from class java.lang.Object

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

Constructor Detail

SaxEventInterpreter

public SaxEventInterpreter(Context context,
                           RuleStore rs,
                           ElementPath initialElementPath)

Method Detail

duplicate

public SaxEventInterpreter duplicate(ElementPath initial)

getEventPlayer

public EventPlayer getEventPlayer()

getCopyOfElementPath

public ElementPath getCopyOfElementPath()

setInterpretationContextPropertiesMap

public void setInterpretationContextPropertiesMap(Map<String,String> propertiesMap)

getInterpretationContext

public InterpretationContext getInterpretationContext()

startDocument

public void startDocument()

startElement

public void startElement(StartEvent se)

characters

public void characters(BodyEvent be)

endElement

public void endElement(EndEvent endEvent)

getLocator

public Locator getLocator()

setDocumentLocator

public void setDocumentLocator(Locator l)

addImplicitActions

public void addImplicitActions(List<Action> actionList)

addImplicitAction

public void addImplicitAction(Action ia)

getRuleStore

public RuleStore getRuleStore()