Package gnu.xml

Class XMLFilter

java.lang.Object
gnu.xml.XMLFilter
All Implemented Interfaces:
Consumer, PositionConsumer, XConsumer, SourceLocator, Appendable, Consumer<Object>, DoubleConsumer, IntConsumer, LongConsumer, SourceLocator, ContentHandler, DocumentHandler, Locator
public class XMLFilter extends Object implements DocumentHandler, ContentHandler, SourceLocator, XConsumer, PositionConsumer
Fixup XML input events. Handles namespace resolution, and adds "namespace nodes" if needed. Does various error checking. This wrapper should be used when creating a NodeTree, as is done for XQuery node constructor expressions. Can also be called directly from XMLParser, in which case we use a slightly lower-level interface where we use char array segments rather than Strings. This is to avoid duplicate String allocation and interning. The combination XMLParser+XMLFilter+NodeTree makes for a fast and compact way to read an XML file into a DOM.

  • Field Details

    • out

      public Consumer out
      The specified target Consumer that accepts the output. In contrast, base may be either ==out or ==tlist.

    • COPY_NAMESPACES_PRESERVE

      public static final int COPY_NAMESPACES_PRESERVE
      See Also:

    • COPY_NAMESPACES_INHERIT

      public static final int COPY_NAMESPACES_INHERIT
      See Also:

    • copyNamespacesMode

      public transient int copyNamespacesMode

    • COPY_NAMESPACES_MASK

      public static final int COPY_NAMESPACES_MASK
      See Also:

    • nesting

      protected int nesting
      Twice the number of active startElement and startDocument calls.

    • stringizingLevel

      protected int stringizingLevel
      If stringizingLevel > 0 then stringize rather than copy nodes. It counts the number of nested startAttributes that are active. (In the future it should also count begun comment and processing-instruction constructors, when those support nesting.)

    • stringizingElementNesting

      protected int stringizingElementNesting
      Value of nesting just before outermost startElement while stringizingLevel > 0. I.e. if we're nested inside a element nested inside an attribute then stringizingElementNesting >= 0, otherwise stringizingElementNesting == -1.

    • ignoringLevel

      protected int ignoringLevel
      Positive if all output should be ignored. This happens if we're inside an attribute value inside an element which is stringized because it is in turn inside an outer attribute. Phew. It gets incremented by nested attributes so we can tell when to stop.

    • namespacePrefixes

      public boolean namespacePrefixes
      True if namespace declarations should be passed through as attributes. Like SAX2's http://xml.org/features/namespace-prefixes.

  • Constructor Details

    • XMLFilter

      public XMLFilter(Consumer out)

  • Method Details

    • setSourceLocator

      public void setSourceLocator(gnu.kawa.io.InPort in)

    • setSourceLocator

      public void setSourceLocator(SourceLocator locator)

    • setMessages

      public void setMessages(SourceMessages messages)

    • findNamespaceBinding

      public NamespaceBinding findNamespaceBinding(String prefix, String uri, NamespaceBinding oldBindings)
      Functionally equivalent to new NamespaceBinding(prefix, uri, oldBindings, but uses "hash consing".

    • lookupNamespaceBinding

      public gnu.xml.MappingInfo lookupNamespaceBinding(String prefix, char[] uriChars, int uriStart, int uriLength, int uriHash, NamespaceBinding oldBindings)
      Return a MappingInfo containing a match namespaces. Specifically, return a MappingInfo info is such that info.namespaces is equal to new NamespaceBinding(prefix, uri, oldBindings), where uri is new String(uriChars, uriStart, uriLength).intern()).

    • endAttribute

      public void endAttribute()
      Description copied from interface: Consumer
      End of an attribute or end of an actual parameter. The former use matches a startAttribute; the latter may not, and can be used to separate parameters in a parameter list. This double duty suggsts the method should at least be re-named.
      Specified by:
      endAttribute in interface Consumer

    • checkWriteAtomic

      protected boolean checkWriteAtomic()

    • write

      public void write(int v)
      Specified by:
      write in interface Consumer

    • writeBoolean

      public void writeBoolean(boolean v)
      Specified by:
      writeBoolean in interface Consumer

    • writeFloat

      public void writeFloat(float v)
      Specified by:
      writeFloat in interface Consumer

    • writeDouble

      public void writeDouble(double v)
      Specified by:
      writeDouble in interface Consumer

    • writeInt

      public void writeInt(int v)
      Specified by:
      writeInt in interface Consumer

    • writeLong

      public void writeLong(long v)
      Specified by:
      writeLong in interface Consumer

    • writeDocumentUri

      public void writeDocumentUri(Object uri)

    • writePosition

      public void writePosition(SeqPosition position)
      Description copied from interface: PositionConsumer
      Consume node at current position. The caller may invalidate or change the position after consume returns, so if the consumer wants to save it, it needs to copy it.
      Specified by:
      writePosition in interface PositionConsumer

    • writePosition

      public void writePosition(AbstractSequence seq, int ipos)
      Description copied from interface: PositionConsumer
      Consume a single position pair. This PositionConsumer may assume the sequence does no reference management; i.e. that copyPos is trivial and releasePos is a no-op. If that is not the case, use consume(TreePosition) instead.
      Specified by:
      writePosition in interface PositionConsumer

    • writeObject

      public void writeObject(Object v)
      If v is a node, make a copy of it.
      Specified by:
      writeObject in interface Consumer

    • write

      public void write(char[] data, int start, int length)
      Process raw text.
      Specified by:
      write in interface Consumer

    • write

      public void write(String str)
      Specified by:
      write in interface Consumer

    • write

      public void write(CharSequence str, int start, int length)
      Specified by:
      write in interface Consumer

    • linefeedFromParser

      public void linefeedFromParser()

    • textFromParser

      public void textFromParser(char[] data, int start, int length)

    • writeJoiner

      protected void writeJoiner()

    • writeCDATA

      public void writeCDATA(char[] data, int start, int length)
      Process a CDATA section. The data (starting at start for length char). Does not include the delimiters (i.e. "<![CDATA[" and "]]>" are excluded).
      Specified by:
      writeCDATA in interface XConsumer

    • startElementCommon

      protected void startElementCommon()

    • emitStartElement

      public void emitStartElement(char[] data, int start, int count)
      Process a start tag, with the given element name.

    • startElement

      public void startElement(Object type)
      Specified by:
      startElement in interface Consumer

    • startAttribute

      public void startAttribute(Object attrType)
      Description copied from interface: Consumer
      Write a attribute for the current element. This is only allowed immediately after a startElement.
      Specified by:
      startAttribute in interface Consumer

    • emitStartAttribute

      public void emitStartAttribute(char[] data, int start, int count)
      Process an attribute, with the given attribute name. The attribute value is given using write. The value is terminated by either another emitStartAttribute or an emitEndAttributes.

    • emitEndAttributes

      public void emitEndAttributes()
      Process the end of a start tag. There are no more attributes.

    • emitEndElement

      public void emitEndElement(char[] data, int start, int length)
      Process an end tag. An abbreviated tag (such as '<br/>') has a name==null.

    • endElement

      public void endElement()
      Specified by:
      endElement in interface Consumer

    • emitEntityReference

      public void emitEntityReference(char[] name, int start, int length)
      Process an entity reference. The entity name is given. This handles the predefined entities, such as "<" and """.

    • emitCharacterReference

      public void emitCharacterReference(int value, char[] name, int start, int length)
      Process a character entity reference. The string encoding of the character (e.g. "xFF" or "255") is given, as well as the character value.

    • checkValidComment

      protected void checkValidComment(char[] chars, int offset, int length)

    • writeComment

      public void writeComment(char[] chars, int start, int length)
      Process a comment. The data (starting at start for length chars). Does not include the delimiters (i.e. "" are excluded).
      Specified by:
      writeComment in interface XConsumer

    • commentFromParser

      public void commentFromParser(char[] chars, int start, int length)
      Process a comment, when called from an XML parser. The data (starting at start for length chars). Does not include the delimiters (i.e. "" are excluded).

    • writeProcessingInstruction

      public void writeProcessingInstruction(String target, char[] content, int offset, int length)
      Specified by:
      writeProcessingInstruction in interface XConsumer

    • processingInstructionFromParser

      public void processingInstructionFromParser(char[] buffer, int tstart, int tlength, int dstart, int dlength)
      Process a processing instruction.

    • startDocument

      public void startDocument()
      Specified by:
      startDocument in interface Consumer
      Specified by:
      startDocument in interface ContentHandler
      Specified by:
      startDocument in interface DocumentHandler

    • endDocument

      public void endDocument()
      Specified by:
      endDocument in interface Consumer
      Specified by:
      endDocument in interface ContentHandler
      Specified by:
      endDocument in interface DocumentHandler

    • emitDoctypeDecl

      public void emitDoctypeDecl(char[] buffer, int target, int tlength, int data, int dlength)
      Process a DOCTYPE declaration.

    • beginEntity

      public void beginEntity(Object baseUri)
      Specified by:
      beginEntity in interface XConsumer

    • endEntity

      public void endEntity()
      Specified by:
      endEntity in interface XConsumer

    • append

      public XMLFilter append(char c)
      Specified by:
      append in interface Appendable
      Specified by:
      append in interface Consumer

    • append

      public XMLFilter append(CharSequence csq)
      Specified by:
      append in interface Appendable
      Specified by:
      append in interface Consumer

    • append

      public XMLFilter append(CharSequence csq, int start, int end)
      Specified by:
      append in interface Appendable
      Specified by:
      append in interface Consumer

    • duplicateAttributeMessage

      public static String duplicateAttributeMessage(Symbol attrSymbol, Object elementName)

    • error

      public void error(char severity, String message)

    • ignoring

      public boolean ignoring()
      Description copied from interface: Consumer
      True if consumer is ignoring rest of element. The producer can use this information to skip ahead.
      Specified by:
      ignoring in interface Consumer

    • setDocumentLocator

      public void setDocumentLocator(Locator locator)
      Specified by:
      setDocumentLocator in interface ContentHandler
      Specified by:
      setDocumentLocator in interface DocumentHandler

    • startElement

      public void startElement(String namespaceURI, String localName, String qName, Attributes atts)
      Specified by:
      startElement in interface ContentHandler

    • endElement

      public void endElement(String namespaceURI, String localName, String qName)
      Specified by:
      endElement in interface ContentHandler

    • startElement

      public void startElement(String name, AttributeList atts)
      Specified by:
      startElement in interface DocumentHandler

    • endElement

      public void endElement(String name) throws SAXException
      Specified by:
      endElement in interface DocumentHandler
      Throws:
      SAXException

    • characters

      public void characters(char[] ch, int start, int length) throws SAXException
      Specified by:
      characters in interface ContentHandler
      Specified by:
      characters in interface DocumentHandler
      Throws:
      SAXException

    • ignorableWhitespace

      public void ignorableWhitespace(char[] ch, int start, int length) throws SAXException
      Specified by:
      ignorableWhitespace in interface ContentHandler
      Specified by:
      ignorableWhitespace in interface DocumentHandler
      Throws:
      SAXException

    • processingInstruction

      public void processingInstruction(String target, String data)
      Specified by:
      processingInstruction in interface ContentHandler
      Specified by:
      processingInstruction in interface DocumentHandler

    • startPrefixMapping

      public void startPrefixMapping(String prefix, String uri)
      Specified by:
      startPrefixMapping in interface ContentHandler

    • endPrefixMapping

      public void endPrefixMapping(String prefix)
      Specified by:
      endPrefixMapping in interface ContentHandler

    • skippedEntity

      public void skippedEntity(String name)
      Specified by:
      skippedEntity in interface ContentHandler

    • getPublicId

      public String getPublicId()
      Specified by:
      getPublicId in interface Locator
      Specified by:
      getPublicId in interface SourceLocator
      Specified by:
      getPublicId in interface SourceLocator

    • getSystemId

      public String getSystemId()
      Specified by:
      getSystemId in interface Locator
      Specified by:
      getSystemId in interface SourceLocator
      Specified by:
      getSystemId in interface SourceLocator

    • getFileName

      public String getFileName()
      Description copied from interface: SourceLocator
      Normally same as getSystemId.
      Specified by:
      getFileName in interface SourceLocator

    • getLineNumber

      public int getLineNumber()
      Description copied from interface: SourceLocator
      Return current line number. Normally the same as getStartLine(). The "first" line is line 1; unknown is -1.
      Specified by:
      getLineNumber in interface Locator
      Specified by:
      getLineNumber in interface SourceLocator
      Specified by:
      getLineNumber in interface SourceLocator

    • getColumnNumber

      public int getColumnNumber()
      Description copied from interface: SourceLocator
      Return current column number. Normally the same as getStartColumn(). The "first" column is column 1; unknown is -1.
      Specified by:
      getColumnNumber in interface Locator
      Specified by:
      getColumnNumber in interface SourceLocator
      Specified by:
      getColumnNumber in interface SourceLocator

    • getStartLine

      public int getStartLine()
      Description copied from interface: SourceLocator
      Line number (one-origin) of start of range; unknown/unspecified is -1.
      Specified by:
      getStartLine in interface SourceLocator

    • getStartColumn

      public int getStartColumn()
      Description copied from interface: SourceLocator
      Column (one-origin) of start of range; unknown/unspecified is -1.
      Specified by:
      getStartColumn in interface SourceLocator

    • getEndLine

      public int getEndLine()
      Description copied from interface: SourceLocator
      Line number (one-origin) of end of range; unknown/unspecified is -1.
      Specified by:
      getEndLine in interface SourceLocator

    • getEndColumn

      public int getEndColumn()
      Description copied from interface: SourceLocator
      Column (one-origin) of end of range; unknown/unspecified is -1.
      Specified by:
      getEndColumn in interface SourceLocator

    • isStableSourceLocation

      public boolean isStableSourceLocation()
      Description copied from interface: SourceLocator
      True if position is unlikely to change. True for an expression but not an input file.
      Specified by:
      isStableSourceLocation in interface SourceLocator