Package

scales

xml

Permalink

package xml

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. xml
  2. Functions
  3. TextFunctions
  4. NameFunctions
  5. XmlPaths
  6. XmlEquals
  7. SerializingIter
  8. XmlPrinter
  9. TraxSourceConversions
  10. PullIteratees
  11. XmlPulls
  12. XmlParser
  13. XmlUtils
  14. XmlFactories
  15. Whitespace
  16. XmlTypes
  17. XPathMatcher
  18. AnyRef
  19. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. case class Attribute(name: xml.AttributeQName, value: String) extends Product with Serializable

    Permalink

    Attributes can only work with either a prefixed qname or an empty ns name

  2. type AttributePath = xml.xpath.AttributePath

    Permalink

    AttributePath provides access to the parent XmlPath

  3. type AttributePaths[PT <: Iterable[XmlPath]] = xml.xpath.AttributePaths[PT]

    Permalink

    AttributePaths provides all XPath Axe that are attribute relevant against a given collection of attributes on a colletion of XmlPaths

    AttributePaths provides all XPath Axe that are attribute relevant against a given collection of attributes on a colletion of XmlPaths

    See also

    [xpath.AttributePaths]

  4. type AttributeQName = EitherLike[PrefixedQName, NoNamespaceQName]

    Permalink

    An AttributeQName is either a PrefixedQName or a NoNamespaceQName

    An AttributeQName is either a PrefixedQName or a NoNamespaceQName

    Definition Classes
    XmlTypes
  5. type Attributes = ListSet[Attribute]

    Permalink

    An alias for am immutable ListSet of Attribute

    An alias for am immutable ListSet of Attribute

    Definition Classes
    XmlTypes
  6. trait CData extends XmlItem

    Permalink

    Might be tempting to use, but think twice, XOM removes it for a good reason, and I'm sorely tempted to, but I've worked with enough applications that really thought they needed it.

    Might be tempting to use, but think twice, XOM removes it for a good reason, and I'm sorely tempted to, but I've worked with enough applications that really thought they needed it. CData serialization is dependent on the encoding, if your CData contains umlauts etc but you choose US-ACSII you will receive a CDataCannotBeEncoded for your efforts. Choose not to use CData in the first place. Note: Will throw if given the CData end sequence

  7. trait CanHavePrefix extends AnyRef

    Permalink

    Mixed in to Prefixed and Unprefixed

  8. type CloseablePull = XmlPull with Closeable with IsClosed

    Permalink
    Definition Classes
    XmlPrinter
  9. trait Comment extends XmlItem

    Permalink

    Comments aren't escaped and will throw a CommentCannotBeEncoded error if the contents cannot be serialized, xalan just tries to serialize directly which can't work.

    Comments aren't escaped and will throw a CommentCannotBeEncoded error if the contents cannot be serialized, xalan just tries to serialize directly which can't work.

    Note: Will throw if "--" is found in the value

  10. case class DTD(name: String, publicId: String, systemId: String) extends Product with Serializable

    Permalink

    DTD is not part of the tree, nor a stream, it can only occur once and as such is neither an XmlEvent nor an XmlItem directly

  11. case class Declaration(version: XmlVersion = defaultVersion, encoding: Charset = scales.utils.defaultCharset, standalone: Boolean = false) extends Product with Serializable

    Permalink

    Xml declaration

  12. case class Doc(rootElem: xml.XmlTree, prolog: Prolog = Prolog(), end: EndMisc = EndMisc()) extends DocLike with Product with Serializable

    Permalink

    Tree based document

  13. trait DocLike extends AnyRef

    Permalink

    All documents look similar to this, even when stream

  14. sealed trait Elem extends XmlEvent

    Permalink
  15. case class EmptyDoc(prolog: Prolog = Prolog(), end: EndMisc = EndMisc()) extends DocLike with Product with Serializable

    Permalink

    Provides a simple empty document for streams etc

  16. case class EndElem(name: QName, namespaces: Map[String, String] = Map[String, String]()) extends Product with Serializable

    Permalink

    Exists purely to satisfy staxs events and indicate to the client code that the xml "stack" should be popped

  17. case class EndMisc(misc: xml.Miscs = emptyMiscs) extends Product with Serializable

    Permalink

    The information after the root elem

  18. type ItemOrElem = EitherLike[XmlItem, Tree[XmlItem, Elem, XCC]]

    Permalink

    Alias for An XML ItemOrTree

    Alias for An XML ItemOrTree

    Definition Classes
    XmlTypes
  19. type Misc = Either[Comment, PI]

    Permalink

    Misc is either a Comment or PI, and is used for the Prolog and trailing Misc items in a Doc.

    Misc is either a Comment or PI, and is used for the Prolog and trailing Misc items in a Doc.

    Definition Classes
    XmlTypes
  20. type Miscs = Seq[Misc]

    Permalink

    A collection of Misc

    A collection of Misc

    Definition Classes
    XmlTypes
  21. sealed trait Namespace extends UnderlyingNamespace

    Permalink

    Represents a XML Namespace spec compliant Namespace.

    Represents a XML Namespace spec compliant Namespace.

    NOTE Users are recommended to use the prefixed function and work with prefixes directly for qnames.

  22. trait NoNamespaceQName extends QName with RightLike[PrefixedQName, NoNamespaceQName]

    Permalink

    Has neither a prefix nor a namespace (e.g.

    Has neither a prefix nor a namespace (e.g. <fred xmlns=""/>)

  23. trait PI extends XmlItem

    Permalink
  24. type PeekMatch = Option[XmlPath]

    Permalink
    Definition Classes
    PullIteratees
  25. sealed trait PrefixedNamespace extends AnyRef

    Permalink
  26. trait PrefixedQName extends QName with CanHavePrefix with LeftLike[PrefixedQName, NoNamespaceQName]

    Permalink

    Has both a namespace and a prefix (e.g.

    Has both a namespace and a prefix (e.g. <pre:fred xmlns:pre="uri"/>)

  27. case class Prolog(decl: Declaration = Declaration(), misc: xml.Miscs = emptyMiscs, dtd: Option[DTD] = None) extends Product with Serializable

    Permalink

    Includes all information before the root elem

  28. type PullType = Either[XmlEvent, EndElem]

    Permalink
    Definition Classes
    XmlPulls
  29. sealed trait QName extends AnyRef

    Permalink

    QNames together with a tree structure form the basis of XML, what type of QName is available depends on Attribute (either no namespace or prefxied - fully qualified) or Elem (attribute's options and non prefixed but still qualified)

  30. type QNamesMatch = (List[QName], Option[XmlPath])

    Permalink
    Definition Classes
    PullIteratees
  31. type SerialIterT[F[_]] = IterateeT[PullType, F, (XmlOutput, Option[Throwable])]

    Permalink
    Definition Classes
    SerializingIter
  32. type SerialStepT[F[_]] = StepT[PullType, F, (XmlOutput, Option[Throwable])]

    Permalink
    Definition Classes
    SerializingIter
  33. case class Text(value: String) extends XmlItem with Product with Serializable

    Permalink
  34. sealed trait UnderlyingNamespace extends AnyRef

    Permalink

    Seperate the notion of a normal Namespace and that of the "empty namespace" - no default namespace

  35. trait UnprefixedQName extends QName with CanHavePrefix

    Permalink

    Has no prefix but a namespace (e.g.

    Has no prefix but a namespace (e.g. <fred xmlns="uri"/>)

  36. type XCC[T] = ImmutableArrayProxy[T]

    Permalink

    XML Collection - an alias for ImmutableArrayProxy

    XML Collection - an alias for ImmutableArrayProxy

    Definition Classes
    XmlTypes
  37. type XPath[PT <: Iterable[XmlPath]] = xml.xpath.XPath[PT]

    Permalink

    XPath type, provides all XPath Axe against a given collection of XmlPaths

    XPath type, provides all XPath Axe against a given collection of XmlPaths

    See also

    [xpath.XPath]

  38. type XmlBuilder = Builder[ItemOrElem, XmlChildren]

    Permalink

    Alias for a mutable builder of XmlChildren

    Alias for a mutable builder of XmlChildren

    Definition Classes
    XmlTypes
  39. type XmlCBF = CanBuildFrom[XCC[_], utils.ItemOrTree[XmlItem, Elem, XCC], XCC[utils.ItemOrTree[XmlItem, Elem, XCC]]]

    Permalink

    Alias for the XmlTree CanBuildFrom

    Alias for the XmlTree CanBuildFrom

    Definition Classes
    XmlTypes
  40. type XmlChildren = ImmutableArrayProxy[ItemOrElem]

    Permalink

    An Alias for a collection of ItemOrElem, the children of a given tree node

    An Alias for a collection of ItemOrElem, the children of a given tree node

    Definition Classes
    XmlTypes
  41. sealed trait XmlEvent extends AnyRef

    Permalink

    Basis for typed pull api

  42. sealed trait XmlItem extends LeftLike[XmlItem, Tree[XmlItem, Elem, XCC]] with XmlEvent

    Permalink
  43. type XmlPath = Path[XmlItem, Elem, XCC]

    Permalink

    An alias for a Path over XmlTree

    An alias for a Path over XmlTree

    Definition Classes
    XmlTypes
  44. type XmlPull = xml.parser.pull.XmlPull

    Permalink

    Basis for xmlpulls, an Iterator[PullType]

  45. type XmlTree = Tree[XmlItem, Elem, XCC]

    Permalink

    Alias for Trees of Elem and XmlItem

    Alias for Trees of Elem and XmlItem

    Definition Classes
    XmlTypes
  46. sealed trait XmlVersion extends AnyRef

    Permalink

    Scales supports many aspects of Xml10 and Xml11, verification of serialization and values takes place with the XmlVersion ADT.

Value Members

  1. object <

    Permalink

    Creates DslBuilder instances

  2. object ?<

    Permalink

    Creates OptionalDslBuilder instances.

    Creates OptionalDslBuilder instances. If none of the end Elems contain data (either attributes or child text nodes) the result of the builder is None.

  3. object Attr

    Permalink

    Allows easy patterns for attribute values

  4. object Attribs

    Permalink

    Simple constructor for Attributes

  5. object CData

    Permalink
  6. object Comment

    Permalink
  7. object Elem

    Permalink
  8. def ElemMatcher(name: QName, attributes: AttributeQName*): AnyRef { ... /* 2 definitions in type refinement */ }

    Permalink

    Will match if the QNames are the same =:= and if the attributes are present (not requiring that these are the only attributes).

    Will match if the QNames are the same =:= and if the attributes are present (not requiring that these are the only attributes). What is returned is either a Seq of attribute values or a simple boolean

    Definition Classes
    XmlTypes
  9. object EmptyNamespace extends UnderlyingNamespace

    Permalink

    Special case for empty namespaces

  10. object Namespace

    Permalink
  11. object NoNamespaceQName

    Permalink
  12. object PI

    Permalink
  13. object PrefixedNamespace

    Permalink
  14. object PrefixedQName

    Permalink
  15. object ScalesXml extends ScalesXmlImplicits

    Permalink
  16. object UnprefixedQName

    Permalink
  17. object Xml10 extends XmlVersion with Product with Serializable

    Permalink
  18. object Xml11 extends XmlVersion with Product with Serializable

    Permalink
  19. def XmlBuilder(): XmlBuilder

    Permalink

    Default implementation for constructing an instance of XmlBuilder (ImmutableArrayProxyBuilder)

    Default implementation for constructing an instance of XmlBuilder (ImmutableArrayProxyBuilder)

    Definition Classes
    XmlTypes
  20. final def addAndFocus(path: XmlPath, elem: Elem, dchildren: XmlChildren = emptyChildren): Path[XmlItem, Elem, XCC]

    Permalink

    Adds a subtree to this given path and returns a path focussed on the new subtree.

    Adds a subtree to this given path and returns a path focussed on the new subtree.

    The Tree is constructed from the elem and optional children.

    Definition Classes
    XmlTypes
  21. final def addChild(path: XmlPath, child: XmlItem): Path[XmlItem, Elem, XCC]

    Permalink

    Adds a child to the given subpath, however focus remains on the newly modified path

    Adds a child to the given subpath, however focus remains on the newly modified path

    Definition Classes
    XmlTypes
  22. def asStreamSource[T](xml: T)(implicit serf: SerializerFactory, serXml: SerializeableXml[T]): Source

    Permalink

    When the user really wants a stream source or there is yet another place that jaxp Source support is not complete.

    When the user really wants a stream source or there is yet another place that jaxp Source support is not complete.

    Definition Classes
    TraxSourceConversions
  23. def asString[T](xml: T)(implicit serf: SerializerFactory, sxml: SerializeableXml[T]): String

    Permalink

    Returns a string version of the tree or throws

    Returns a string version of the tree or throws

    Definition Classes
    XmlPrinter
  24. def attributes(implicit path: XmlPath): Attributes

    Permalink

    returns the attributes of a given element

    returns the attributes of a given element

    Definition Classes
    XmlPaths
  25. def compare[T](context: ComparisonContext, left: T, right: T)(implicit arg0: XmlComparison[T]): Option[(XmlDifference[_], ComparisonContext)]

    Permalink

    Compare the xml object via the available XmlDifference type class

    Compare the xml object via the available XmlDifference type class

    Definition Classes
    XmlEquals
  26. def compare[T](left: T, right: T)(implicit arg0: XmlComparison[T]): Option[(XmlDifference[_], ComparisonContext)]

    Permalink

    Compare the xml object via the available XmlDifference type class

    Compare the xml object via the available XmlDifference type class

    Definition Classes
    XmlEquals
  27. def compareTokens(context: ComparisonContext, qnameTokenComparison: Option[(ComparisonContext, String, String) ⇒ Boolean], str: String, str2: String): Boolean

    Permalink

    Perform an actual token comparison (Text/CData and Attribute value relevant).

    Perform an actual token comparison (Text/CData and Attribute value relevant).

    Definition Classes
    XmlEquals
  28. def convertFromScalaXml[Token <: OptimisationToken](elem: scala.xml.Elem, parsers: Loaner[XMLReader] with SaxSupport = DefaultXMLReaderFactoryPool, optimisationStrategy: PathOptimisationStrategy[Token] = defaultPathOptimisation, encoding: String = "UTF-8")(implicit xmlVer: XmlVersion): Doc

    Permalink

    Conversion from Scala XML into Scales XML

    Conversion from Scala XML into Scales XML

    Definition Classes
    XmlUtils
  29. def convertToStream(tree: XmlTree): Iterator[PullType]

    Permalink
    Definition Classes
    TraxSourceConversions
  30. val defaultOptimisation: MemoryOptimisationStrategy[QNameToken]

    Permalink
  31. val defaultPathOptimisation: PathOptimisationStrategy[QNameToken]

    Permalink
  32. def doElement(x: Elem, currentMappings: Map[String, String]): NamespaceContext

    Permalink
    Definition Classes
    XmlPrinter
  33. package dsl

    Permalink
  34. def eager(xmlPath: XmlPath)(implicit cbf: CanBuildFrom[List[XmlPath], XmlPath, List[XmlPath]]): xml.xpath.XPath[List[XmlPath]]

    Permalink

    Same as fromXmlPathToXPath, an eager evaluation of xpath queries

    Same as fromXmlPathToXPath, an eager evaluation of xpath queries

    Definition Classes
    XmlPaths
  35. def elem(implicit path: XmlPath): Elem

    Permalink

    returns the Elem at this path

    returns the Elem at this path

    Definition Classes
    XmlPaths
  36. val emptyAttributes: Attributes

    Permalink

    An empty collection of Attribute

    An empty collection of Attribute

    Definition Classes
    XmlTypes
  37. val emptyChildren: XmlChildren

    Permalink

    An empty collection of ItemOrElem

    An empty collection of ItemOrElem

    Definition Classes
    XmlTypes
  38. val emptyMiscs: Miscs

    Permalink

    An empty collection of Misc

    An empty collection of Misc

    Definition Classes
    XmlTypes
  39. val emptyNamespaces: Map[String, String]

    Permalink

    An empty Map of String -> String representing prefix -> namespace

    An empty Map of String -> String representing prefix -> namespace

    Definition Classes
    XmlTypes
  40. package equals

    Permalink
  41. def foldPrint[T](pout: XmlOutput)(it: T)(implicit arg0: SerializeableXml[T]): Option[Throwable]

    Permalink

    Placeholder - prefer serialize instead

    Placeholder - prefer serialize instead

    Definition Classes
    XmlPrinter
  42. def hasLocalName[T](localName: String)(implicit name: Names[T]): (T) ⇒ Boolean

    Permalink

    curried to allow direct drop in for predicates, if it is an item then it will return false

    curried to allow direct drop in for predicates, if it is an item then it will return false

    Definition Classes
    NameFunctions
  43. def hasLocalNameA(local: String): (xml.xpath.AttributePath) ⇒ Boolean

    Permalink

    hasLocalName for AttributePaths

    hasLocalName for AttributePaths

    Definition Classes
    Functions
  44. def hasLocalNameX(local: String): (XmlPath) ⇒ Boolean

    Permalink

    hasLocalName for XmlPaths

    hasLocalName for XmlPaths

    Definition Classes
    Functions
  45. def hasNamespace[T](namespaceUri: String)(implicit name: Names[T], d: DIF): (T) ⇒ Boolean

    Permalink

    matches only the namespace

    matches only the namespace

    Definition Classes
    NameFunctions
  46. def hasNamespace[T](namespace: Namespace)(implicit name: Names[T]): (T) ⇒ Boolean

    Permalink

    matches only the namespace

    matches only the namespace

    Definition Classes
    NameFunctions
  47. def hasQName[T](t: T)(implicit name: Names[T]): Boolean

    Permalink

    Will be true for all values of T except when the resulting QName is "empty".

    Will be true for all values of T except when the resulting QName is "empty".

    If hasQName is false then calling name will throw

    Definition Classes
    NameFunctions
  48. def hasQName[T](implicit t: T, name: Names[T], d: DIF): Boolean

    Permalink

    Will be true for all values of T except when the resulting QName is "empty".

    Will be true for all values of T except when the resulting QName is "empty".

    If hasQName is false then calling name will throw

    Definition Classes
    NameFunctions
  49. def headerAndFooter(pout: XmlOutput, doc: DocLike)(serializerf: (XmlOutput, Serializer) ⇒ (XmlOutput, Option[Throwable])): (Serializer) ⇒ Option[Throwable]

    Permalink
    Definition Classes
    XmlPrinter
  50. implicit val idPullIteratees: PullIterateeFunctions[scalaz.Id.Id]

    Permalink
    Definition Classes
    PullIteratees
  51. package impl

    Permalink

    This package is not intended for direct usage, however it provides much of the functionality that is used throughout scales.xml, and as such may be of use to those extending it.

  52. implicit val ioPullIteratees: PullIterateeFunctions[IO]

    Permalink
    Definition Classes
    PullIteratees
  53. val isElem: (XmlPath) ⇒ Boolean

    Permalink
    Definition Classes
    XmlPaths
  54. def isEmptyTree(tree: XmlTree): Boolean

    Permalink

    Returns true if the tree is effectively empty, i.e.

    Returns true if the tree is effectively empty, i.e. no attributes or children

    Definition Classes
    XmlUtils
  55. def isEquivalent[T](qname: QName)(implicit name: Names[T]): (T) ⇒ Boolean

    Permalink

    Matches on prefix and namespace only

    Matches on prefix and namespace only

    Definition Classes
    NameFunctions
  56. def isExactly[T](qname: QName)(implicit name: Names[T]): (T) ⇒ Boolean

    Permalink

    Does the qname match exactly (prefix included if present)

    Does the qname match exactly (prefix included if present)

    Definition Classes
    NameFunctions
  57. val isItem: (XmlPath) ⇒ Boolean

    Permalink
    Definition Classes
    XmlPaths
  58. def isNil(tree: XmlTree): Boolean

    Permalink

    Tests if a given tree is nil, but does not check if children are present.

    Tests if a given tree is nil, but does not check if children are present.

    returns

    true if there is a xsi:nil="true" value (or 1)

    Definition Classes
    XmlUtils
  59. val isText: (XmlPath) ⇒ Boolean

    Permalink
    Definition Classes
    XmlPaths
  60. def itemAsString(xmlItem: XmlItem)(implicit serf: SerializerFactory): String

    Permalink

    Just for items, given we don't want to generally serialize them directly but as part of a tree.

    Just for items, given we don't want to generally serialize them directly but as part of a tree. Useful for debugging only

    Definition Classes
    XmlPrinter
  61. def iterate(path: List[QName], xml: Iterator[PullType])(implicit qe: Equal[QName]): FlatMapIterator[XmlPath]

    Permalink

    A wrapping around withIter(onDone(List(onQNames(path))))(enumXml(xml, _)) it unwraps the data providing an Iterator[XPath]

    A wrapping around withIter(onDone(List(onQNames(path))))(enumXml(xml, _)) it unwraps the data providing an Iterator[XPath]

    Definition Classes
    PullIteratees
  62. def iterate(path: List[QName], xml: xml.parser.pull.XmlPull)(implicit qe: Equal[QName]): FlatMapIterator[XmlPath]

    Permalink

    Wraps XmlPull

    Wraps XmlPull

    Definition Classes
    PullIteratees
  63. def joinTextNodes(children: XmlChildren): XmlChildren

    Permalink
    Definition Classes
    Whitespace
  64. def joinTextNodes(tree: XmlTree): XmlTree

    Permalink

    Joins adjacent text nodes for the immediate children only (make a tree more XPath friendly)

    Joins adjacent text nodes for the immediate children only (make a tree more XPath friendly)

    Definition Classes
    Whitespace
  65. def laddNS(entry: (String, String), mappings: Map[String, String], declMap: Map[String, String]): (Map[String, String], Map[String, String])

    Permalink

    a) add / replace in mappings b) add to declMap

    a) add / replace in mappings b) add to declMap

    Definition Classes
    XmlPrinter
  66. def lazyRaw[T <: Iterable[XmlPath]](xpath: xml.xpath.XPath[T]): Iterable[XmlPath]

    Permalink

    Normally the implicit fromXPathToIterable will provide sorted output, but this can create significant slow down when only the contents are necessary, not their order.

    Normally the implicit fromXPathToIterable will provide sorted output, but this can create significant slow down when only the contents are necessary, not their order.

    Use lazyRaw to convert without forcing sorting or checking for duplicates, and to evaluate lazily.

    Warning, don't use this version of raw unless your XPath usage costs more than the navigation, its based on Stream and terribly slow (huge memory and stack usage etc).

    NOTEs Laziness with flatten is achieved by using iterator.toIterable before the flatten (uses Stream internally). Its only useful as a lazy evaluator if viewed was used.

    Definition Classes
    XmlPaths
  67. def loadXml[Token <: OptimisationToken](source: InputSource, strategy: PathOptimisationStrategy[Token] = defaultPathOptimisation, parsers: Loaner[SAXParser] with SaxSupport = DefaultSAXParserFactoryPool.parsers)(implicit xmlVer: XmlVersion): Doc

    Permalink

    Use a custom parserPool to control the sax factory features

    Use a custom parserPool to control the sax factory features

    Definition Classes
    XmlParser
  68. def loadXmlReader[Token <: OptimisationToken](source: InputSource, strategy: PathOptimisationStrategy[Token] = defaultPathOptimisation, parsers: Loaner[XMLReader] with SaxSupport = DefaultXMLReaderFactoryPool)(implicit xmlVer: XmlVersion): Doc

    Permalink

    Use a custom parserPool to control the sax factory features

    Use a custom parserPool to control the sax factory features

    Definition Classes
    XmlParser
  69. def localName[T](t: T)(implicit name: Names[T]): String

    Permalink

    Returns the localName

    Returns the localName

    Definition Classes
    NameFunctions
  70. def localName[T](implicit t: T, name: Names[T], d: DIF): String

    Permalink

    Returns the localName

    Returns the localName

    Definition Classes
    NameFunctions
  71. val mergeAdjacentText: ((Option[XmlItem], XmlChildren), ItemOrElem) ⇒ (Option[XmlItem], XmlChildren)

    Permalink

    Joins adjacent text nodes for immediate children

    Joins adjacent text nodes for immediate children

    Definition Classes
    Whitespace
  72. def name[T](t: T)(implicit iname: Names[T]): QName

    Permalink

    Returns the QName, will throw if the QName is "empty"

    Returns the QName, will throw if the QName is "empty"

    Definition Classes
    NameFunctions
  73. def name[T](implicit t: T, name: Names[T], d: DIF): QName

    Permalink

    Returns the QName, will throw if the QName is "empty"

    Returns the QName, will throw if the QName is "empty"

    Definition Classes
    NameFunctions
  74. def namespace[T](implicit t: T, name: Names[T], d: DIF): UnderlyingNamespace

    Permalink

    Returns the underlying namespace object

    Returns the underlying namespace object

    Definition Classes
    NameFunctions
  75. def namespaceUri[T](t: T)(implicit name: Names[T]): String

    Permalink

    XPath namespace-uri function, returns the uri

    XPath namespace-uri function, returns the uri

    Definition Classes
    NameFunctions
  76. def namespaceUri[T](implicit t: T, name: Names[T], d: DIF): String

    Permalink

    XPath namespace-uri function, returns the uri

    XPath namespace-uri function, returns the uri

    Definition Classes
    NameFunctions
  77. def newSchema(source: Source, factory: Loaner[SchemaFactory] = DefaultXSDSchemaFactoryPool): Schema

    Permalink
    Definition Classes
    XmlFactories
  78. val noXmlPath: XmlPath

    Permalink

    Use to signify a "null object", tree/path shouldn't work like this its a smell

    Use to signify a "null object", tree/path shouldn't work like this its a smell

    Definition Classes
    XmlTypes
  79. def normalizeSpace[T](t: T)(implicit value: TextValue[T]): String

    Permalink

    XPath normalize-space function, replaces all consecutive whitespace with " " and trims.

    XPath normalize-space function, replaces all consecutive whitespace with " " and trims.

    Definition Classes
    TextFunctions
  80. def normalizeSpace[T](implicit t: T, value: TextValue[T], d: DIF): String

    Permalink

    XPath normalize-space function, replaces all consecutive whitespace with " " and trims.

    XPath normalize-space function, replaces all consecutive whitespace with " " and trims.

    Definition Classes
    TextFunctions
  81. def normalizeSpaceS(str: String): String

    Permalink

    XPath normalize-space function, replaces all consecutive whitespace with " " and trims.

    XPath normalize-space function, replaces all consecutive whitespace with " " and trims.

    Definition Classes
    Whitespace
  82. def onQNames[F[_]](qnames: List[QName])(implicit arg0: Monad[F]): ResumableIter[PullType, F, QNamesMatch]

    Permalink
    Definition Classes
    PullIteratees
  83. def onQNamesI[F[_]](qnames: List[QName])(implicit qe: Equal[QName], F: Monad[F]): ResumableIter[PullType, F, QNamesMatch]

    Permalink

    Collects all data belonging to an element that matches the list.

    Collects all data belonging to an element that matches the list. <top><middle><ofInterest> content </ofInterest><ofInterest.... onQNames(List("top"l, "middle"l, "ofInterest"l)) would return an iteratee that returned every <ofInterest> content </ofInterest> as a path (each parent node containing only one child node).

    Definition Classes
    PullIteratees
  84. package parser

    Permalink
  85. def pathAndTreeMatcher[T](pathEval: (XmlTree) ⇒ T)(implicit arg0: utils.AsBoolean[T]): utils.BooleanAndTMatcher[XmlTree, T]

    Permalink

    Similar to pathMatcher but also gives the tree back into the pattern match.

    Similar to pathMatcher but also gives the tree back into the pattern match.

    Definition Classes
    XPathMatcher
  86. def pathMatcher[T](pathEval: (XmlTree) ⇒ T)(implicit arg0: utils.AsBoolean[T]): utils.BooleanMatcher[XmlTree, T]

    Permalink

    Creates a booleanMatcher against a Tree based on the @pathEval function.

    Creates a booleanMatcher against a Tree based on the @pathEval function.

    For XPath evaluations on the tree this typically gives the paths back when the xpath evaluates to a non-empty result. TODO ADD CODE

    Definition Classes
    XPathMatcher
  87. def pqName[T](t: T)(implicit name: Names[T]): String

    Permalink

    Returns either qualifiedName or prefix:{namespace}local when a prefix is present

    Returns either qualifiedName or prefix:{namespace}local when a prefix is present

    Definition Classes
    NameFunctions
  88. def pqName[T](implicit t: T, name: Names[T], d: DIF): String

    Permalink

    Returns either qualifiedName or prefix:{namespace}local when a prefix is present

    Returns either qualifiedName or prefix:{namespace}local when a prefix is present

    Definition Classes
    NameFunctions
  89. def printTree[T](xml: T)(implicit serf: SerializerFactory, sxml: SerializeableXml[T]): Unit

    Permalink

    Prints to stdout, useful for testing etc Will dump an error if one is found.

    Prints to stdout, useful for testing etc Will dump an error if one is found.

    Note it outputs to the vmDefaultCharset so it should always be C+P able

    Definition Classes
    XmlPrinter
  90. def pullIterateesOf[F[_]](implicit F: Monad[F]): PullIterateeFunctions[F]

    Permalink
    Definition Classes
    PullIteratees
  91. def pullXml[RToken <: OptimisationToken](source: InputSource, optimisationStrategy: MemoryOptimisationStrategy[RToken] = defaultOptimisation, parserFactoryPool: Pool[XMLInputFactory] = impl.DefaultStaxInputFactoryPool, closeAfterUse: Boolean = true, strictPath: List[QName] = Nil): xml.parser.pull.XmlPull with Closeable with IsClosed

    Permalink

    Creates a new XmlPull based on source.

    Creates a new XmlPull based on source. By default it will close the stream after use.

    Definition Classes
    XmlPulls
  92. def pullXmlCompletely[RToken <: OptimisationToken](source: InputSource, strategy: PathOptimisationStrategy[RToken] = defaultPathOptimisation, parserFactoryPool: Pool[XMLInputFactory] = impl.DefaultStaxInputFactoryPool, closeAfterUse: Boolean = true): Doc

    Permalink

    Load xml via pull parsing

    Load xml via pull parsing

    Definition Classes
    XmlPulls
  93. def pullXmlReader[RToken <: OptimisationToken](reader: XMLStreamReader, defaultOptimisationStrategy: MemoryOptimisationStrategy[RToken] = defaultOptimisation): xml.parser.pull.XmlPull

    Permalink

    Allows plugging in other feeds, non source based, as such not closeable

    Allows plugging in other feeds, non source based, as such not closeable

    Definition Classes
    XmlPulls
  94. def pullXmlResource[RToken <: OptimisationToken](source: InputSource, optimisationStrategy: MemoryOptimisationStrategy[RToken] = defaultOptimisation, parserFactoryPool: Pool[XMLInputFactory] = impl.DefaultStaxInputFactoryPool): (CloseOnNeed, xml.parser.pull.XmlPull)

    Permalink

    Creates a new XmlPull based on source for direct handling of the stream.

    Creates a new XmlPull based on source for direct handling of the stream. Note to close the stream you must bracket. The individual XmlPull will be closed after the document end but the stream will remain open

    Definition Classes
    XmlPulls
  95. def pushXmlIter[F[_]](out: Writer, doc: DocLike = EmptyDoc(), version: Option[XmlVersion] = None, encoding: Option[Charset] = None)(implicit serializerFI: SerializerFactory, F: Monad[F]): (CloseOnNeed, SerialIterT[F])

    Permalink

    Returns an Iteratee that can serialize PullTypes to out.

    Returns an Iteratee that can serialize PullTypes to out. The serializer factory management is automatically handled upon calling with eof. This can be triggered earlier by calling closeResource on the returned CloseOnNeed.

    Definition Classes
    SerializingIter
  96. def qName[T](t: T)(implicit name: Names[T]): String

    Permalink

    Returns the XPath QName - prefix:local or local

    Returns the XPath QName - prefix:local or local

    Definition Classes
    NameFunctions
  97. def qName[T](implicit t: T, name: Names[T], d: DIF): String

    Permalink

    Returns the XPath QName - prefix:local or local

    Returns the XPath QName - prefix:local or local

    Definition Classes
    NameFunctions
  98. def qname[T](t: T)(implicit name: Names[T]): String

    Permalink

    Returns the XPath QName - prefix:local or local

    Returns the XPath QName - prefix:local or local

    Definition Classes
    NameFunctions
  99. def qname[T](implicit t: T, name: Names[T], d: DIF): String

    Permalink

    Returns the XPath QName - prefix:local or local

    Returns the XPath QName - prefix:local or local

    Definition Classes
    NameFunctions
  100. def qnamesEqual(context: ComparisonContext, str: String, str2: String): Boolean

    Permalink

    Allows comparison of Text nodes or Attribute values that contain QNames, i.e.

    Allows comparison of Text nodes or Attribute values that contain QNames, i.e. prefix:value. In order to perform this comparison both the left and right sides must have a NamespaceContext.

    Definition Classes
    XmlEquals
  101. def qualifiedName[T](t: T)(implicit name: Names[T]): String

    Permalink

    Returns the qualified name {namespace}local

    Returns the qualified name {namespace}local

    Definition Classes
    NameFunctions
  102. def qualifiedName[T](implicit t: T, name: Names[T], d: DIF): String

    Permalink

    Returns the qualified name {namespace}local

    Returns the qualified name {namespace}local

    Definition Classes
    NameFunctions
  103. def raw[T <: Iterable[XmlPath]](xpath: xml.xpath.XPath[T]): Iterable[XmlPath]

    Permalink

    Normally the implicit fromXPathToIterable will provide sorted output, but this can create significant slow down when only the contents are necessary, not their order.

    Normally the implicit fromXPathToIterable will provide sorted output, but this can create significant slow down when only the contents are necessary, not their order.

    Use raw to convert without forcing sorting or checking for duplicates.

    NOTE Any laziness aquired by viewed will also be lost by the flatten

    Definition Classes
    XmlPaths
  104. def readXml[Token <: OptimisationToken](source: InputSource, strategy: PathOptimisationStrategy[Token], reader: XMLReader, saxSupport: SaxSupport)(implicit xmlVer: XmlVersion): Doc

    Permalink
    Definition Classes
    XmlParser
  105. def serialize[T](pout: XmlOutput)(it: T)(implicit arg0: SerializeableXml[T]): Option[Throwable]

    Permalink

    Serializes items which can behave like xml.

    Serializes items which can behave like xml.

    Definition Classes
    XmlPrinter
  106. def serializeIter[F[_]](output: XmlOutput, serializer: Serializer, closer: () ⇒ Unit, doc: DocLike = EmptyDoc())(implicit F: Monad[F]): SerialIterT[F]

    Permalink

    The serializer will be returned automatically to the pool by calling closer

    The serializer will be returned automatically to the pool by calling closer

    doc functions are only evaluated upon the first elem / last elem

    Definition Classes
    SerializingIter
  107. def serializeMisc(pout: XmlOutput, misc: Iterable[Misc], serializer: Serializer): (XmlOutput, Option[Throwable])

    Permalink
    Definition Classes
    XmlPrinter
  108. package serializers

    Permalink
  109. def skip[F[_]](downTo: ⇒ List[Int])(implicit F: Monad[F]): IterateeT[PullType, F, PeekMatch]

    Permalink

    Skips all events until the indexes match downTo, can be seen as \*\*[b]\*[c] skipping until c with skip(List(b,c)).

    Skips all events until the indexes match downTo, can be seen as \*\*[b]\*[c] skipping until c with skip(List(b,c)). This can be used, for example, to identify qnames within a message and combined with capture to allow replaying. Identifying a soap doc-lit request would be skip(List(2,1)). It returns the XmlPath to the skipped position, for soap /Envelope/Body/Request but does not collect the contents of that node. An empty list will simply return the first Element found.

    Definition Classes
    PullIteratees
  110. def skipv[F[_]](downTo: Int*)(implicit F: Monad[F]): IterateeT[PullType, F, PeekMatch]

    Permalink
    Definition Classes
    PullIteratees
  111. def sourceUser(source: InputSource): SourceUser with Product with Serializable

    Permalink

    Provides proxied sources to the pull parsers, the stream provided is the stream used

    Provides proxied sources to the pull parsers, the stream provided is the stream used

    Definition Classes
    XmlPulls
  112. def streamOr[T](xml: T, f: ⇒ Source)(implicit serf: SerializerFactory, serXml: SerializeableXml[T]): Source

    Permalink
    Definition Classes
    TraxSourceConversions
  113. def string[T](t: T)(implicit value: TextValue[T]): String

    Permalink

    XPath name for text

    XPath name for text

    Definition Classes
    TextFunctions
  114. def string[T](implicit t: T, value: TextValue[T], d: DIF): String

    Permalink

    XPath name for text

    XPath name for text

    Definition Classes
    TextFunctions
  115. def text[T](t: T)(implicit value: TextValue[T]): String

    Permalink

    The text value of a given object, .value for attributes & items, the accumalated text if its an elem

    The text value of a given object, .value for attributes & items, the accumalated text if its an elem

    Definition Classes
    TextFunctions
  116. def text[T](implicit t: T, value: TextValue[T], d: DIF): String

    Permalink

    The text value of a given object, .value for attributes & items, the accumalated text if its an elem

    The text value of a given object, .value for attributes & items, the accumalated text if its an elem

    Definition Classes
    TextFunctions
  117. implicit def toLeft(ev: XmlEvent): Left[XmlEvent, Nothing]

    Permalink
    Definition Classes
    XmlPulls
  118. implicit def toRight(ev: EndElem): Right[Nothing, EndElem]

    Permalink
    Definition Classes
    XmlPulls
  119. def toTree[RToken <: OptimisationToken](pull: Iterator[PullType], strategy: PathOptimisationStrategy[RToken] = defaultPathOptimisation): XmlTree

    Permalink

    Attempts to convert a stream to a tree

    Attempts to convert a stream to a tree

    Definition Classes
    XmlPulls
  120. implicit val trampolinePullIteratees: PullIterateeFunctions[Trampoline]

    Permalink
    Definition Classes
    PullIteratees
  121. package trax

    Permalink
  122. def value[T](t: T)(implicit value: TextValue[T]): String

    Permalink

    More readable version for XmlItems and Attributes, same as text

    More readable version for XmlItems and Attributes, same as text

    Definition Classes
    TextFunctions
  123. def value[T](implicit t: T, value: TextValue[T], d: DIF): String

    Permalink

    More readable version for XmlItems and Attributes, same as text

    More readable version for XmlItems and Attributes, same as text

    Definition Classes
    TextFunctions
  124. def viewed(xmlPath: XmlPath)(implicit cbf: CanBuildFrom[List[XmlPath], XmlPath, List[XmlPath]]): xml.xpath.XPath[List[XmlPath]]

    Permalink

    Lazy evaluation of XPaths

    Lazy evaluation of XPaths

    View called on nested Lists, but not on xlmPath.

    Definition Classes
    XmlPaths
  125. def withWriter(decl: Declaration, out: Writer): SerializerData

    Permalink
    Definition Classes
    XmlPrinter
  126. def writeTo[T](it: T, output: Writer, version: Option[XmlVersion] = None, encoding: Option[Charset] = None)(implicit serializerFI: SerializerFactory, sxml: SerializeableXml[T]): Option[Throwable]

    Permalink

    Writes the xml to a given Writer with defaults provided for .

    Writes the xml to a given Writer with defaults provided for .

    Definition Classes
    XmlPrinter
  127. val xmlSeqLikeThing: SeqLikeThing[ImmutableArrayProxy[_], ItemOrElem, ImmutableArrayProxy]

    Permalink

    The xml typed ImmutableArrayProxy SeqLikeThing

    The xml typed ImmutableArrayProxy SeqLikeThing

    Definition Classes
    XmlTypes
  128. package xpath

    Permalink
  129. val xsiNil: AttributeQName

    Permalink

    A convenient AttributeQName for xsi:nil attributes

    A convenient AttributeQName for xsi:nil attributes

    Definition Classes
    XmlUtils

Inherited from Functions

Inherited from TextFunctions

Inherited from NameFunctions

Inherited from XmlPaths

Inherited from XmlEquals

Inherited from SerializingIter

Inherited from XmlPrinter

Inherited from TraxSourceConversions

Inherited from PullIteratees

Inherited from XmlPulls

Inherited from XmlParser

Inherited from XmlUtils

Inherited from XmlFactories

Inherited from Whitespace

Inherited from XmlTypes

Inherited from XPathMatcher

Inherited from AnyRef

Inherited from Any

Ungrouped