1   /**
2    * Distribution License:
3    * JSword is free software; you can redistribute it and/or modify it under
4    * the terms of the GNU Lesser General Public License, version 2.1 or later
5    * as published by the Free Software Foundation. This program is distributed
6    * in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even
7    * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
8    * See the GNU Lesser General Public License for more details.
9    *
10   * The License is available on the internet at:
11   *      http://www.gnu.org/copyleft/lgpl.html
12   * or by writing to:
13   *      Free Software Foundation, Inc.
14   *      59 Temple Place - Suite 330
15   *      Boston, MA 02111-1307, USA
16   *
17   * © CrossWire Bible Society, 2005 - 2016
18   *
19   */
20  package org.crosswire.jsword.book.filter;
21  
22  import java.util.List;
23  
24  import org.crosswire.jsword.book.Book;
25  import org.crosswire.jsword.passage.Key;
26  import org.jdom2.Content;
27  
28  /**
29   * A generic interface for things that can convert a String into OSIS data.
30   * 
31   * @see gnu.lgpl.License The GNU Lesser General Public License for details.
32   * @author Joe Walker
33   */
34  public interface SourceFilter extends Cloneable {
35      /**
36       * Converter from plain (encoded) text to OSIS data
37       * 
38       * @param book the book
39       * @param key
40       *            The key for the text
41       * @param plain
42       *            The encoded text
43       * @return a List of OSIS Elements
44       */
45      List<Content> toOSIS(Book book, Key key, String plain);
46  
47      /**
48       * This needs to be declared here so that it is visible as a method on a
49       * derived Filter.
50       * 
51       * @return A complete copy of ourselves
52       */
53      SourceFilter clone();
54  }
55