org.crosswire.jsword.book.filter
Interface Filter

All Superinterfaces:
Cloneable
All Known Implementing Classes:
GBFFilter, OSISFilter, PlainTextFilter, THMLFilter

public interface Filter
extends Cloneable

A generic interface for things that can convert a String into OSIS data.

Author:
Joe Walker [joe at eireneh dot com]
See Also:
for license details. The copyright to this program is held by it's authors.

Method Summary
 Object clone()
          This needs to be declared here so that it is visible as a method on a derived Key.
 List toOSIS(Book book, Key key, String plain)
          Converter from plain (encoded) text to OSIS data
 

Method Detail

toOSIS

List toOSIS(Book book,
            Key key,
            String plain)
            throws FilterException
Converter from plain (encoded) text to OSIS data

Parameters:
key - The key for the text
plain - The encoded text
Returns:
a List of OSIS Elements
Throws:
FilterException

clone

Object clone()
This needs to be declared here so that it is visible as a method on a derived Key.

Returns:
A complete copy of ourselves

Copyright ยจ 2003-2007