Die Schablone

Übersicht: Die Schablone

• Was beinhaltet die Schablone?
• Die Velocity Template Language (VTL)
  • Einleitung
  • Referenzen
  • Formale Referenzen-Notation
  • Direktiven
  • Kommentare
  • Sonderzeichen

Was beinhaltet die Schablone?

Die Velocity Template Language (VTL)

Referenzen
Es gibt drei Typen von Referenzen: Variablen, Eigenschaften und Methoden. Jede Referenz verweißt auf ein beliebiges Objekt. Wird in einer Referenz auf ein anderes Objekt als das "String"-Objekt verwiesen, wird automatisch die "toString"-Methode des Objektes aufgerufen, da die VTL nur Text darstellen kann.

Variablen:

Formale Referenzen-Notation
Die oben beschriebene Notation ist die kurze Notation, die auch meistens in der Schablone benutzt wird. Das folgende Beispiel beschreibt aber eine Problematik, die mit dieser Notation in einigen Fällen auftreten könnte:
Die Variable "$studienrichtung" beinhaltet einen der folgenden Werte: "Wirtschafts" oder "Medien". In einer Schablone soll der Satz "Er studiert "Wirtschafts/Medien"informatik" angezeigt werden. Da es sich dabei um ein zusammenhängendes Wort handelt, darf kein Leerzeichen zwischen der Variable und dem Rest des Satzes stehen. In der Schablone würde der Satz so aussehen: "Er studiert $studienrichtunginformatik" Velocity kennt den so angegebenen Variablennamen aber nicht. Die formale Notation für Referenzen bereinigt dieses Problem. Sie besagt, dass alles hinter dem "$"-Zeichen in "{ }" zu stehen hat:
${studienrichtung}
${Variable.Eigenschaft}
${Variable.Methode()}

Direktiven
#set
Die Anweisung "#set" ordnet einer Variable oder einer Eigenschaft "$a" einen Wert "Wert" zu.

#set ( $a = Wert )

#if ( $value )
      Alles klar!
#end

1. der Typ von $value ist boolean (true => Ausgabe des Textes; sonst keine Ausgabe)
2. der Typ von $value ist nicht boolean (Ausgabe des Textes, wenn der Wert von $value ungleich "null" ist)

#if( $value < 10 )
      kleiner als 10
#elseif( $value == 10 )
      gleich 10
#elseif( $value == 16 )
      gleich 16
#else
      was anderes
#end 

#if( ($value < 10 && $value > 5) || ($value == 42) )

#foreach( $product in $allProducts )
    $product
#end

#foreach( $product in $allProducts )
    Produktnummer = $velocityCount Produktname = $product
#end

# Default name of the loop counter
# variable reference
directive.foreach.counter.name = velocityCount

# Default starting value of the loop
# counter variable reference
directive.foreach.counter.initial.value = 1

#include( "one.txt" )
#include( "one.txt","two.txt","three.htm" )

#include( "one.txt", $filename )

directive.parse.max.depth = 10

01 Count down.
02 #set( $count = 8 )
03 #parse( "rekursion.vm" )
04 All done with dofoo.vm!

01 $count
02 #set( $count = $count - 1 )
03 #if( $count > 0 )
04     #parse( "rekursion.vm" )
05 #else
06     Alles klar!
07 #end

Count down
8
7
6
5
4
3
2
1
     Alles klar.

#macro( beispiel )
--------T-R-E-N-N-L-I-N-I-E--------
#end

01 #macro( tablerows $somelist )
02 #foreach( $something in $somelist )
03     $something
04 #end
05 #end
06
07 #set( $greatlakes = ["Superior","Michigan","Huron","Erie","Ontario"] )
08
09 #tablerows( $greatlakes )

Superior
Michigan
Huron
Erie
Ontario

velocimacro.library = VM_global_library.vm

Kommentare
Die VTL unterstützt auch Kommentare. Ein Zeilenkommentar wird mit "##" eingeleitet. Mehrzeilige Kommentare starten mit "#*" und enden mit "*#".

Sonderzeichen
Wenn definierte Variablen ausgegeben werden sollen (NICHT deren Wert) benötigt Velocity einen Hinweis, dass der Name und nicht der Wert gemeint ist.
Dieses geschieht durch das "\"-Zeichen:

( #set ($name= "Hans")
$name
\$name
\\$name

Hans
$name
\Hans