org.crosswire.jsword.book.filter
Interface Filter

All Known Implementing Classes:

GBFFilter, OSISFilter, PlainTextFilter, THMLFilter

public interface Filter

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

Distribution Licence:
JSword is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 2 as published by the Free Software Foundation.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
The License is available on the internet here, or by writing to: Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
The copyright to this program is held by it's authors.

Version:

$Id: Filter.java,v 1.7 2005/03/05 22:08:06 dmsmith Exp $

Author:

Joe Walker [joe at eireneh dot com]

See Also:

Licence

Method Summary

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

Method Detail

toOSIS

List toOSIS(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