Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

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

    java.lang.Object
      org.crosswire.jsword.book.filter.plaintext.PlainTextFilter

All Implemented Interfaces:
  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.

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: PlainTextFilter.java,v 1.6 2005/03/11 13:07:33 dmsmith Exp $
Author:
  Joe Walker [joe at eireneh dot com]
See Also:
  `Licence`

Constructor Summary
`PlainTextFilter()`

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

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### PlainTextFilter

    public PlainTextFilter()

Method Detail

### toOSIS

    public List toOSIS(Key key,
                       String plain)

  Description copied from interface: `Filter`
  Converter from plain (encoded) text to OSIS data

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

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Copyright ? 2003-2004
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD