scala.xml.include.sax

XIncludeFilter

class XIncludeFilter extends XMLFilterImpl

This is a SAX filter which resolves all XInclude include elements before passing them on to the client application. Currently this class has the following known deviation from the XInclude specification:

  1. XPointer is not supported.

Furthermore, I would definitely use a new instance of this class for each document you want to process. I doubt it can be used successfully on multiple documents. Furthermore, I can virtually guarantee that this class is not thread safe. You have been warned.

Since this class is not designed to be subclassed, and since I have not yet considered how that might affect the methods herein or what other protected methods might be needed to support subclasses, I have declared this class final. I may remove this restriction later, though the use-case for subclassing is weak. This class is designed to have its functionality extended via a horizontal chain of filters, not a vertical hierarchy of sub and superclasses.

To use this class:

e.g.

val includer = new XIncludeFilter(base)
includer setParent parser
includer setContentHandler new SAXXIncluder(System.out)
includer parse args(i)

translated from Elliotte Rusty Harold's Java source.

Source
XIncludeFilter.scala
Linear Supertypes
XMLFilterImpl, ErrorHandler, ContentHandler, DTDHandler, org.xml.sax.EntityResolver, XMLFilter, XMLReader, AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. XIncludeFilter
  2. XMLFilterImpl
  3. ErrorHandler
  4. ContentHandler
  5. DTDHandler
  6. EntityResolver
  7. XMLFilter
  8. XMLReader
  9. AnyRef
  10. Any
Implicitly
  1. by StringAdd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new XIncludeFilter()

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from XIncludeFilter to StringAdd[XIncludeFilter] performed by method StringAdd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (XIncludeFilter, B)

    Implicit information
    This member is added by an implicit conversion from XIncludeFilter to ArrowAssoc[XIncludeFilter] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. final val XINCLUDE_NAMESPACE: String("http://www.w3.org/2001/XInclude")

  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  10. def characters(ch: Array[Char], start: Int, length: Int): Unit

    Definition Classes
    XIncludeFilter → XMLFilterImpl → ContentHandler
  11. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. def endDocument(): Unit

    Definition Classes
    XIncludeFilter → XMLFilterImpl → ContentHandler
  13. def endElement(uri: String, localName: String, qName: String): Unit

    Definition Classes
    XIncludeFilter → XMLFilterImpl → ContentHandler
  14. def endPrefixMapping(prefix: String): Unit

    Definition Classes
    XIncludeFilter → XMLFilterImpl → ContentHandler
  15. def ensuring(cond: (XIncludeFilter) ⇒ Boolean, msg: ⇒ Any): XIncludeFilter

    Implicit information
    This member is added by an implicit conversion from XIncludeFilter to Ensuring[XIncludeFilter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: (XIncludeFilter) ⇒ Boolean): XIncludeFilter

    Implicit information
    This member is added by an implicit conversion from XIncludeFilter to Ensuring[XIncludeFilter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean, msg: ⇒ Any): XIncludeFilter

    Implicit information
    This member is added by an implicit conversion from XIncludeFilter to Ensuring[XIncludeFilter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: Boolean): XIncludeFilter

    Implicit information
    This member is added by an implicit conversion from XIncludeFilter to Ensuring[XIncludeFilter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  20. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  21. def error(arg0: org.xml.sax.SAXParseException): Unit

    Definition Classes
    XMLFilterImpl → ErrorHandler
    Annotations
    @throws( classOf[org.xml.sax.SAXException] )
  22. def fatalError(arg0: org.xml.sax.SAXParseException): Unit

    Definition Classes
    XMLFilterImpl → ErrorHandler
    Annotations
    @throws( classOf[org.xml.sax.SAXException] )
  23. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  24. def formatted(fmtstr: String): String

    Returns string formatted according to given format string.

    Returns string formatted according to given format string. Format strings are as for String.format (@see java.lang.String.format).

    Implicit information
    This member is added by an implicit conversion from XIncludeFilter to StringFormat[XIncludeFilter] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  25. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  26. def getContentHandler(): ContentHandler

    Definition Classes
    XMLFilterImpl → XMLReader
  27. def getDTDHandler(): DTDHandler

    Definition Classes
    XMLFilterImpl → XMLReader
  28. def getEntityResolver(): org.xml.sax.EntityResolver

    Definition Classes
    XMLFilterImpl → XMLReader
  29. def getErrorHandler(): ErrorHandler

    Definition Classes
    XMLFilterImpl → XMLReader
  30. def getFeature(arg0: String): Boolean

    Definition Classes
    XMLFilterImpl → XMLReader
    Annotations
    @throws( ... ) @throws( ... )
  31. def getParent(): XMLReader

    Definition Classes
    XMLFilterImpl → XMLFilter
  32. def getProperty(arg0: String): AnyRef

    Definition Classes
    XMLFilterImpl → XMLReader
    Annotations
    @throws( ... ) @throws( ... )
  33. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  34. def ignorableWhitespace(ch: Array[Char], start: Int, length: Int): Unit

    Definition Classes
    XIncludeFilter → XMLFilterImpl → ContentHandler
  35. def insideIncludeElement(): Boolean

    This utility method returns true if and only if this reader is currently inside a non-empty include element.

    This utility method returns true if and only if this reader is currently inside a non-empty include element. (This is not the same as being inside the node set which replaces the include element.) This is primarily needed for comments inside include elements. It must be checked by the actual LexicalHandler to see whether a comment is passed or not.

    returns

    boolean

  36. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  37. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  38. def notationDecl(arg0: String, arg1: String, arg2: String): Unit

    Definition Classes
    XMLFilterImpl → DTDHandler
    Annotations
    @throws( classOf[org.xml.sax.SAXException] )
  39. final def notify(): Unit

    Definition Classes
    AnyRef
  40. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  41. def parse(arg0: String): Unit

    Definition Classes
    XMLFilterImpl → XMLReader
    Annotations
    @throws( classOf[java.io.IOException] ) @throws( classOf[org.xml.sax.SAXException] )
  42. def parse(arg0: org.xml.sax.InputSource): Unit

    Definition Classes
    XMLFilterImpl → XMLReader
    Annotations
    @throws( classOf[java.io.IOException] ) @throws( classOf[org.xml.sax.SAXException] )
  43. def processingInstruction(target: String, data: String): Unit

    Definition Classes
    XIncludeFilter → XMLFilterImpl → ContentHandler
  44. def resolveEntity(arg0: String, arg1: String): org.xml.sax.InputSource

    Definition Classes
    XMLFilterImpl → EntityResolver
    Annotations
    @throws( classOf[java.io.IOException] ) @throws( classOf[org.xml.sax.SAXException] )
  45. def setContentHandler(arg0: ContentHandler): Unit

    Definition Classes
    XMLFilterImpl → XMLReader
  46. def setDTDHandler(arg0: DTDHandler): Unit

    Definition Classes
    XMLFilterImpl → XMLReader
  47. def setDocumentLocator(locator: Locator): Unit

    Definition Classes
    XIncludeFilter → XMLFilterImpl → ContentHandler
  48. def setEntityResolver(arg0: org.xml.sax.EntityResolver): Unit

    Definition Classes
    XMLFilterImpl → XMLReader
  49. def setErrorHandler(arg0: ErrorHandler): Unit

    Definition Classes
    XMLFilterImpl → XMLReader
  50. def setFeature(arg0: String, arg1: Boolean): Unit

    Definition Classes
    XMLFilterImpl → XMLReader
    Annotations
    @throws( ... ) @throws( ... )
  51. def setParent(arg0: XMLReader): Unit

    Definition Classes
    XMLFilterImpl → XMLFilter
  52. def setProperty(arg0: String, arg1: Any): Unit

    Definition Classes
    XMLFilterImpl → XMLReader
    Annotations
    @throws( ... ) @throws( ... )
  53. def skippedEntity(name: String): Unit

    Definition Classes
    XIncludeFilter → XMLFilterImpl → ContentHandler
  54. def startDocument(): Unit

    Definition Classes
    XIncludeFilter → XMLFilterImpl → ContentHandler
  55. def startElement(uri: String, localName: String, qName: String, atts1: Attributes): Unit

    Definition Classes
    XIncludeFilter → XMLFilterImpl → ContentHandler
  56. def startPrefixMapping(prefix: String, uri: String): Unit

    Definition Classes
    XIncludeFilter → XMLFilterImpl → ContentHandler
  57. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  58. def toString(): String

    Definition Classes
    AnyRef → Any
  59. def unparsedEntityDecl(arg0: String, arg1: String, arg2: String, arg3: String): Unit

    Definition Classes
    XMLFilterImpl → DTDHandler
    Annotations
    @throws( classOf[org.xml.sax.SAXException] )
  60. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  61. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  62. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  63. def warning(arg0: org.xml.sax.SAXParseException): Unit

    Definition Classes
    XMLFilterImpl → ErrorHandler
    Annotations
    @throws( classOf[org.xml.sax.SAXException] )
  64. def [B](y: B): (XIncludeFilter, B)

    Implicit information
    This member is added by an implicit conversion from XIncludeFilter to ArrowAssoc[XIncludeFilter] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from XMLFilterImpl

Inherited from ErrorHandler

Inherited from ContentHandler

Inherited from DTDHandler

Inherited from org.xml.sax.EntityResolver

Inherited from XMLFilter

Inherited from XMLReader

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion StringAdd from XIncludeFilter to StringAdd[XIncludeFilter]

Inherited by implicit conversion StringFormat from XIncludeFilter to StringFormat[XIncludeFilter]

Inherited by implicit conversion Ensuring from XIncludeFilter to Ensuring[XIncludeFilter]

Inherited by implicit conversion ArrowAssoc from XIncludeFilter to ArrowAssoc[XIncludeFilter]

Ungrouped