Packages

case class HmtToken(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: Vector[String] = Vector.empty[String]) extends LogSupport with Product with Serializable

A fully documented, semantically distinct token.

sourceUrn

URN with subreference for this token in the analyzed text.

editionUrn

URN for this token in a token edition with additional citation level in the passage hierarchy.

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

A URN disambiguating named entities.

alternateReading

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

discourse

Category of discourse of this token.

externalSource

Optional URN of a text this token is quoted from.

errors

List of error messages (hopefully empty).

Linear Supertypes
Product, Equals, LogSupport, LazyLogger, LoggingMethods, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HmtToken
  2. Product
  3. Equals
  4. LogSupport
  5. LazyLogger
  6. LoggingMethods
  7. Serializable
  8. Serializable
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new HmtToken(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: Vector[String] = Vector.empty[String])

    sourceUrn

    URN with subreference for this token in the analyzed text.

    editionUrn

    URN for this token in a token edition with additional citation level in the passage hierarchy.

    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

    A URN disambiguating named entities.

    alternateReading

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

    discourse

    Category of discourse of this token.

    externalSource

    Optional URN of a text 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 addAlternateReading(alt: Option[AlternateReading]): HmtToken
  5. def addErrorMessage(msg: String): HmtToken

    Create a new HmtToken with an additional error message added to the list.

    Create a new HmtToken with an additional error message added to the list.

    msg

    Error message to add.

  6. def addExternalSource(extSource: Option[CtsUrn]): HmtToken
  7. def addReading(rdgs: Vector[Reading]): HmtToken
  8. def adjustEditionUrn(newUrn: CtsUrn): HmtToken

    Create a copy of this token with a given edition URN.

    Create a copy of this token with a given edition URN.

    newUrn

    CtsUrn for the new token.

  9. def altString: String

    Leiden-style formatting of any alternate reading.

  10. def alternateMatch(s: String, accent: Boolean = true): Boolean

    True if reading with alternate reading matches a string.

    True if reading with alternate reading matches a string.

    s

    Text to match.

    accent

    True if accent should be included in matching.

  11. val alternateReading: Option[AlternateReading]
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  14. def columnString: String

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

  15. 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

  16. macro def debug(message: Any, cause: Throwable): Unit
    Attributes
    protected
    Definition Classes
    LoggingMethods
  17. macro def debug(message: Any): Unit
    Attributes
    protected
    Definition Classes
    LoggingMethods
  18. 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.

  19. val discourse: DiscourseCategory
  20. val editionUrn: CtsUrn
  21. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. macro def error(message: Any, cause: Throwable): Unit
    Attributes
    protected
    Definition Classes
    LoggingMethods
  23. macro def error(message: Any): Unit
    Attributes
    protected
    Definition Classes
    LoggingMethods
  24. 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.

  25. val errors: Vector[String]
  26. val externalSource: Option[CtsUrn]
  27. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  28. def hasAlternate: Boolean

    True if token has an alternate reading of any kind.

  29. def hasScribalCorrection: Boolean

    True if scribe offers a correction for this token.

  30. def hasScribalMultiform: Boolean

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

  31. macro def info(message: Any, cause: Throwable): Unit
    Attributes
    protected
    Definition Classes
    LoggingMethods
  32. macro def info(message: Any): Unit
    Attributes
    protected
    Definition Classes
    LoggingMethods
  33. def isAbbreviation: Boolean

    True if token is abbreviated in diplomatic reading.

  34. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  35. def kvString: String

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

  36. val lang: String
  37. def leidenDiplomatic: String
  38. def leidenFull: String
  39. 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.

  40. val lexicalCategory: LexicalCategory
  41. val lexicalDisambiguation: Cite2Urn
  42. val listSeparator: String

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

  43. macro def logAt(logLevel: LogLevel, message: Any): Unit
    Attributes
    protected
    Definition Classes
    LoggingMethods
  44. lazy val logger: Logger
    Attributes
    protected[this]
    Definition Classes
    LazyLogger
  45. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  46. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  47. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  48. val propertySeparator: String

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

  49. def readLegible: String
  50. def readWithAlternate: String

    Collect alternate reading for this token.

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

  51. def readWithDiplomatic: String

    Collect clear diplomatic readings for this token.

  52. def readWithScribal: String

    Collect scribal text, adding corrections to diplomatic readings.

  53. val readings: Vector[Reading]
  54. 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.

  55. def scribalMatch(s: String, accent: Boolean = true): Boolean

    True if reading with scribal correction matches a string.

    True if reading with scribal correction matches a string.

    s

    Text to match.

    accent

    True if accent should be included in matching.

  56. val sourceUrn: CtsUrn
  57. def stringMatch(s: String, readingType: String = "diplomatic"): Boolean

    True if this node's reading matches a string.

    True if this node's reading matches a string.

    s

    Text to match.

    readingType

    Type of reading to use for comparison. May be one of diplomatic, scribal or alternate.

  58. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  59. macro def trace(message: Any, cause: Throwable): Unit
    Attributes
    protected
    Definition Classes
    LoggingMethods
  60. macro def trace(message: Any): Unit
    Attributes
    protected
    Definition Classes
    LoggingMethods
  61. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  62. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  63. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  64. macro def warn(message: Any, cause: Throwable): Unit
    Attributes
    protected
    Definition Classes
    LoggingMethods
  65. macro def warn(message: Any): Unit
    Attributes
    protected
    Definition Classes
    LoggingMethods

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from Product

Inherited from Equals

Inherited from LogSupport

Inherited from LazyLogger

Inherited from LoggingMethods

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped