Class StandardsExtractingContentHandler

All Implemented Interfaces:
ContentHandler, DTDHandler, EntityResolver, ErrorHandler

public class StandardsExtractingContentHandler extends ContentHandlerDecorator
StandardsExtractingContentHandler is a Content Handler used to extract standard references while parsing.

This handler relies on complex regular expressions which can be slow on some types of input data.

  • Field Details

  • Constructor Details

    • StandardsExtractingContentHandler

      public StandardsExtractingContentHandler(ContentHandler handler, Metadata metadata)
      Creates a decorator for the given SAX event handler and Metadata object.
      handler - SAX event handler to be decorated.
      metadata - Metadata object.
    • StandardsExtractingContentHandler

      protected StandardsExtractingContentHandler()
      Creates a decorator that by default forwards incoming SAX events to a dummy content handler that simply ignores all the events. Subclasses should use the ContentHandlerDecorator.setContentHandler(ContentHandler) method to switch to a more usable underlying content handler. Also creates a dummy Metadata object to store phone numbers in.
  • Method Details

    • getThreshold

      public double getThreshold()
      Gets the threshold to be used for selecting the standard references found within the text based on their score.
      the threshold to be used for selecting the standard references found within the text based on their score.
    • setThreshold

      public void setThreshold(double score)
      Sets the score to be used as threshold.
      score - the score to be used as threshold.
    • characters

      public void characters(char[] ch, int start, int length) throws SAXException
      The characters method is called whenever a Parser wants to pass raw characters to the ContentHandler. However, standard references are often split across different calls to characters, depending on the specific Parser used. Therefore, we simply add all characters to a StringBuilder and analyze it once the document is finished.
      Specified by:
      characters in interface ContentHandler
      characters in class ContentHandlerDecorator
    • endDocument

      public void endDocument() throws SAXException
      This method is called whenever the Parser is done parsing the file. So, we check the output for any standard references.
      Specified by:
      endDocument in interface ContentHandler
      endDocument in class ContentHandlerDecorator
    • setMaxBufferLength

      public void setMaxBufferLength(int maxBufferLength)
      The number of characters to store in memory for checking for standards. If this is unbounded, the complex regular expressions can take a long time to process some types of data. Only increase this limit with great caution.