Datentyp String

Wertebereich des Datentyps String

Für die Bearbeitung von Werten, die einen Text fester oder variabler Länge repräsentieren, stellt FirstSpirit den Datentyp String zur Verfügung. Ein String enthält eine Zeichenkette, die aus einer Folge von Zeichen (z. B. Buchstaben, Ziffern, Sonderzeichen und Steuerzeichen) aus einem definierten Zeichensatz besteht. Die Reihenfolge der Zeichen wird durch die Zeichenkette definiert. Alle Zeichen können sich innerhalb einer Zeichenkette beliebig oft wiederholen.

Der Datentyp String kann auch in der Java API-Dokumentation nachgeschlagen werden:

java.lang.String

Definition

In FirstSpirit wird bei der Definition eines Strings ein String-Objekt der Klasse java.lang.String erzeugt:

$CMS_SET(myString, "Das ist ein Text.")$

Definition über die Standard-Eingabekomponenten

Innerhalb des Formularbereichs von Vorlagen werden Eingabekomponenten definiert, mit deren Hilfe die Redakteure später die eigentlichen redaktionellen Inhalte in die Seite einfügen können. Die von FirstSpirit unterstützten Standard-Eingabekomponenten liefern unterschiedliche Datentypen zurück.

Die folgenden Standard-Eingabekomponenten liefern ein Objekt vom Datentyp String zurück:

• CMS_INPUT_TEXT
• CMS_INPUT_TEXTAREA

Auf diesem Objekt lassen sich dann mit Hilfe einer $CMS_VALUE(...)$-Anweisung Methoden anwenden:

$CMS_VALUE(BEZEICHNER.METHODE)$

Methoden auf String-Objekten

In der unten angegebenen Tabellen werden alle Methoden aufgelistet, die auf Objekten vom Datentyp String aufgerufen werden können.

charAt(int)

Übersicht

charAt(Number)

Übersicht

chars

Übersicht

codePointAt(int)

Übersicht

codePointBefore(int)

Übersicht

codePointCount(int, int)

Übersicht

compareTo(String)

Die Methode .compareTo(String) (in Bean-Syntax: .compareTo(String)) liefert einen lexikografischen Vergleich zweier Strings (vgl. java.lang.String). Die Methode liefert einen positiven Wert, wenn der String lexikografisch größer ist als der übergebene String und einen negativen Wert, wenn der String lexikographisch kleiner ist. Die Methode liefert 0, wenn der übergebene String identisch zum aufrufenden String ist.

Aufruf:

$CMS_SET(myString, "Das ist ein String.")$
$CMS_VALUE(myString.compareTo("Das ist ein String"))$

Ausgabe:

1

Übersicht

compareTo(Comparable)

Übersicht

compareTo(CharSequence)

Übersicht

compareTo(Object)

Übersicht

compareToIgnoreCase(String)

Übersicht

concat(String)

Übersicht

contains(String)

Die Methode .contains(String) (in Bean-Syntax: .contains(String)) liefert true zurück, wenn der übergebene Teilstring mindestens einmal in der Zeichenkette gefunden wird, oder false, wenn der Teilstring nicht gefunden wird (vgl. java.lang.String). Dabei wird zwischen Groß- und Kleinbuchstaben unterschieden.

Aufruf:

$CMS_SET(myString, "Das ist ein String.")$
$CMS_VALUE(myString.contains("ein"))$

Ausgabe:

true

Übersicht

contains(CharSequence)

Übersicht

contentEquals(StringBuffer)

Übersicht

contentEquals(CharSequence)

Übersicht

convert

Die Methode .convert() (in Bean-Syntax: .convert) werden Sonderzeichen, die in einer Zeichenkette enthalten sind, bei der Ausgabe in HTML-Zeichen umgewandelt. Es werden bei der Verwendung von .convert() die Konvertierungsregeln angewendet, die im Bereich convert der ausgewählten Konvertierungsregel des Präsentationskanales stehen.

Übersicht

convert(String)

Übersicht

convert2

Die Methode .convert2() (in Bean-Syntax: .convert2) werden Sonderzeichen, die in einer Zeichenkette enthalten sind, bei der Ausgabe in HTML-Zeichen umgewandelt. Es werden bei der Verwendung von .convert2() die Konvertierungsregeln angewendet, die im Bereich convert und quote der ausgewählten Konvertierungsregel des Präsentationskanales stehen.

Übersicht

convert2(String)

Übersicht

copyValueOf(char[])

Übersicht

copyValueOf(char[], int, int)

Übersicht

encode

Übersicht

endsWith(String)

Übersicht

equals(String)

Die Methode .equals(String) (in Bean-Syntax: .equals(String)) überprüft, ob ein String gleich einem übergebenen String ist (vgl. java.lang.String). Dabei wird zwischen Groß- und Kleinbuchstaben unterschieden.

Aufruf:

$CMS_SET(myString, "Das ist ein String.")$
$CMS_VALUE(myString.equals("Das ist ein String."))$

Ausgabe:

true

Übersicht

equals(Option)

Übersicht

equals(CharSequence)

Übersicht

equals(Object)

Übersicht

equalsIgnoreCase(String)

Die Methode .equalsIgnoreCase(String) (in Bean-Syntax: .equalsIgnoreCase(String)) überprüft, ob ein String gleich einem übergebenen String ist (vgl. java.lang.String). Dabei wird nicht – wie bei der Methode .equals(String) – zwischen Groß- und Kleinbuchstaben unterschieden.

Aufruf:

$CMS_SET(myString, "DAS ist EIN String.")$
$CMS_VALUE(myString.equals("Das ist ein String."))$

Ausgabe:

true

Übersicht

format(String, Object[])

Übersicht

format(Locale, String, Object[])

Übersicht

get(Range)

Übersicht

get(Number)

Übersicht

getBytes

Übersicht

getBytes(Charset)

Übersicht

getBytes(String)

Übersicht

getChars(int, int, char[], int)

Übersicht

getClass

Die Methode .getClass() (in Bean-Syntax: .class) liefert die Klasse des aufrufendes Objektes zurück (vgl. java.lang.Class).

Aufruf:

$CMS_VALUE(myString.class)$
$CMS_VALUE(myString.getClass())$

Ausgabe:

java.lang.String

Übersicht

getExtension

Übersicht

hashCode

Übersicht

indexOf(int)

Übersicht

indexOf(String)

Die Methode .indexOf(String) (in Bean-Syntax: .indexOf(String)) liefert einen Index der Zeichenkette zurück, an dem das erste Zeichen eines Teilstring gefunden wird, oder -1 wenn der übergebene Teilstring nicht in der Zeichenkette gefunden wird (vgl. java.lang.String). Dabei wird zwischen Groß- und Kleinbuchstaben unterschieden.

Aufruf:

$CMS_SET(myString, "Das ist ein String.")$
$CMS_VALUE(myString.indexOf("ein")$

Ausgabe:

8

Übersicht

indexOf(int, int)

Übersicht

indexOf(String, int)

Übersicht

intern

Übersicht

isCase(String)

Übersicht

isCase(Option)

Übersicht

isCase(CharSequence)

Übersicht

isCase(Object)

Übersicht

isEmpty

Die Methode .isEmpty() (in Bean-Syntax: .isEmpty) prüft, ob ein Ausdruck bzw. Objekt leer ist, z.B. storeElement.isEmpty(). Das Ergebnis der semantischen Prüfung hängt vom Ausdruck bzw. Objekt ab, z.B. eine Zeichenkette ist dann leer, wenn sie kein Zeichen enthält. Bei Objekten mit komplexen Werten oder Objekten entscheidet das Objekt wann es leer ist. Der Datentyp DomElement enthält beispielsweise immer ein leeres Dokument, ist also nie null. Die Prüfung einer leeren DOM-Editor-Eingabekomponente mit der Methode .isNull() liefert daher den Wert false, während die Prüfung der Komponente auf .isEmpty() den Wert true liefern würde.

Die Methode .isEmpty() gibt einen booleschen Wert als Ergebnis der Prüfung zurück. true (=wahr) ist die Prüfung, wenn der Ausdruck bzw. das Objekt leer ist und false (=unwahr) wenn nicht.

Übersicht

isLower

Übersicht

isNull

Die Methode .isNull() (in Bean-Syntax: .isNull) prüft, ob ein Ausdruck bzw. Objekt Null ist, z.B. storeElement.isNull(). Bei Objekten mit komplexen Werten oder Objekten entscheidet das Objekt wann es null ist. Der Datentyp DomElement enthält beispielsweise immer ein leeres Dokument, ist also nie null. Die Prüfung einer leeren DOM-Editor-Eingabekomponente mit der Methode .isNull() liefert daher den Wert false, während die Prüfung der Komponente auf .isEmpty() den Wert true liefern würde.

Die Methode .isNull() gibt einen booleschen Wert als Ergebnis der Prüfung zurück. true (=wahr) ist die Prüfung, wenn der Ausdruck bzw. das Objekt Null ist und false (=unwahr) wenn nicht.

Übersicht

isUpper

Übersicht

iterator

Übersicht

lastIndexOf(int)

Übersicht

lastIndexOf(String)

Die Methode .lastIndexOf(String) (in Bean-Syntax: .lastIndexOf(String)) liefert einen Index der Zeichenkette zurück, an dem das erste Zeichen eines Teilstring gefunden wird, oder -1 wenn der übergebene Teilstring nicht in der Zeichenkette gefunden wird (vgl. java.lang.String). Dabei wird zwischen Groß- und Kleinbuchstaben unterschieden.

Im Gegensatz zur Methode .indexOf(String) wird der Index des letzten und nicht des ersten Vorkommens zurückgeliefert.

Aufruf:

$CMS_SET(myString, "Das ist ein String.")$
$CMS_VALUE(myString.lastIndexOf("ein")$

Ausgabe:

8

Übersicht

lastIndexOf(int, int)

Übersicht

lastIndexOf(String, int)

Übersicht

length

Übersicht

lowerCase

Die Methode .lowerCase() (in Bean-Syntax: .lowerCase) konvertiert alle Zeichen der Zeichenkette in Kleinbuchstaben (vgl. java.lang.String).

Aufruf:

$CMS_SET(myString, "Das ist ein String.")$
$CMS_VALUE(myString.lowerCase)$

Ausgabe:

das ist ein string.

Übersicht

matches(String)

Übersicht

offsetByCodePoints(int, int)

Übersicht

parse

Übersicht

parseExpression

Übersicht

plain

Übersicht

plus(Printable)

Übersicht

print

Übersicht

quoteJS

Übersicht

regionMatches(int, String, int, int)

Übersicht

regionMatches(boolean, int, String, int, int)

Übersicht

replace(char, char)

Übersicht

replace(CharSequence, CharSequence)

Übersicht

replaceAll(String, String)

Übersicht

replaceFirst(String, String)

Übersicht

sentences

Übersicht

set(String, Object)

Übersicht

set(Number, CharSequence)

Übersicht

split(String)

Übersicht

split(String, int)

Übersicht

split(String, Number)

Übersicht

startsWith(String)

Die Methode prüft, ob eine Zeichenkette (z. B. ein Text) mit einer speziellen Zeichenkette beginnt. Siehe auch java.lang.String

Die Prüfung beginnt dabei beim ersten Zeichen. Soll die Prüfung bei einem anderen Zeichen des Textes beginnen, kann dies mithilfe der Methode startsWith(String, int) erreicht werden.

Die Methode gibt einen booleschen Wert als Ergebnis der Prüfung zurück. true (=wahr) ist die Prüfung, wenn der gespeicherte Text mit der in der Methode angegebenen Zeichenfolge übereinstimmt, und false (=unwahr) wenn nicht.

Beispiel:
In folgendem Beispiel wird geprüft, ob eine Eingabe mit der Zeichenfolge "Hallo" beginnt. Wenn nicht, wird in der Ausgabe dem eingegebenen Text ein "Hallo" vorangestellt.

$CMS_IF(!text.startsWith("Hallo"))$
 Hallo $CMS_VALUE(text)$
 
 $CMS_ELSE$
  $CMS_VALUE(text)$
  
$CMS_END_IF$

Bei Eingabe von Hallo Anna lautet die Ausgabe unverändert

Hallo Anna

Wird nur Anna eingegeben, wird ein "Hallo" ergänzt. Die Ausgabe lautet ebenfalls

Hallo Anna

Übersicht

startsWith(String, int)

Die Methode prüft, ob ein gespeicherter Text eine spezielle Zeichenkette an einer bestimmten Position enthält. Siehe auch java.lang.String

Die übergebene Zahl (int) legt fest, ab welchem Zeichen die Prüfung erfolgen soll. Die Zählung beginnt dabei mit 0, das erste Zeichen des zu prüfenden Textes hat also die Position 0, das zweite Zeichen, die Position 1 usw.

Die Methode gibt einen booleschen Wert als Ergebnis der Prüfung zurück. true (=wahr) ist die Prüfung, wenn der gespeicherte Text mit der in der Methode angegebenen Zeichenfolge an der angegebenen Position übereinstimmt, und false (=unwahr) wenn nicht.

Um beispielsweise zu prüfen, ob das zweite und dritte Zeichen des in eine Text-Eingabekomponente eingegebenen Texts "al" ist, kann folgende Syntax verwendet werden:

Sind das zweite und dritte Zeichen des eingegebenen Textes "al"? </br>
$CMS_IF(text.startsWith("al", 1))$
    => Das ist richtig.
$CMS_ELSE$
    => Das ist falsch.
$CMS_END_IF$

Lautet der in der Variable text gespeicherte Text falsch, wird "=> Das ist richtig." ausgegeben, ansonsten "=> Das ist falsch."

Übersicht

subSequence(int, int)

Übersicht

subString(Number)

Die Methode .subString(Number) (in Bean-Syntax: .subString(Number)) gibt eine Teilezeichenkette aus (vgl. java.lang.String). Die übergebene Zahl legt fest, ab welchem Zeichen die Ausgabe erfolgen soll (= erstes Zeichen).

Aufruf:

$CMS_SET(myString, "Das ist ein String.")$
$CMS_VALUE(myString.subString(1))$

Ausgabe:

as ist ein String.

Übersicht

subString(int, int)

Übersicht

subString(Number, Number)

Die Methode .subString(Number, Number) (in Bean-Syntax: .subString(Number, Number)) gibt eine Teilezeichenkette aus (vgl. java.lang.String). Die erste übergebene Zahl legt fest, ab welchem Zeichen (erstes Zeichen), und die zweite Zahl, bis zu welchem Zeichen (letztes Zeichen) die Zeichenkette ausgegeben werden soll.

Aufruf:

$CMS_SET(myString, "Das ist ein String.")$
$CMS_VALUE(myString.subString(1, 12))$

Ausgabe:

as ist ein

Übersicht

substring(int)

Die Methode .substring(int) (in Bean-Syntax: .substring(int)) gibt eine Teilezeichenkette aus (vgl. java.lang.String). Die übergebene Zahl legt fest, ab welchem Zeichen die Ausgabe erfolgen soll (= erstes Zeichen).

Aufruf:

$CMS_SET(myString, "Das ist ein String.")$
$CMS_VALUE(myString.substring(1))$

Ausgabe:

as ist ein String.

Übersicht

substring(Number)

Die Methode .substring(Number) (in Bean-Syntax: .substring(Number)) gibt eine Teilezeichenkette aus (vgl. java.lang.String). Die übergebene Zahl legt fest, ab welchem Zeichen die Ausgabe erfolgen soll (= erstes Zeichen).

Aufruf:

$CMS_SET(myString, "Das ist ein String.")$
$CMS_VALUE(myString.substring(1))$

Ausgabe:

as ist ein String.

Übersicht

substring(int, int)

Die Methode .substring(int, int) (in Bean-Syntax: .substring(int, int)) gibt eine Teilezeichenkette aus (vgl. java.lang.String). Die erste übergebene Zahl legt fest, ab welchem Zeichen (erstes Zeichen), und die zweite Zahl, bis zu welchem Zeichen (letztes Zeichen) die Zeichenkette ausgegeben werden soll.

Aufruf:

$CMS_SET(myString, "Das ist ein String.")$
$CMS_VALUE(myString.substring(1, 12))$

Ausgabe:

as ist ein

Übersicht

substring(Number, Number)

Die Methode .substring(Number, Number) (in Bean-Syntax: .substring(Number, Number)) gibt eine Teilezeichenkette aus (vgl. java.lang.String). Die erste übergebene Zahl legt fest, ab welchem Zeichen (erstes Zeichen), und die zweite Zahl, bis zu welchem Zeichen (letztes Zeichen) die Zeichenkette ausgegeben werden soll.

Aufruf:

$CMS_SET(myString, "Das ist ein String.")$
$CMS_VALUE(myString.substring(1, 12))$

Ausgabe:

as ist ein

Übersicht

toCharArray

Übersicht

toDate(String)

Übersicht

toJson

Übersicht

toLowerCase

Die Methode .toLowerCase() (in Bean-Syntax: .toLowerCase) konvertiert alle Zeichen der Zeichenkette in Kleinbuchstaben (vgl. java.lang.String).

Aufruf:

$CMS_SET(myString, "Das ist ein String.")$
$CMS_VALUE(myString.toLowerCase())$

Ausgabe:

das ist ein string.

Übersicht

toLowerCase(Locale)

Übersicht

toNumber

Die Methode .toNumber() (in Bean-Syntax: .toNumber) konvertiert den Datentyp String (Zeichenkette) in den Datentyp Number (Zahl) (vgl. java.lang.String). Das ist nur möglich, wenn die Zeichenkette aus Ziffern besteht.

Aufruf:

$CMS_VALUE("5".toNumber())$

Ausgabe:

5

Übersicht

toString

Übersicht

toUpperCase

Die Methode .toUpperCase() (in Bean-Syntax: .toUpperCase) konvertiert alle Zeichen der Zeichenkette in Großbuchstaben (vgl. java.lang.String).

Aufruf:

$CMS_SET(myString, "Das ist ein String.")$
$CMS_VALUE(myString.toUpperCase())$

Ausgabe:

DAS IST EIN STRING.

Übersicht

toUpperCase(Locale)

Übersicht

trim

Die Methode .trim() (in Bean-Syntax: .trim) entfernt Whitespaces am Beginn und am Ende der Zeichenkette (vgl. java.lang.String).

Aufruf:

$CMS_SET(myString, "\tDas ist ein String.\n")$
$CMS_VALUE(myString.trim())$

Ausgabe:

Das ist ein String.

Übersicht

type

Übersicht

upperCase

Die Methode .upperCase() (in Bean-Syntax: .upperCase) konvertiert alle Zeichen der Zeichenkette in Großbuchstaben (vgl. java.lang.String).

Aufruf:

$CMS_SET(myString, "Das ist ein String.")$
$CMS_VALUE(myString.upperCase)$

Ausgabe:

DAS IST EIN STRING.

Übersicht

urlEncode

Mit der Methode .urlEncode() (in Bean-Syntax: .urlEncode) kann eine Zeichenkette in ASCII-Zeichensequenzen umgewandelt werden. Das Umwandeln wird auch encode genannt. Typisch für solche Zeichensequenzen ist ein %-Zeichen gefolgt von zwei Zeichen. Der MIME-Type für eine umgewandelte Zeichenkette ist application/x-www-form-urlencoded.

Bei der Umwandlung werden folgende Zeichen nicht berücksichtigt:

A-Z  a-z 0-9 . - * _

Leerzeichen werden in Pluszeichen umgewandelt.

Für die Umwandlung wird folgendes Encoding verwendet: UTF-8.

Der Aufruf:

$CMS_VALUE("Diese Zeichenkette enthält Sonderzeichen".urlEncode)$

führt zu der umgewandelten Zeichenkette:

Diese+Zeichenkette+enth%C3%A4lt+Sonderzeichen

Vgl. auch java.net.URLEncoder

Übersicht

urlEncode(String)

Mit der Methode .urlEncode() (in Bean-Syntax: .urlEncode) kann eine Zeichenkette in ASCII-Zeichensequenzen umgewandelt werden. Das Umwandeln wird auch encode genannt. Typisch für solche Zeichensequenzen ist ein %-Zeichen gefolgt von zwei Zeichen. Der MIME-Type für eine umgewandelte Zeichenkette ist application/x-www-form-urlencoded.

Bei Verwendung von .urlEncode() wird eine Umwandlung nach UTF-8 vorgenommen.
Durch die Verwendung von .urlEncode(String) kann das zu verwendende Encoding spezifiziert werden.

Beispielsweise führt der Aufruf

$CMS_VALUE("Müller@e-Spirit.com".urlEncode("ISO-8859-1"))$

zu der umgewandelten Zeichenkette:

M%FCller%40e-Spirit.com

Übersicht

valueOf(long)

Übersicht

valueOf(int)

Übersicht

valueOf(float)

Übersicht

valueOf(double)

Übersicht

valueOf(char)

Übersicht

valueOf(boolean)

Übersicht

valueOf(char[])

Übersicht

valueOf(Object)

Übersicht

valueOf(char[], int, int)

Übersicht

words

Übersicht