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:

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 a horizontal chain of filters, not a vertical hierarchy of sub and superclasses.

To use this class:

Construct an XIncludeFilter object with a known base URL Pass the XMLReader object from which the raw document will be read to the setParent() method of this object. Pass your own ContentHandler object to the setContentHandler() method of this object. This is the object which will receive events from the parsed and included document.

Optional: if you wish to receive comments, set your own LexicalHandler object as the value of this object's http://xml.org/sax/properties/lexical-handler property. Also make sure your LexicalHandler asks this object for the status of each comment using insideIncludeElement before doing anything with the comment.

Pass the URL of the document to read to this object's parse() method

e.g. XIncludeFilter 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
    authors:
  1. Burak Emir

Inherited

  1. Hide All
  2. Show all
  1. XMLFilterImpl
  2. ErrorHandler
  3. ContentHandler
  4. DTDHandler
  5. EntityResolver
  6. XMLFilter
  7. XMLReader
  8. AnyRef
  9. Any

Visibility

  1. Public
  2. All

Instance constructors

  1. new XIncludeFilter()

Value Members

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

    attributes: final
    definition classes: AnyRef
  2. def !=(arg0: Any): Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality .

    returns

    false if the receiver object is equivalent to the argument; true otherwise.

    attributes: final
    definition classes: Any
  3. def ##(): Int

    attributes: final
    definition classes: AnyRef → Any
  4. def $asInstanceOf[T0](): T0

    attributes: final
    definition classes: AnyRef
  5. def $isInstanceOf[T0](): Boolean

    attributes: final
    definition classes: AnyRef
  6. def ==(arg0: AnyRef): Boolean

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    arg0

    the object to compare against this object for equality .

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: AnyRef
  7. def ==(arg0: Any): Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality .

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: Any
  8. val XINCLUDE_NAMESPACE: String

    attributes: final
  9. def asInstanceOf[T0]: T0

    This method is used to cast the receiver object to be of type T0.

    This method is used to cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    the receiver object .

    attributes: final
    definition classes: Any
  10. def characters(ch: Array[Char], start: Int, length: Int): Unit

    definition classes: XIncludeFilter → XMLFilterImpl → ContentHandler
  11. def clone(): AnyRef

    This method creates and returns a copy of the receiver object .

    This method creates and returns a copy of the receiver object .

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object .

    attributes: protected
    definition classes: AnyRef
  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 eq(arg0: AnyRef): Boolean

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

    Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    arg0

    the object to compare against this object for reference equality .

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    attributes: final
    definition classes: AnyRef
  16. def equals(arg0: Any): Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality .

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef → Any
  17. def error(arg0: SAXParseException): Unit

    definition classes: XMLFilterImpl → ErrorHandler
  18. def fatalError(arg0: SAXParseException): Unit

    definition classes: XMLFilterImpl → ErrorHandler
  19. def finalize(): Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object .

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object .

    The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.

    attributes: protected
    definition classes: AnyRef
  20. def getClass(): java.lang.Class[_ <: java.lang.Object]

    Returns a representation that corresponds to the dynamic class of the receiver object .

    Returns a representation that corresponds to the dynamic class of the receiver object .

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object .

    attributes: final
    definition classes: AnyRef
  21. def getContentHandler(): ContentHandler

    definition classes: XMLFilterImpl → XMLReader
  22. def getDTDHandler(): DTDHandler

    definition classes: XMLFilterImpl → XMLReader
  23. def getEntityResolver(): EntityResolver

    definition classes: XMLFilterImpl → XMLReader
  24. def getErrorHandler(): ErrorHandler

    definition classes: XMLFilterImpl → XMLReader
  25. def getFeature(arg0: String): Boolean

    definition classes: XMLFilterImpl → XMLReader
  26. def getParent(): XMLReader

    definition classes: XMLFilterImpl → XMLFilter
  27. def getProperty(arg0: String): AnyRef

    definition classes: XMLFilterImpl → XMLReader
  28. def hashCode(): Int

    Returns a hash code value for the object .

    Returns a hash code value for the object .

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    returns

    the hash code value for the object .

    definition classes: AnyRef → Any
  29. def ignorableWhitespace(ch: Array[Char], start: Int, length: Int): Unit

    definition classes: XIncludeFilter → XMLFilterImpl → ContentHandler
  30. 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

  31. def isInstanceOf[T0]: Boolean

    This method is used to test whether the dynamic type of the receiver object is T0.

    This method is used to test whether the dynamic type of the receiver object is T0.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    attributes: final
    definition classes: Any
  32. def ne(arg0: AnyRef): Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality .

    returns

    false if the argument is not a reference to the receiver object; true otherwise.

    attributes: final
    definition classes: AnyRef
  33. def notationDecl(arg0: String, arg1: String, arg2: String): Unit

    definition classes: XMLFilterImpl → DTDHandler
  34. def notify(): Unit

    Wakes up a single thread that is waiting on the receiver object's monitor .

    Wakes up a single thread that is waiting on the receiver object's monitor .

    attributes: final
    definition classes: AnyRef
  35. def notifyAll(): Unit

    Wakes up all threads that are waiting on the receiver object's monitor .

    Wakes up all threads that are waiting on the receiver object's monitor .

    attributes: final
    definition classes: AnyRef
  36. def parse(arg0: String): Unit

    definition classes: XMLFilterImpl → XMLReader
  37. def parse(arg0: InputSource): Unit

    definition classes: XMLFilterImpl → XMLReader
  38. def processingInstruction(target: String, data: String): Unit

    definition classes: XIncludeFilter → XMLFilterImpl → ContentHandler
  39. def resolveEntity(arg0: String, arg1: String): InputSource

    definition classes: XMLFilterImpl → EntityResolver
  40. def setContentHandler(arg0: ContentHandler): Unit

    definition classes: XMLFilterImpl → XMLReader
  41. def setDTDHandler(arg0: DTDHandler): Unit

    definition classes: XMLFilterImpl → XMLReader
  42. def setDocumentLocator(locator: Locator): Unit

    definition classes: XIncludeFilter → XMLFilterImpl → ContentHandler
  43. def setEntityResolver(arg0: EntityResolver): Unit

    definition classes: XMLFilterImpl → XMLReader
  44. def setErrorHandler(arg0: ErrorHandler): Unit

    definition classes: XMLFilterImpl → XMLReader
  45. def setFeature(arg0: String, arg1: Boolean): Unit

    definition classes: XMLFilterImpl → XMLReader
  46. def setParent(arg0: XMLReader): Unit

    definition classes: XMLFilterImpl → XMLFilter
  47. def setProperty(arg0: String, arg1: Any): Unit

    definition classes: XMLFilterImpl → XMLReader
  48. def skippedEntity(name: String): Unit

    definition classes: XIncludeFilter → XMLFilterImpl → ContentHandler
  49. def startDocument(): Unit

    definition classes: XIncludeFilter → XMLFilterImpl → ContentHandler
  50. def startElement(uri: String, localName: String, qName: String, atts1: Attributes): Unit

    definition classes: XIncludeFilter → XMLFilterImpl → ContentHandler
  51. def startPrefixMapping(prefix: String, uri: String): Unit

    definition classes: XIncludeFilter → XMLFilterImpl → ContentHandler
  52. def synchronized[T0](arg0: T0): T0

    attributes: final
    definition classes: AnyRef
  53. def toString(): String

    Returns a string representation of the object .

    Returns a string representation of the object .

    The default representation is platform dependent.

    returns

    a string representation of the object .

    definition classes: AnyRef → Any
  54. def unparsedEntityDecl(arg0: String, arg1: String, arg2: String, arg3: String): Unit

    definition classes: XMLFilterImpl → DTDHandler
  55. def wait(): Unit

    attributes: final
    definition classes: AnyRef
  56. def wait(arg0: Long, arg1: Int): Unit

    attributes: final
    definition classes: AnyRef
  57. def wait(arg0: Long): Unit

    attributes: final
    definition classes: AnyRef
  58. def warning(arg0: SAXParseException): Unit

    definition classes: XMLFilterImpl → ErrorHandler