Packages

case class CitableNode(urn: CtsUrn, text: String) extends Product with Serializable

The smallest canonically citable unit of a text.

urn

URN identifying the node.

text

Text contents of the node.

Annotations
@JSExportAll()
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CitableNode
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CitableNode(urn: CtsUrn, text: String)

    urn

    URN identifying the node.

    text

    Text contents of the node.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def <(urn2: CtsUrn): Boolean
  4. def <=(urn2: CtsUrn): Boolean
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def >(urn2: CtsUrn): Boolean
  7. def ><(urn2: CtsUrn): Boolean
  8. def >=(urn2: CtsUrn): Boolean
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def cex(delimiter: String = "\t"): String

    Two-column serialization of this node as formated for CEX serialization.

    Two-column serialization of this node as formated for CEX serialization.

    delimiter

    String value to separate two columns.

  11. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. def firstNCharsKwic(s: String, n: Int): String

    Format first n characters of a string for KWIC display.

    Format first n characters of a string for KWIC display.

    s

    String to extract characters from.

    n

    Number of characters to include.

  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. def kwic(s: String, context: Int = 20): String

    Format a string extracting a given white-space delimited word token surrounded by a given number of neighboring word tokens.

    Format a string extracting a given white-space delimited word token surrounded by a given number of neighboring word tokens. If wordToken is not present in text, an empty String is returned.

    context

    Number of characters to include on either side of the match.

  18. def lastNCharsKwic(s: String, n: Int): String

    Format last n characters of a string for KWIC display.

    Format last n characters of a string for KWIC display.

    s

    String to extract characters from.

    n

    Number of characters to include.

  19. def matches(v: Vector[String], checkBox: Boolean = true): Boolean

    True if text content matches all strings in a given list.

    True if text content matches all strings in a given list. Recursively compares each string in the list, and sets a flag to false if there is no match.

    v

    List of string to test for.

    checkBox

    True if all strings seen so far have matched.

  20. def matches(s: String): Boolean

    True if text content matches a given string.

    True if text content matches a given string.

    s

    String to test for.

  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. def stripPunctuation: String

    Strip all punctuation characters from text content.

  25. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  26. val text: String
  27. def tokenMatches(t: String): Boolean

    True if text content includes a given whitespace-delimited token.

    True if text content includes a given whitespace-delimited token. Optionally, ignore punctuation.

    t

    Token to test for.

  28. def tokenMatches(v: Vector[String], checkBox: Boolean = true, omitPunctuation: Boolean = true): Boolean

    True if text content includes all whitespace-delimited tokens in a given list.

    True if text content includes all whitespace-delimited tokens in a given list. Recursively compares each string in the list, and sets a flag to false if there is no match.

    v

    List of string to test for.

    checkBox

    True if all strings seen so far have matched.

  29. def tokensWithin(v: Vector[String], distance: Int): Boolean
  30. def tokensWithin(src: Vector[String], v: Vector[String], distance: Int): Boolean

    True if all listed tokens fall within a specified distance in a vector of tokens.

    True if all listed tokens fall within a specified distance in a vector of tokens.

    src

    Text to test on, as a vector of words.

    v

    Vector of tokens to test for.

    distance

    Distance, in words, to test for.

  31. val urn: CtsUrn
  32. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  35. def ~~(urn2: CtsUrn): Boolean

    True if this node is URN-similar to a second URN.

    True if this node is URN-similar to a second URN.

    urn2

    URN to compare to this node.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped