Packages

case class HmtToken(analysis: Cite2Urn, sourceUrn: CtsUrn, editionUrn: CtsUrn, lang: String = "grc", readings: Vector[Reading], lexicalCategory: LexicalCategory, lexicalDisambiguation: Cite2Urn = ..., alternateReading: Option[AlternateReading] = None, discourse: DiscourseCategory = DirectVoice, externalSource: Option[CtsUrn] = None, errors: ArrayBuffer[String] = ArrayBuffer.empty[String]) extends Product with Serializable

A fully documented, semantically distinct token. The model of this token supports the ORCA model of aligned text analysis. The analysis member is a CITE2 URN representing this token as an ORCA analysis. The sourceUrn member is a CTS URN with subreference index identifying the specific string of text analyzed. TheeditionUrn member is a CTS URN for this token in an analytical exemplar. The other members of the HmtToken provide the analytical data for this token.

analysis

CITE URN for this token analysis.

sourceUrn

URN for this token in the analyzed text

editionUrn

URN for this token in an analytical exemplar when promoted to an edition

lang

3-letter language code for the language code of this token, or a descriptive string if no ISO code defined for this language

readings

All org.homermultitext.edmodel.Readings belonging to this token

lexicalCategory

lexical category of this token

lexicalDisambiguation

URN for automated method to disambiguate tokens of a given type, or manually disambiguated URN for named entity values

alternateReading

optional org.homermultitext.edmodel.AlternateReadings belonging to this token

discourse

category of discourse of this token

externalSource

URN of source this token is quoted from

errors

list of error messages (hopefully empty)

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HmtToken
  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 HmtToken(analysis: Cite2Urn, sourceUrn: CtsUrn, editionUrn: CtsUrn, lang: String = "grc", readings: Vector[Reading], lexicalCategory: LexicalCategory, lexicalDisambiguation: Cite2Urn = ..., alternateReading: Option[AlternateReading] = None, discourse: DiscourseCategory = DirectVoice, externalSource: Option[CtsUrn] = None, errors: ArrayBuffer[String] = ArrayBuffer.empty[String])

    create a token

    create a token

    analysis

    CITE URN for this token analysis.

    sourceUrn

    URN for this token in the analyzed text

    editionUrn

    URN for this token in an analytical exemplar when promoted to an edition

    lang

    3-letter language code for the language code of this token, or a descriptive string if no ISO code defined for this language

    readings

    All org.homermultitext.edmodel.Readings belonging to this token

    lexicalCategory

    lexical category of this token

    lexicalDisambiguation

    URN for automated method to disambiguate tokens of a given type, or manually disambiguated URN for named entity values

    alternateReading

    optional org.homermultitext.edmodel.AlternateReadings belonging to this token

    discourse

    category of discourse of this token

    externalSource

    URN of source this token is quoted from

    errors

    list of error messages (hopefully empty)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def altString: String

    Leiden-style formatting of any alternate reading.

  5. def alternateMatch(s: String, accent: Boolean = true): Boolean
  6. var alternateReading: Option[AlternateReading]
  7. var analysis: Cite2Urn
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  10. def columnString: String

    Format a string representation as one value per line, including labels.

  11. def columnString(withLabels: Boolean): String

    Format a string representation as one value per line, either with or without labels.

    Format a string representation as one value per line, either with or without labels.

    withLabels

    include labels if true

  12. def diplomaticMatch(s: String, accent: Boolean = true): Boolean

    True if diplomatic reading matches a String.

    True if diplomatic reading matches a String. Comparison is based on Unicode NFC forms of the strings.

  13. var discourse: DiscourseCategory
  14. var editionUrn: CtsUrn
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def errorReport(separator: String = "\t"): String

    Format human-readable report of errors encountered reading this token.

    Format human-readable report of errors encountered reading this token.

    separator

    String to use as structural delimiter in report.

  17. var errors: ArrayBuffer[String]
  18. var externalSource: Option[CtsUrn]
  19. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  20. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. def hasAlternate: Boolean

    True if token has an alternate reading of any kind.

  22. def hasScribalCorrection: Boolean

    True if scribe offers a correction for this token.

  23. def hasScribalMultiform: Boolean

    True if scribe offers a variant reading (multiform) for this token.

  24. def isAbbreviation: Boolean

    True if token is abbreviated in diplomatic reading.

  25. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  26. def kvString: String

    Compose a string listing properties in form "k=v".

  27. var lang: String
  28. def leidenDiplomatic: String
  29. def leidenFull: String
  30. def lexMatch(urn: Cite2Urn): Boolean

    True if value for lexical disambiguation of this token matches a give URN.

    True if value for lexical disambiguation of this token matches a give URN.

    urn

    The URN to compare.

  31. var lexicalCategory: LexicalCategory
  32. var lexicalDisambiguation: Cite2Urn
  33. var listSeparator: String

    String value separating multiple items within a single property in string representation of the object as a single row

  34. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  35. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  36. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  37. var propertySeparator: String

    String value separating properties in string representation of the object as a single row

  38. def readWithAlternate: String

    Collect alternate reading for this token.

    Collect alternate reading for this token. Strings are normalized to Unicode form NFC.

  39. def readWithDiplomatic: String

    Collect clear diplomatic readings for this token.

  40. def readWithScribal: String

    Collect scribal text, adding corrections to diplomatic readings.

  41. var readings: Vector[Reading]
  42. def rowString: String

    Format a string representation as a single line of delimited text usng propertySeparator value as the delimiter, and listSeparator as a secondary delimiter for lists within a single property.

  43. def scribalMatch(s: String, accent: Boolean = true): Boolean
  44. var sourceUrn: CtsUrn
  45. def stringMatch(s: String, readingType: String = "diplomatic"): Boolean
  46. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  47. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  48. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  49. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped