Packages

c

com.bahmanm.persianutils

SanitiserConfig

final case class SanitiserConfig(standardiseCharacters: Boolean = true, cleanSpacing: Boolean = true, removeTatweel: Boolean = true, standardiseDigits: Boolean = true, standardisePunctuation: Boolean = true, removeDiacritics: Boolean = false) extends Product with Serializable

Configuration options for TextSanitiser.

standardiseCharacters

replaces Arabic and non-standard character variants with standard Persian characters

cleanSpacing

cleans and canonicalises whitespace, non-breaking spaces, and zero-width non-joiners

removeTatweel

strips Kashida / Tatweel elongation characters

standardiseDigits

converts Western ASCII and Eastern Arabic digits into Persian digits

standardisePunctuation

normalises punctuation symbols into Persian equivalents

removeDiacritics

strips Arabic Tashkeel (harakat) short vowel diacritics

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SanitiserConfig
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new SanitiserConfig()

    Auxiliary zero-argument constructor for seamless Java interoperability.

  2. new SanitiserConfig(standardiseCharacters: Boolean = true, cleanSpacing: Boolean = true, removeTatweel: Boolean = true, standardiseDigits: Boolean = true, standardisePunctuation: Boolean = true, removeDiacritics: Boolean = false)

    standardiseCharacters

    replaces Arabic and non-standard character variants with standard Persian characters

    cleanSpacing

    cleans and canonicalises whitespace, non-breaking spaces, and zero-width non-joiners

    removeTatweel

    strips Kashida / Tatweel elongation characters

    standardiseDigits

    converts Western ASCII and Eastern Arabic digits into Persian digits

    standardisePunctuation

    normalises punctuation symbols into Persian equivalents

    removeDiacritics

    strips Arabic Tashkeel (harakat) short vowel diacritics

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val cleanSpacing: Boolean
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  9. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  10. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  12. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  13. def productElementNames: Iterator[String]
    Definition Classes
    Product
  14. val removeDiacritics: Boolean
  15. val removeTatweel: Boolean
  16. val standardiseCharacters: Boolean
  17. val standardiseDigits: Boolean
  18. val standardisePunctuation: Boolean
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped