de.tudarmstadt.ukp.jwktl.api.util

Class TemplateParser.Template

java.lang.Object

de.tudarmstadt.ukp.jwktl.api.util.TemplateParser.Template

Enclosing class:

TemplateParser

public static class TemplateParser.Template
extends Object

A template is a reusable pattern that can be added to any wiki page. The template is being substituted by its definition upon rendering the wiki page to HTML. A template has a unique name. It can be equipped with multiple parameters. The parameters are divided into numbered and named parameters. The former are indexed by integers (starting with 0); the latter are key-value parirs.

Author:

Christian M. Meyer

Field Summary

Fields

Modifier and Type	Field and Description
protected String	name
protected Map<String,String>	namedParams
protected List<String>	numberedParams

Constructor Summary

Constructors

Constructor and Description
Template(String name) Creates a new template with the given name.

Method Summary

Modifier and Type	Method and Description
void	addParam(String value) Add a numbered parameter with the given value.
void	addParam(String key, String value) Add a named parameter with the given key and value.
String	getName() Returns the name of the template.
String	getNamedParam(String key) Return the named parameter with the given key or null/ if no such parameter exists.
Iterable<Map.Entry<String,String>>	getNamedParams() Iterate over all named parameters.
int	getNamedParamsCount() Returns number of all named parameters.
String	getNumberedParam(int idx) Return the numbered parameter with the given index or null/ if no such parameter exists.
Iterable<String>	getNumberedParams() Iterate over all numbered parameters.
int	getNumberedParamsCount() Returns number of all numbered parameters.
int	getParamsCount() Returns the number of all parameters (including numbered and named paramters).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

name

protected String name

namedParams

protected Map<String,String> namedParams

numberedParams

protected List<String> numberedParams

Constructor Detail

Template

public Template(String name)

Creates a new template with the given name.

Method Detail

getName

public String getName()

Returns the name of the template.

addParam

public void addParam(String value)

Add a numbered parameter with the given value.

addParam

public void addParam(String key,
                     String value)

Add a named parameter with the given key and value.

getNumberedParam

public String getNumberedParam(int idx)

Return the numbered parameter with the given index or null/ if no such parameter exists.

getNamedParam

public String getNamedParam(String key)

Return the named parameter with the given key or null/ if no such parameter exists.

getNumberedParams

public Iterable<String> getNumberedParams()

Iterate over all numbered parameters.

getNamedParams

public Iterable<Map.Entry<String,String>> getNamedParams()

Iterate over all named parameters.

getParamsCount

public int getParamsCount()

Returns the number of all parameters (including numbered and named paramters).

getNumberedParamsCount

public int getNumberedParamsCount()

Returns number of all numbered parameters.

getNamedParamsCount

public int getNamedParamsCount()

Returns number of all named parameters.