edu.mit.jverbnet.parse
Class RestrictionHandler<T extends IVerbnetType>

java.lang.Object
  org.xml.sax.helpers.DefaultHandler
      edu.mit.jverbnet.util.parse.MappedHandler<java.util.Map.Entry<T,java.lang.Boolean>>
          edu.mit.jverbnet.parse.RestrictionHandler<T>

All Implemented Interfaces:

IHasParserHandler, ITaggedBlockTaskHandler, ITaggedHandler<java.util.Map.Entry<T,java.lang.Boolean>>, org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler

public class RestrictionHandler<T extends IVerbnetType>
extends MappedHandler<java.util.Map.Entry<T,java.lang.Boolean>>

Handles Verbnet XML blocks tagged with "SELRESTR" or "SYNRESTR".

Since:

JVerbnet 1.0.0

Version:

1.2.0

Author:

Mark A. Finlayson

Field Summary

static java.lang.String	XML_TAG_SELRESTR
static java.lang.String	XML_TAG_SYNRESTR

Fields inherited from class edu.mit.jverbnet.util.parse.MappedHandler

messageIgnoringElementBlockExternal, messageMatcherIgnoreExternal, messageMatcherIgnoreInternal, messageParserNotSet, messageUnmappedElementBlockInternal, tagStack

Constructor Summary

RestrictionHandler(boolean isSelRestr, java.lang.Class<T> verbnetTypeClass)
Creates a new RestrictionHandler with no parent or parser.

RestrictionHandler(IHasParserHandler parent, boolean isSelRestr, java.lang.Class<T> verbnetTypeClass)
Creates a new RestrictionHandler with the specified parent.

RestrictionHandler(org.xml.sax.XMLReader parser, boolean isSelRestr, java.lang.Class<T> verbnetTypeClass)
Creates a new RestrictionHandler with the specified parser.

RestrictionHandler(org.xml.sax.XMLReader parser, org.xml.sax.ContentHandler parent, boolean isSelRestr, java.lang.Class<T> verbnetTypeClass)
Creates a new RestrictionHandler with the specified parser and parent.

Method Summary

protected void	clearLocal() Subclasses may override this method to add code to be invoked when MappedHandler.clear() is called.
java.util.Map.Entry<T,java.lang.Boolean>	doGetElement() If subclasses intend to use the MappedHandler.getElement() method, they should override this method to provide the code that constructs the object corresponding to the tagged block.
void	startTaggedBlock(java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes attrs) This method is used to run code when entering a tagged block.

Methods inherited from class edu.mit.jverbnet.util.parse.MappedHandler

checkParserSet, clear, endElement, endTaggedBlock, getDocumentLocator, getElement, getHandlerMappings, getParent, getParser, getTag, getTaggedBlockTasks, handleUnmappedEndElement, handleUnmappedStartElement, initHandlerMap, isInsideTaggedBlock, reportWarning, reportWarnings, setDocumentLocator, setParent, setParser, setReportWarnings, startElement

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

characters, endDocument, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xml.sax.ContentHandler

characters, endDocument, endPrefixMapping, ignorableWhitespace, processingInstruction, skippedEntity, startDocument, startPrefixMapping

Field Detail

XML_TAG_SELRESTR

public static final java.lang.String XML_TAG_SELRESTR

See Also:

Constant Field Values

XML_TAG_SYNRESTR

public static final java.lang.String XML_TAG_SYNRESTR

See Also:

Constant Field Values

Constructor Detail

RestrictionHandler

public RestrictionHandler(boolean isSelRestr,
                          java.lang.Class<T> verbnetTypeClass)

Creates a new RestrictionHandler with no parent or parser.

Parameters:

isSelRestr - whether this is a semantic restriction (true) or syntactic restriction (false).

verbnetTypeClass - the verbnet type used in this restriction

Since:

JVerbnet 1.0.0

RestrictionHandler

public RestrictionHandler(IHasParserHandler parent,
                          boolean isSelRestr,
                          java.lang.Class<T> verbnetTypeClass)

Creates a new RestrictionHandler with the specified parent.

Parameters:

parent - the parent of the handler; may be null

isSelRestr - whether this is a semantic restriction (true) or syntactic restriction (false).

verbnetTypeClass - the verbnet type used in this restriction

Since:

JVerbnet 1.0.0

RestrictionHandler

public RestrictionHandler(org.xml.sax.XMLReader parser,
                          boolean isSelRestr,
                          java.lang.Class<T> verbnetTypeClass)

Creates a new RestrictionHandler with the specified parser.

Parameters:

parser - the parser of the handler; may be null

isSelRestr - whether this is a semantic restriction (true) or syntactic restriction (false).

verbnetTypeClass - the verbnet type used in this restriction

Since:

JVerbnet 1.0.0

RestrictionHandler

public RestrictionHandler(org.xml.sax.XMLReader parser,
                          org.xml.sax.ContentHandler parent,
                          boolean isSelRestr,
                          java.lang.Class<T> verbnetTypeClass)

Creates a new RestrictionHandler with the specified parser and parent.

Parameters:

parser - the parent of the handler; may be null

parent - the parser of the handler; may be null

isSelRestr - whether this is a semantic restriction (true) or syntactic restriction (false).

verbnetTypeClass - the verbnet type used in this restriction

Since:

JVerbnet 1.0.0

Method Detail

clearLocal

protected void clearLocal()

Description copied from class: MappedHandler

Subclasses may override this method to add code to be invoked when MappedHandler.clear() is called.

Overrides:

clearLocal in class MappedHandler<java.util.Map.Entry<T extends IVerbnetType,java.lang.Boolean>>

startTaggedBlock

public void startTaggedBlock(java.lang.String uri,
                             java.lang.String localName,
                             java.lang.String qName,
                             org.xml.sax.Attributes attrs)
                      throws org.xml.sax.SAXException

Description copied from interface: ITaggedBlockTaskHandler

This method is used to run code when entering a tagged block.

Specified by:

startTaggedBlock in interface ITaggedBlockTaskHandler

Overrides:

startTaggedBlock in class MappedHandler<java.util.Map.Entry<T extends IVerbnetType,java.lang.Boolean>>

Parameters:

uri - the Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed

localName - the local name (without prefix), or the empty string if Namespace processing is not being performed

qName - the qualified name (with prefix), or the empty string if qualified names are not available

attrs - the attributes attached to the element. If there are no attributes, it shall be an empty Attributes object. The value of this object after startElement returns is undefined

Throws:

org.xml.sax.SAXException - any SAX exception, possibly wrapping another exception

doGetElement

public java.util.Map.Entry<T,java.lang.Boolean> doGetElement()

Description copied from class: MappedHandler

If subclasses intend to use the MappedHandler.getElement() method, they should override this method to provide the code that constructs the object corresponding to the tagged block.

Overrides:

doGetElement in class MappedHandler<java.util.Map.Entry<T extends IVerbnetType,java.lang.Boolean>>

Returns:

the object corresponding to the tagged block