Class XMLWorker

    • Constructor Summary

      Constructors 
      Constructor Description
      XMLWorker​(Pipeline<?> pipeline, boolean parseHtml)
      Constructs a new XMLWorker
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void close()
      Triggered when parsing is finished and the stream will be closed.
      protected static void closeLocalWC()  
      void comment​(java.lang.String comment)
      Triggered for comments that are found.
      protected Tag createTag​(java.lang.String tag, java.util.Map<java.lang.String,​java.lang.String> attr, java.lang.String ns)
      Creates a new Tag object from the given parameters.
      void endElement​(java.lang.String tag, java.lang.String ns)
      Triggered on a closing tag.
      protected Tag getCurrentTag()
      Returns the current tag.
      protected static WorkerContext getLocalWC()
      Returns the local WorkerContext, beware: could be a newly initialized one, if close() or closeLocalWC() has been called before.
      protected boolean ignoreCdata()  
      void init()
      Triggered when parsing has started.
      void startElement​(java.lang.String tag, java.util.Map<java.lang.String,​java.lang.String> attr, java.lang.String ns)
      Triggered on an opening tag.
      void text​(java.lang.String text)
      This method passes encountered text to the pipeline via the Pipeline.content(WorkerContext, Tag, String, ProcessObject) method.
      void unknownText​(java.lang.String text)
      Triggered for text found outside root tag.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • rootpPipe

        protected final Pipeline<?> rootpPipe
      • parseHtml

        protected final boolean parseHtml
    • Constructor Detail

      • XMLWorker

        public XMLWorker​(Pipeline<?> pipeline,
                         boolean parseHtml)
        Constructs a new XMLWorker
        Parameters:
        pipeline - the pipeline
        parseHtml - true if this XMLWorker is parsing HTML, this actually just means: convert all tags to lowercase.
    • Method Detail

      • startElement

        public void startElement​(java.lang.String tag,
                                 java.util.Map<java.lang.String,​java.lang.String> attr,
                                 java.lang.String ns)
        Description copied from interface: XMLParserListener
        Triggered on an opening tag.
        Specified by:
        startElement in interface XMLParserListener
        Parameters:
        tag - the tag of the element
        attr - the attributes found on the tag
        ns - the namespace or empty String
      • createTag

        protected Tag createTag​(java.lang.String tag,
                                java.util.Map<java.lang.String,​java.lang.String> attr,
                                java.lang.String ns)
        Creates a new Tag object from the given parameters.
        Parameters:
        tag - the tag name
        attr - the attributes
        ns - the namespace if any
        Returns:
        a Tag
      • endElement

        public void endElement​(java.lang.String tag,
                               java.lang.String ns)
        Description copied from interface: XMLParserListener
        Triggered on a closing tag.
        Specified by:
        endElement in interface XMLParserListener
        Parameters:
        tag - the tag
        ns - the namespace or empty String
      • unknownText

        public void unknownText​(java.lang.String text)
        Description copied from interface: XMLParserListener
        Triggered for text found outside root tag.
        Specified by:
        unknownText in interface XMLParserListener
        Parameters:
        text - the text
      • comment

        public void comment​(java.lang.String comment)
        Description copied from interface: XMLParserListener
        Triggered for comments that are found.
        Specified by:
        comment in interface XMLParserListener
        Parameters:
        comment - the comment
      • close

        public void close()
        Description copied from interface: XMLParserListener
        Triggered when parsing is finished and the stream will be closed.
        Specified by:
        close in interface XMLParserListener
      • getCurrentTag

        protected Tag getCurrentTag()
        Returns the current tag.
        Returns:
        the current tag
      • getLocalWC

        protected static WorkerContext getLocalWC()
        Returns the local WorkerContext, beware: could be a newly initialized one, if close() or closeLocalWC() has been called before.
        Returns:
        the local WorkerContext
      • closeLocalWC

        protected static void closeLocalWC()
      • ignoreCdata

        protected boolean ignoreCdata()