IdGenerators

Type Members

case class Anonymous(pos: Int) extends Id with Product with Serializable

Represents a positional anonymous id.
Represents a positional anonymous id. References get matched to the targets in the order of appearance in the document tree. Therefore the number of references with this id type must match the number of targets.
case class Generated(generator: (Set[String]) ⇒ String) extends Id with Product with Serializable

Represents a generated id based on the provided generator function.
Represents a generated id based on the provided generator function. The Set passed to the function contains the ids that are already in use (independent of whether they were generated or not).
case class Hybrid(id: String, display: Id) extends Id with Product with Serializable

Represents a hybrid id, with one identifier used as a selector for finding matching reference elements and the other merely used for rendering.
sealed abstract class Id extends AnyRef

Represents an identifier for an element in the document tree.
class IdMap extends AnyRef

Maps original ids to their final generated ids.
Maps original ids to their final generated ids. The same original id may trigger the generation of multiple final ids if used in more than one place. The lookup function returns them one after the other.
case class Named(name: String) extends Id with Product with Serializable

Represents an id with a unique string identifier.
Represents an id with a unique string identifier. If multiple elements use the same identifier they get marked as invalid and their ids get removed.
class NumberGenerator extends (Set[String]) ⇒ String

Generates ascending sequences of numeric identifiers, starting with 1.
Generates ascending sequences of numeric identifiers, starting with 1. It skips all numbers which are contained in the Set of used identifiers passed to the function.
case class Relative(path: Path, name: String) extends Id with Product with Serializable

Represents an id that captures a relationship between two paths.
Represents an id that captures a relationship between two paths. Useful for representing cross-references between two documents.
class SymbolGenerator extends (Set[String]) ⇒ String

Generates symbol identifiers.
Generates symbol identifiers. Contains a predefined list of ten symbols to generate. If more than ten symbols are required, the same sequence will be reused, doubled and then tripled, and so on ("**" etc.).

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
object Hidden extends Id with Product with Serializable

Represents an id that is not getting used in the final rendering step.
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] )
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
implicit def stringToId(name: String): Id

Converts the specified string to an Id instance that represents a unique identifier.
def suggestedId(suggested: String, map: IdMap): Generated

Generates an identifier based on a concrete suggestion.
Generates an identifier based on a concrete suggestion. If the suggested id is not already contained in the Set of used identifiers passed to the function it will be used as is. Otherwise it will try to append numbers (-1, -2, and so on) until it finds an unused id.
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 link

object IdGenerators

Type Members

case class Anonymous(pos: Int) extends Id with Product with Serializable

case class Generated(generator: (Set[String]) ⇒ String) extends Id with Product with Serializable

case class Hybrid(id: String, display: Id) extends Id with Product with Serializable

sealed abstract class Id extends AnyRef

class IdMap extends AnyRef

case class Named(name: String) extends Id with Product with Serializable

class NumberGenerator extends (Set[String]) ⇒ String

case class Relative(path: Path, name: String) extends Id with Product with Serializable

class SymbolGenerator extends (Set[String]) ⇒ String

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

object Hidden extends Id with Product with Serializable

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

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

implicit def stringToId(name: String): Id

def suggestedId(suggested: String, map: IdMap): Generated

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