com.knowgate.xhtml

Class FastStreamReplacer

java.lang.Object

com.knowgate.xhtml.FastStreamReplacer

public class FastStreamReplacer
extends Object

Search and Replace a set of substrings with another substrings.

This class is a single-pass fast no wildcards replacer for a given set of substrings.

It is primarily designed for mail merge document personalization routines, where a small number of substrings have to be replaced at a master document with data retrieved from a list or database.

Version:

2.1

Author:

Sergio Montoro Ten

Constructor Summary

Constructors

Constructor and Description
FastStreamReplacer()
FastStreamReplacer(int iBufferSize)

Method Summary

Modifier and Type	Method and Description
static HashMap	createMap(String[] aKeys, String[] aValues) Create a HashMap for a couple of String Arrays
int	lastReplacements() Number of replacements done in last call to replace() method.
String	replace(InputStream oFileInStream, HashMap oMap) Replace substrings from a Stream.
String	replace(StringBuffer oStrBuff, HashMap oMap) Replace subtrings from a StringBuffer.
String	replace(String sFilePath, HashMap oMap) Replace substrings from a Text File.

Methods inherited from class java.lang.Object

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

Constructor Detail

FastStreamReplacer

public FastStreamReplacer()

FastStreamReplacer

public FastStreamReplacer(int iBufferSize)

Method Detail

replace

public String replace(InputStream oFileInStream,
                      HashMap oMap)
               throws IOException

Replace substrings from a Stream.

Parameters:

oFileInStream - Input Stream containing substrings to be replaced.

oMap - Map with values to be replaced.
Each map key will be replaced by its value.
Map keys must appear in stream text as {#key}
For example: InputStream "Today is {#System.Date}" will be replaced with "Today is 2002-02-21 11:32:44"
No wildcards are accepted.
Map keys must not contain {# } key markers.

Returns:

String Replacements Result

Throws:

IOException

replace

public String replace(StringBuffer oStrBuff,
                      HashMap oMap)
               throws IOException,
                      IndexOutOfBoundsException

Replace subtrings from a StringBuffer.

Parameters:

oStrBuff - StringBuffer containing substrings to be replaced.

oMap - Map with values to be replaced.
Each map key will be replaced by its value.
Map keys must appear in stream text as {#key}
For example: InputStream "Today is {#System.Date}" will be replaced with "Today is 2002-02-21 11:32:44"
No wildcards are accepted.
Map keys must not contain {# } key markers.

Returns:

String Replacements Result

Throws:

IOException

IndexOutOfBoundsException

replace

public String replace(String sFilePath,
                      HashMap oMap)
               throws IOException

Replace substrings from a Text File.

Parameters:

sFilePath - File containing text to be replaced.

oMap - Map with values to be replaced.
Each map key will be replaced by its value.
Map keys must appear in stream text as {#key}
For example: InputStream "Today is {#System.Date}" will be replaced with "Today is 2002-02-21 11:32:44"
No wildcards are accepted.
Map keys must not contain {# } key markers.

Returns:

String Replacements Result.

Throws:

IOException

lastReplacements

public int lastReplacements()

Number of replacements done in last call to replace() method.

Returns:

int

createMap

public static HashMap createMap(String[] aKeys,
                                String[] aValues)
                         throws ArrayIndexOutOfBoundsException

Create a HashMap for a couple of String Arrays

This method is just a convenient shortcut for creating input HashMap for replace methods from this class

Parameters:

aKeys - An array of Strings to be used as keys

aValues - An array of Strings that will be the actual values for the keys

Returns:

A HashMap with the given keys and values

Throws:

ArrayIndexOutOfBoundsException