org.qbroker.common

Class Template

java.lang.Object

org.qbroker.common.Template

public class Template
extends java.lang.Object

Template is a template to format a text string. A Template contains placeholders or variables which are to be substituted by their values. These placeholders or variables are delimited with certain character sequences. The default sequence is '##' on both sides of the placeholder name. For example, a template might look like
First Name: ##firstname##
Last Name: ##lastname##
where ##firstname## and ##lastname## are two placeholders. The substitute method will replace them with the given values. The name of the placeholder is called field. It is OK for a field to contain certain Perl5 meta chars.

When a Template object is instantiated, the text is scanned for any pattern of ##[^#]+## as the placeholders it may contain. In this case, a legal field name is any sequence of characters that does not contain a hashsign. In general, Template supports customized patterns for placeholders or variables, such as \([^\(\)]+\) or \$\{[^\$\{\}]+\}, etc.

Template also provides the methods for the actual substitutions. They require either a key-value pair or a Map with all key-value pairs.

Author:

yannanlu@yahoo.com

Constructor Summary

Constructors

Constructor and Description
Template(java.io.File file)
Template(java.io.File file, boolean needChop)
Template(java.lang.Object obj, java.lang.String pattern)
Template(java.lang.Object obj, java.lang.String pattern, boolean needChop)
Template(java.lang.String text)

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	containsField(java.lang.String key)
java.lang.String	copyText()
protected void	finalize()
java.lang.String[]	getAllFields()
java.lang.String	getField(int i)
org.apache.oro.text.regex.Pattern	getPattern(java.lang.String field)
java.lang.String[]	getSequence()
java.util.Iterator	iterator()
int	numberOfFields()
int	substitute(java.lang.StringBuffer result, java.lang.String field, java.lang.String value, java.lang.String input)
java.lang.String	substitute(java.lang.String input, java.util.Map map)
java.lang.String	substitute(java.lang.String field, java.lang.String value, java.lang.String input)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Template

public Template(java.lang.Object obj,
                java.lang.String pattern,
                boolean needChop)

Template

public Template(java.lang.Object obj,
                java.lang.String pattern)

Template

public Template(java.io.File file,
                boolean needChop)

Template

public Template(java.lang.String text)

Template

public Template(java.io.File file)

Method Detail

containsField

public boolean containsField(java.lang.String key)

numberOfFields

public int numberOfFields()

copyText

public java.lang.String copyText()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getPattern

public org.apache.oro.text.regex.Pattern getPattern(java.lang.String field)

getField

public java.lang.String getField(int i)

getAllFields

public java.lang.String[] getAllFields()

getSequence

public java.lang.String[] getSequence()

iterator

public java.util.Iterator iterator()

substitute

public java.lang.String substitute(java.lang.String field,
                                   java.lang.String value,
                                   java.lang.String input)

substitute

public java.lang.String substitute(java.lang.String input,
                                   java.util.Map map)

substitute

public int substitute(java.lang.StringBuffer result,
                      java.lang.String field,
                      java.lang.String value,
                      java.lang.String input)

clear

public void clear()

finalize

protected void finalize()

Overrides:

finalize in class java.lang.Object