org.apache.ecs.filter
Class CharacterFilter

java.lang.Object
  |
  +--java.util.Dictionary
        |
        +--java.util.Hashtable
              |
              +--org.apache.ecs.filter.CharacterFilter

All Implemented Interfaces:

java.lang.Cloneable, Filter, java.util.Map, java.io.Serializable

public class CharacterFilter

extends java.util.Hashtable

implements Filter

This class creates a Filter object. The default characters filtered are:
" ' & < >

For example:

Filter filter = new CharacterFilter();
filter.addAttribute("$","dollar");
filter.addAttribute("#",Entities.POUND);

P p = new P();
p.setFilter(filter);

Document doc = new Document();
doc.getBody().addElement(p);

The filter is applied when the addElement() method is called.

Version:

$Id: CharacterFilter.java,v 1.7 2003/04/27 09:28:56 rdonkin Exp $

Author:

Stephan Nagy, Jon S. Stevens

See Also:

Serialized Form

Inner classes inherited from class java.util.Map

java.util.Map.Entry

Fields inherited from class java.util.Hashtable

count, emptyEnumerator, emptyIterator, ENTRIES, entrySet, KEYS, keySet, loadFactor, modCount, serialVersionUID, table, threshold, values, VALUES

Constructor Summary

CharacterFilter()

Method Summary

(package private) void	() Private initializer.
Filter	addAttribute(java.lang.String name, java.lang.Object attribute) Register things to be filtered.
java.lang.String	getInfo() Returns the name of the filter
boolean	hasAttribute(java.lang.String key) Check to see if something is going to be filtered.
java.lang.String	process(java.lang.String to_process) Perform the filtering operation.
Filter	removeAttribute(java.lang.String name) Remove things to be filtered.

Methods inherited from class java.util.Hashtable

clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, get, getEnumeration, getIterator, hashCode, isEmpty, keys, keySet, put, putAll, readObject, rehash, remove, size, toString, values, writeObject

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, registerNatives, wait, wait, wait

Constructor Detail

CharacterFilter

public CharacterFilter()

Method Detail

void ()

Private initializer. " ' & < > are the default filters.

Overrides:

in class java.util.Hashtable

getInfo

public java.lang.String getInfo()

Returns the name of the filter

Specified by:

getInfo in interface Filter

addAttribute

public Filter addAttribute(java.lang.String name,
                           java.lang.Object attribute)

Register things to be filtered.

Specified by:

addAttribute in interface Filter

removeAttribute

public Filter removeAttribute(java.lang.String name)

Remove things to be filtered.

Specified by:

removeAttribute in interface Filter

hasAttribute

public boolean hasAttribute(java.lang.String key)

Check to see if something is going to be filtered.

Specified by:

hasAttribute in interface Filter

process

public java.lang.String process(java.lang.String to_process)

Perform the filtering operation.

Specified by:

process in interface Filter