org.crosswire.jsword.book.filter

Interface SourceFilter

All Superinterfaces:

Cloneable

All Known Implementing Classes:

GBFFilter, OSISFilter, PlainTextFilter, THMLFilter

public interface SourceFilter
extends Cloneable

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

Author:

Joe Walker

See Also:

The GNU Lesser General Public License for details.

Method Summary

Methods

Modifier and Type	Method and Description
SourceFilter	clone() This needs to be declared here so that it is visible as a method on a derived Filter.
List<org.jdom2.Content>	toOSIS(Book book, Key key, String plain) Converter from plain (encoded) text to OSIS data

Method Detail

toOSIS

List<org.jdom2.Content> toOSIS(Book book,
                             Key key,
                             String plain)

Converter from plain (encoded) text to OSIS data

Parameters:

book - the book

key - The key for the text

plain - The encoded text

Returns:

a List of OSIS Elements

clone

SourceFilter clone()

This needs to be declared here so that it is visible as a method on a derived Filter.

Returns:

A complete copy of ourselves