oracle.ifs.utils.io

Class SymbolCommuter

java.lang.Object

oracle.ifs.utils.io.SymbolCommuter

All Implemented Interfaces:

StringProcessor

public class SymbolCommuter
extends Object
implements StringProcessor

The SymbolCommuter class commutes, or substitutes, values for symbols.

Symbols can be inserted into text as a placeholder for variables. SymbolCommuter will replace the symbols with values defined by a key/value pair mapping.

Symbols are denoted by a name and one or two tokens that either preceed or surround the symbol. The SymbolType class represents types of symbols that can be inserted into text as a placeholder for a value.

This class implements the StringProcessor interface so that it can be used with LineFilterReader to process a stream.

Version:

1.3

Author:

Luis Saenz

Modified:

dlong 01/25/2005 change handleItem to return boolean, lsaenz 03/03/2000 Added support for processing files in a directory., lsaenz 02/10/2000 Fixed getSymbolsInString to return an Enumeration rather than a Vector., lsaenz 11/20/1999 Fixed NullPointerException bug in findSymbol() when clients pass in a null Hashtable to the constructor., lsaenz 11/12/1999 Added methods getSymbolsInFile() and getSymbolsInString()., lsaenz 11/11/1999 Fixed circular reference bug., lsaenz 11/07/1999 Added processFile()., lsaenz 11/02/1999 Created.

Field Summary

Fields

Modifier and Type	Field and Description
static int	RAISE_EXCEPTION Raise exceptions when symbols are undefined.
static int	REMOVE_SYMBOL Remove symbols that are undefined
static int	SKIP Skip symbols that are undefined.

Constructor Summary

Constructors

Constructor and Description
SymbolCommuter(Hashtable symbolTable) Creates a new SymbolCommuter with default settings.
SymbolCommuter(Hashtable symbolTable, SymbolType type) Creates a new SymbolCommuter given a SymbolType to search for.

Method Summary

Modifier and Type	Method and Description
void	addSymbolType(SymbolType type) Adds a SymbolType to search for when substituting values for symbols.
Vector	getSymbolsInFile(String inputFile) Returns all the symbols in a file, even if they are not mapped to values in this SymbolCommuter's table of key/value pairs.
Vector	getSymbolsInString(String str) Returns all the symbols in a String, even if they are not mapped to values in this SymbolCommuter's table of key/value pairs.
Enumeration	getSymbolTypes() Returns an Enumeration of the SymbolTypes in use.
void	processDirectory(String sourceDir) Replaces symbols in all text files in a given directory.
void	processDirectory(String sourceDir, String destDir) Replaces symbols in all text files in a given directory.
void	processFile(String inputFile) Replaces symbols with values in a text file.
void	processFile(String inputFile, String outputFile) Replaces symbols with values in a text file.
String	processString(String input) Replaces all symbols in the input String with values from this SymbolCommuter's symbol table.
void	removeSymbolType(SymbolType type) Removes a SymbolType to look for when substituting values for symbols.
void	setUndefinedAction(int action) Sets the action to take when an undefined symbol is found.

Methods inherited from class java.lang.Object

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

Field Detail

SKIP

public static final int SKIP

Skip symbols that are undefined.

See Also:

Constant Field Values

RAISE_EXCEPTION

public static final int RAISE_EXCEPTION

Raise exceptions when symbols are undefined.

See Also:

Constant Field Values

REMOVE_SYMBOL

public static final int REMOVE_SYMBOL

Remove symbols that are undefined

See Also:

Constant Field Values

Constructor Detail

SymbolCommuter

public SymbolCommuter(Hashtable symbolTable)

Creates a new SymbolCommuter with default settings. All default symbol types are searched and undefined symbols are skipped. The default symbol types are: SymbolType.DOS, SymbolType.UNIX, and SymbolType.SQL

Parameters:

symbolTable - a Hashtable mapping symbol names to values.

SymbolCommuter

public SymbolCommuter(Hashtable symbolTable,
                      SymbolType type)

Creates a new SymbolCommuter given a SymbolType to search for. Undefined symbols are skipped.

Parameters:

symbolTable - a Hashtable mapping symbol names to values.

type - the SymbolType to search for when processing Strings.

Method Detail

setUndefinedAction

public void setUndefinedAction(int action)

Sets the action to take when an undefined symbol is found.

Parameters:

action - the action to take: SKIP, RAISE_EXCEPTION, or REMOVE_SYMBOL.

addSymbolType

public void addSymbolType(SymbolType type)

Adds a SymbolType to search for when substituting values for symbols.

Parameters:

type - the SymbolType to add.

removeSymbolType

public void removeSymbolType(SymbolType type)

Removes a SymbolType to look for when substituting values for symbols.

Parameters:

type - the SymbolType to remove.

getSymbolTypes

public Enumeration getSymbolTypes()

Returns an Enumeration of the SymbolTypes in use.

processString

public String processString(String input)

Replaces all symbols in the input String with values from this SymbolCommuter's symbol table.

Specified by:

processString in interface StringProcessor

Parameters:

input - the input String.

Returns:

the processed output String with values in place of the symbols in the input String.

processFile

public void processFile(String inputFile)
                 throws IOException,
                        FileNotFoundException

Replaces symbols with values in a text file. Modifies the given file in place (a temporary file is used).

Parameters:

inputFile - the file to process.

Throws:

IOException

FileNotFoundException

processFile

public void processFile(String inputFile,
                        String outputFile)
                 throws IOException,
                        FileNotFoundException

Replaces symbols with values in a text file.

Parameters:

inputFile - the file to process.

outputFile - the file to save changes into.

Throws:

IOException

FileNotFoundException

processDirectory

public void processDirectory(String sourceDir)
                      throws DirectoryItemHandlerException

Replaces symbols in all text files in a given directory. Modifies each file in place (a temporary file is used).

Parameters:

sourceDir - the directory to process.

Throws:

DirectoryItemHandlerException

processDirectory

public void processDirectory(String sourceDir,
                             String destDir)
                      throws DirectoryItemHandlerException

Replaces symbols in all text files in a given directory. Saves each processed file to the given destination directory.

Parameters:

sourceDir - the directory to process.

destDir - the directory to save processed files to.

Throws:

DirectoryItemHandlerException

getSymbolsInFile

public Vector getSymbolsInFile(String inputFile)
                        throws IOException,
                               FileNotFoundException

Returns all the symbols in a file, even if they are not mapped to values in this SymbolCommuter's table of key/value pairs.

Returns:

a Vector containing Strings that represent symbol names. The Vector contains every symbol that occurs in the given file, without the symbol characters.

Throws:

IOException - if an I/O error occurs.

FileNotFoundException - if the file could not be found.

getSymbolsInString

public Vector getSymbolsInString(String str)

Returns all the symbols in a String, even if they are not mapped to values in this SymbolCommuter's table of key/value pairs.

Returns:

a Vector containing Strings representing symbol names. The Enumeration contains every symbol that occurs in the given string, without the symbol characters. i.e. given the string "Hello %FOO% $BAR" this method would return a Vector containing the Strings "FOO" and "BAR". The symbols are returned in the order that they occur, without regard to symbol type; however, only symbol types that are specified when this class is created are returned.