Document

Instance Constructors

new Document(path: Path, content: RootElement, fragments: Map[String, Element] = ..., config: Config = ..., docNumber: List[Int] = immutable.this.Nil, rewriteRules: Seq[(DocumentContext) ⇒ PartialFunction[Element, Option[Element]]] = immutable.this.Nil)

path
the full, absolute path of this document in the (virtual) document tree
content
the tree model obtained from parsing the markup document
fragments
separate named fragments that had been extracted from the content
config
the configuration for this document
docNumber
the number of this document inside a document tree hierarchy, expressed as a list of Ints
rewriteRules
a list of rewrite rules that have not yet been applied to the document

Value Members

final def !=(arg0: AnyRef): Boolean

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

Definition Classes
Any
final def ##(): Int

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

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

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val config: Config

the configuration for this document
val content: RootElement

the tree model obtained from parsing the markup document
lazy val defaultRules: Seq[(DocumentContext) ⇒ PartialFunction[Element, Option[Element]]]

Attributes
protected
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] )
val fragments: Map[String, Element]

separate named fragments that had been extracted from the content
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

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

Definition Classes
Any
val isRewritten: Boolean

Indicates whether all rewrite rules have already been applied to this document.
val name: String

The local name of this document.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val path: Path

the full, absolute path of this document in the (virtual) document tree
the full, absolute path of this document in the (virtual) document tree

Definition Classes
Document → Navigatable
def removeRules: Document

Removes all rewrite rules that have not yet been applied from this document.
def rewrite(customRule: PartialFunction[Element, Option[Element]]): Document

Returns a new, rewritten document model based on the specified rewrite rules.
Returns a new, rewritten document model based on the specified rewrite rules.
If the specified partial function is not defined for a specific element the old element remains in the tree unchanged. If it returns None then the node gets removed from the tree, if it returns an element it will replace the old one. Of course the function may also return the old element.
The rewriting is performed in a way that only branches of the tree that contain new or removed elements will be replaced. It is processed bottom-up, therefore any element container passed to the rule only contains children which have already been processed.
def rewrite: Document

Returns a new, rewritten document model based on the default rewrite rules.
def rewriteWith(customRules: Seq[PartialFunction[Element, Option[Element]]]): Document

Returns a new, rewritten document model based on the specified rewrite rules.
Returns a new, rewritten document model based on the specified rewrite rules.
If none of the specified partial functions is defined for a specific element the old element remains in the tree unchanged. If one of them returns None then the node gets removed from the tree, if one of them returns an element it will replace the old one. Of course the function may also return the old element.
The rewriting is performed in a way that only branches of the tree that contain new or removed elements will be replaced. It is processed bottom-up, therefore any element container passed to the rule only contains children which have already been processed.
lazy val sections: Seq[SectionInfo]

The section structure of this document based on the hierarchy of headers found in the original text markup.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def title: Seq[Span]

The title of this document, obtained from the document structure or from the configuration.
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( ... )

class Document extends Navigatable

Instance Constructors

new Document(path: Path, content: RootElement, fragments: Map[String, Element] = ..., config: Config = ..., docNumber: List[Int] = immutable.this.Nil, rewriteRules: Seq[(DocumentContext) ⇒ PartialFunction[Element, Option[Element]]] = immutable.this.Nil)

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val config: Config

val content: RootElement

lazy val defaultRules: Seq[(DocumentContext) ⇒ PartialFunction[Element, Option[Element]]]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

val fragments: Map[String, Element]

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

val isRewritten: Boolean

val name: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val path: Path

def removeRules: Document

def rewrite(customRule: PartialFunction[Element, Option[Element]]): Document

def rewrite: Document

def rewriteWith(customRules: Seq[PartialFunction[Element, Option[Element]]]): Document

lazy val sections: Seq[SectionInfo]

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

def title: Seq[Span]

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from Navigatable

Inherited from AnyRef

Inherited from Any

Ungrouped