edu.mit.jverbnet.util.parse
Interface ITaggedHandler<T>

Type Parameters:

T - The type of element into which the tagged block is transformed

All Superinterfaces:

org.xml.sax.ContentHandler, IHasParserHandler

All Known Implementing Classes:

ArgHandler, CDataHandler, FrameHandler, LazyForwardingHandler, ListHandler, MappedHandler, MemberHandler, PredicateDescHandler, RestrictionHandler, SelRestrictionsHandler, SemanticDescHandler, SyntaxArgDescHandler, SyntaxDescHandler, ThematicRoleHandler, VerbClassHandler

public interface ITaggedHandler<T>
extends IHasParserHandler

A handler that is designed to process a block of XML designated with a particular tag.

Since:

JVerbnet 1.0.0

Version:

1.2.0

Author:

Mark A. Finlayson

Method Summary

void	clear() Clears the state of the handler.
T	getElement() Returns the object representing the data in the parsed tagged block.
org.xml.sax.ContentHandler	getParent() Returns the parent of this child handler.
java.lang.String	getTag() Returns the tag that is handled by this handler.
java.util.List<ITaggedBlockTaskHandler>	getTaggedBlockTasks() Returns the list of task handlers that are run when the tagged block is entered and exited.
void	setParent(org.xml.sax.ContentHandler parent) Sets the parent for this handler.

Methods inherited from interface edu.mit.jverbnet.util.parse.IHasParserHandler

getParser, setParser

Methods inherited from interface org.xml.sax.ContentHandler

characters, endDocument, endElement, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startDocument, startElement, startPrefixMapping

Method Detail

getTag

java.lang.String getTag()

Returns the tag that is handled by this handler. Will never be null or empty, and will be trimmed of leading and trailing whitespace.

Returns:

the non-null, non-empty, trimmed tag that is handled by this handler

Since:

JVerbnet 1.0.0

getParent

org.xml.sax.ContentHandler getParent()

Returns the parent of this child handler. If the handler has no parent, will return null.

Returns:

the possibly null parent of this child handler

Since:

JVerbnet 1.0.0

setParent

void setParent(org.xml.sax.ContentHandler parent)

Sets the parent for this handler. The new parent may be null

Parameters:

parent - the new parent for the handler; may be null

Since:

JVerbnet 1.0.0

getTaggedBlockTasks

java.util.List<ITaggedBlockTaskHandler> getTaggedBlockTasks()

Returns the list of task handlers that are run when the tagged block is entered and exited. The list may be modified. Tasks are run in order.

Returns:

the list of tasks to be run when entering and exiting the tagged block

Since:

JVerbnet 1.0.0

clear

void clear()

Clears the state of the handler. This method should be called before control of the parser is passed to this handler.

Since:

JVerbnet 1.0.0

getElement

T getElement()

Returns the object representing the data in the parsed tagged block.

Returns:

the object representing the data in the parsed tagged block

Since:

JVerbnet 1.0.0