org.crosswire.jsword.book.filter.plaintext
Class PlainTextFilter

java.lang.Object
  extended by org.crosswire.jsword.book.filter.plaintext.PlainTextFilter
All Implemented Interfaces:
Cloneable, Filter

public class PlainTextFilter
extends Object
implements Filter

Filter to convert plain text to OSIS format. Plain text is nothing more than lines without markup. Unfortunately, it often uses whitespace for markup. We will use OSIS lb to mark lines.

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

Constructor Summary
PlainTextFilter()
           
 
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
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PlainTextFilter

public PlainTextFilter()
Method Detail

toOSIS

public List toOSIS(Book book,
                   Key key,
                   String plain)
Description copied from interface: Filter
Converter from plain (encoded) text to OSIS data

Specified by:
toOSIS in interface Filter
key - The key for the text
plain - The encoded text
Returns:
a List of OSIS Elements

clone

public Object clone()
Description copied from interface: Filter
This needs to be declared here so that it is visible as a method on a derived Key.

Specified by:
clone in interface Filter
Overrides:
clone in class Object
Returns:
A complete copy of ourselves

Copyright ยจ 2003-2007