XmlBaseSupport

XML Base support, for elements implementing the ClarkElemApi query API.

XML Base is very simple in its algorithm, given an optional start "document URI". Base URI computation for an element then starts with the optional document URI, and processes all XML Base attributes in the reverse ancestry-or-self of the element, resolving each XML Base attribute against the base URI computed so far. According to the XML Base specification, same-document references do not alter this algorithm.

What is sensitive in XML Base processing is the resolution of an URI against an optional base URI. For example, resolving an empty URI using the java.net.URI.resolve method does not conform to RFC 3986 (see e.g. http://stackoverflow.com/questions/22203111/is-javas-uri-resolve-incompatible-with-rfc-3986-when-the-relative-uri-contains).

This is why the user of this XML Base support must supply a strategy for resolving URIs against optional base URIs.

Default attributes and entity resolution are out of scope for this XML Base support.

Linear Supertypes

AnyRef, Any

Type Members

type UriResolver = (URI, Option[URI]) ⇒ URI

Resolver of a URI against an optional base URI, returning the resolved URI

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

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

Definition Classes
AnyRef → Any
val JdkUriResolver: UriResolver

URI resolver using method java.net.URI.resolve.
URI resolver using method java.net.URI.resolve. It does not conform to RFC 3986.
val XmlBaseEName: EName
val XmlNs: String
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def findBaseUriByDocUriAndPath(docUriOption: Option[URI], rootElem: ClarkElemApi, path: Path)(resolveUri: UriResolver): Option[URI]

Computes the optional base URI, given an optional document URI, the root element, and the Path from the root element to "this" element.
Computes the optional base URI, given an optional document URI, the root element, and the Path from the root element to "this" element. A URI resolution strategy must be provided as well.
def findBaseUriByParentBaseUri(parentBaseUriOption: Option[URI], elem: ClarkElemApi)(resolveUri: UriResolver): Option[URI]

Returns the optional base URI, given an optional parent base URI, and "this" element.
Returns the optional base URI, given an optional parent base URI, and "this" element. A URI resolution strategy must be provided as well.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package queryapi

object XmlBaseSupport

Type Members

type UriResolver = (URI, Option[URI]) ⇒ URI

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val JdkUriResolver: UriResolver

val XmlBaseEName: EName

val XmlNs: String

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def findBaseUriByDocUriAndPath(docUriOption: Option[URI], rootElem: ClarkElemApi, path: Path)(resolveUri: UriResolver): Option[URI]

def findBaseUriByParentBaseUri(parentBaseUriOption: Option[URI], elem: ClarkElemApi)(resolveUri: UriResolver): Option[URI]

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped