core/de.jfachwert/Text

Text

open class Text @JvmOverloads constructor(text: String, validator: KSimpleValidator<String> = VALIDATOR) : AbstractFachwert<String, Text> , Comparable<Text>

Die Klasse Text ist der einfachste Fachwerte, der eigentlich nur ein Wrapper um die String-Klasse ist. Allerdings mit dem Unterschied, dass man keinen Null-Text oder leeren Text anlegen kann.

Diese Klasse wurde mit der FachwertFactory eingefuehrt. Sie dient dort als Fallback, wenn kein Fachwert erzeugt werden kann, auf den der uebergebene Name passt.

Author

oboehm

Since

0.5 (17.01.2018)

Constructors

Text

@JvmOverloads

constructor(text: String, validator: KSimpleValidator<String> = VALIDATOR)

Types

Companion

object Companion

Properties

code

val code: String

Liefert die interne Praesentation fuer die abgeleiteten Klassen. Sie ist nicht fuer den direkten Aufruf vorgesehen, weswegen die Methode auch 'final' ist.

Functions

compareTo

open operator override fun compareTo(other: Text): Int

Dient zum (alphabetischen) Vergleich zweier Texte.

convertTo

fun convertTo(toEncoding: Charset, fromEncoding: Charset = detectCharset()): Text

Konvertiert mit JDK-Bordmittel einen Text in ein gewuenschtes Encoding. Allerdings kann je nach Konvertierung das Ergebnis verlustbehaftet sein.

detectCharset

fun detectCharset(): Charset

Erkennt das Encoding eines Textes. Die Idee dahinter ist, dass wir einen Text nach UTF-8 und wieder zurueck konvertieren. Dies ist ein einfacher Ansatz und stammt aus Detect the charset in Java strings, reicht aber fuer einfache Faelle aus.

detectCharsets

fun detectCharsets(): Collection<Charset>

Erkennt das Encoding eines Textes. Im Unterschied zu Text#detectCharset werden hier alle erkannte Charsets zurueckgegeben

equals

open operator override fun equals(other: Any?): Boolean

Zwei Fachwerte sind nur dann gleich, wenn sie vom gleichen Typ sind und den gleichen Wert besitzen.

equalsIgnoreCase

fun equalsIgnoreCase(other: Text): Boolean

Ignoriert beim Vergleich Gross- und Kleinschreibung.

equalsIgnoreCaseAndUmlaute

fun equalsIgnoreCaseAndUmlaute(other: Text): Boolean

Ignoriert beim Vergleich die Umlaute sowie Gross- und Kleinschreibung.

equalsIgnoreUmlaute

fun equalsIgnoreUmlaute(other: Text): Boolean

Ignoriert beim Vergleich die Umlaute.

getDistanz

fun getDistanz(other: Text): Int

Berechnet die Levenshtein-Distanz.

fun getDistanz(other: String): Int

Berechnet die Levenshtein-Distanz. Der Algorithmus dazu stammt aus http://rosettacode.org/wiki/Levenshtein_distance#Java.

hashCode

open override fun hashCode(): Int

isCharset

fun isCharset(cs: Charset): Boolean

Testet, ob das Encoding fuer den uergebenen Text stimmen kann. Die Idee dahinter ist, dass wir einen Text nach UTF-8 und wieder zurueck konvertieren. Falls es klappt, wird 'true' zurueckgegeben.

isPrintable

fun isPrintable(): Boolean

Dient zur Abfrage, ob ein Text nur gueltige (druckbare) Zeichen enthaelt. Ist dies nicht der Fall, koennte ein Encoding-Problem vorliegen.

isValid

open override fun isValid(): Boolean

Normalerweise liefert diese Methode 'true' zurueck, da es nicht moeglich ist, ungueltige Fachwerte zu erstellen. Allerdings kann man auch den Validator gegen den {@link de.jfachwert.pruefung.NullValidator} austauschen. In diesem Fall sollte diese Methode 'false' zurueck liefern, wenn der Fachwert nicht gueltig ist.

replaceUmlaute

fun replaceUmlaute(): Text

Ersetzt Umlaute und scharfes 'S'.

toLowerCase

fun toLowerCase(): Text

Liefert einen Text mit Kleinbuchstaben.

toMap

open override fun toMap(): Map<String, Any>

Liefert die einzelnen Attribute eines Fachwertes als Map. Bei einem einzelnen Wert wird als Default-Implementierung der Klassenname und die toString()-Implementierung herangezogen.

toPrintable

fun toPrintable(): Text

Wandelt einen Text in druckbare Zeichen, indem nicht druckbare Zeichen ausgefiltert werden.

toString

open override fun toString(): String

Fuer die meisten Fachwerte reicht es, einfach den internen Code als String auszugeben.

toUpperCase

fun toUpperCase(): Text

Liefert einen Text mit Grossbuchstaben.

trim

fun trim(): Text

Diese trim-Methode beruecksichtigt auch geschuetzte Leerzeichen (non-braking spaces).