org.apache.ecs
Interface Filter

All Known Implementing Classes:

CharacterFilter, WordFilter, StringFilter, NullFilter, RegexpFilter

public interface Filter

This class creates an interface for all filters.

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: Filter.java,v 1.2 2003/04/27 09:43:57 rdonkin Exp $

Author:

Stephan Nagy, Jon S. Stevens

Method Summary

Filter	addAttribute(java.lang.String name, java.lang.Object attribute)
java.lang.String	getInfo()
boolean	hasAttribute(java.lang.String key)
java.lang.String	process(java.lang.String to_process)
Filter	removeAttribute(java.lang.String name)

Method Detail

addAttribute

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

removeAttribute

public Filter removeAttribute(java.lang.String name)

hasAttribute

public boolean hasAttribute(java.lang.String key)

process

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

getInfo

public java.lang.String getInfo()