the properties file

It contains the messages used to render the template. It facilitates internationalization.

properties file static_message=hi! dynamic_message=hello {0} dynamic_message_with_choices=The disk {0} contains {1,choices,0#no file|1#one file|1<{0,number,integer} files}.

the model

It is a simple Map of key-value pairs where:

• key is a String
• value is an Object or a List of model

Each tag (see syntax below) is replaced in the template by a computed value (using one or more keys).

If a key is not present in the template, an exception is thrown. An optional flag permits to render the page even if the key is not present. In this case, the tag is replaced by nothing...

java code model = new HashMap(); model.put("firstname", "john"); model.put("which_message", "dynamic_message"); model.put("disk_name", "myDisk"); final ArrayList mylist = new ArrayList(); mylist.add(new HashMap() {{ put("total", 0); }}); mylist.add(new HashMap() {{ put("total", 1); put("disk_name", "yourDisk"); }}); mylist.add(new HashMap() {{ put("total", 1234); }}); mylist.add(new HashMap() {{ }}); model.put("mylist", mylist);

the filters

The filters allow to render a value by applying specific code.

You can apply one or more filters on a key (see syntax below).

java code filters = new HashMap<String, Filter>(); // interface Filter : String to String filters.put("upper", new Filter() { public String apply(String value) { return value.toUpperCase(); } }); filters.put("lower", new Filter() { public String apply(String value) { return value.toLowerCase(); } }); filters.put("quote", new Filter() { public String apply(String value) { return "'" + value + "'"; } }); // interface ObjectFilter : InType to OutType filters.put("size", new ObjectFilter<Collection,Integer>() { public Integer apply(Collection value) { return value.size(); } }); filters.put("gt0", new ObjectFilter<Integer,Boolean>() { public Boolean apply(Integer value) { return value.intValue() > 0; } }); filters.put("add", new ObjectFilter<Integer[],Integer>() { public Integer apply(Integer values[]) { int sum = 0; for (value : values) { sum += value.intValue(); } return sum; } });

The input type of the next filter must be the output type of the previous filter except if the input type is String.

In this case, the .toString() method is called to pass data to the next filter.

Finally, if the output type is an array, the input type must also be an array.

the templates

a template without section

withoutsection.tpl This is a file without section. ~'dynamic_message[firstname]~ Bye ~firstname:upper~

java code template = new Template("withoutsection.tpl", filters, messages, Locale.ENGLISH); OutputStreamWriter out = new OutputStreamWriter(System.out); template.printFile(out, model); out.flush();

a template with one or more sections

withsection.tpl <!-- #section section1 --> This is a file with one or more sections. ~'dynamic_message[firstname]~ <!-- #section section2 --> Bye ~firstname:upper~

java code template = new Template("withsection.tpl", filters, messages, Locale.ENGLISH); OutputStreamWriter out = new OutputStreamWriter(System.out); template.printSection(out, "section1", model1); // model1 = model.clone() template.printSection(out, "section2", model2); // model2 = model.clone() out.flush();

tag syntax with examples

{ }
            

{ 'firstname': 'john' }
            

{ 'firstname': 'john' }
            

{ }
            

{ }
            

{ 'firstname': 'john' }     
            

{ }     
            

{ 'firstname': 'john' }     
            

{ 'firstname': 'john',
  'which_message': 'dynamic_message' }     
            

{ 'firstname': 'john' }     
            

{ 'disk_name': 'myDisk',
  'mylist': [ { 'total': 0 }, 
              { 'total': 1, 
                'disk_name': 'yourDisk' }, 
              { 'total': 1234 },
              { 'disk_name': 'yourDisk' }
            ] }     

{ 'boolean': true, 'firstname': 'John' }

{ 'boolean': false, 'firstname': 'John' }

{ 'list1: [ { 'name': 'John' }, { 'name': 'Jane' } ],
  'list2: [ { 'name': 'Paul' } ] }