Interface TagHandler

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void beginHandling​(java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes atts)
      Callback to signal the start of handling giving the tag handler a chance for running intialization routines.
      void characters​(char[] ch, int start, int length)
      Callback to signal the encounter of character content within tags.
      void endElement​(java.lang.String uri, java.lang.String localName, java.lang.String qName)
      Callback to signal the encounter of a tag end.
      void endHandling​(java.lang.String uri, java.lang.String localName, java.lang.String qName)
      Callback to signal the end of handling giving the tag handler a chance for finalizing things.
      void setDesignImporterContext​(DesignImporterContext designImporterContext)
      Sets the design importer context
      void setTagHandlerProvider​(TagHandlerProvider tagHandlerProvider)  
      void startElement​(java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes atts)
      Callback to signal the encounter of a tag start.
    • Method Detail

      • beginHandling

        void beginHandling​(java.lang.String uri,
                           java.lang.String localName,
                           java.lang.String qName,
                           org.xml.sax.Attributes atts)
                    throws DesignImportException
        Callback to signal the start of handling giving the tag handler a chance for running intialization routines.

        TagHandlers are registered against tag+attribute combination and are invoked by the HTMLContentHandler as and when it encounters a tag matching the tag attribute combination the tag handler is registered with.

        Parameters:
        uri -
        localName -
        qName -
        atts -
        Throws:
        DesignImportException
      • characters

        void characters​(char[] ch,
                        int start,
                        int length)
                 throws DesignImportException
        Callback to signal the encounter of character content within tags.
        Parameters:
        ch -
        start -
        length -
        Throws:
        org.xml.sax.SAXException
        DesignImportException
      • endElement

        void endElement​(java.lang.String uri,
                        java.lang.String localName,
                        java.lang.String qName)
                 throws DesignImportException
        Callback to signal the encounter of a tag end.
        Parameters:
        uri -
        localName -
        qName -
        Throws:
        org.xml.sax.SAXException
        DesignImportException
      • endHandling

        void endHandling​(java.lang.String uri,
                         java.lang.String localName,
                         java.lang.String qName)
                  throws DesignImportException
        Callback to signal the end of handling giving the tag handler a chance for finalizing things.

        This is arguably the last callback a tag handler receives. After this, the current tag handler is popped out from the chain and the subsequent Tika events are directed to preceding tag handlers.

        Parameters:
        uri -
        localName -
        qName -
        Throws:
        DesignImportException
      • setDesignImporterContext

        void setDesignImporterContext​(DesignImporterContext designImporterContext)
        Sets the design importer context
        Parameters:
        designImporterContext -
      • setTagHandlerProvider

        void setTagHandlerProvider​(TagHandlerProvider tagHandlerProvider)
      • startElement

        void startElement​(java.lang.String uri,
                          java.lang.String localName,
                          java.lang.String qName,
                          org.xml.sax.Attributes atts)
                   throws DesignImportException
        Callback to signal the encounter of a tag start.

        Once a tag handler begins handling, it receives the start tag events for all the nested tags within the purview of the tag this tag handler is registered against.

        Parameters:
        uri -
        localName -
        qName -
        atts -
        Throws:
        org.xml.sax.SAXException
        DesignImportException