Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
Tag |
|
| 1.0;1 |
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.thml; | |
21 | ||
22 | import org.crosswire.jsword.book.Book; | |
23 | import org.crosswire.jsword.passage.Key; | |
24 | import org.jdom2.Element; | |
25 | import org.xml.sax.Attributes; | |
26 | ||
27 | /** | |
28 | * THML Tag interface - there should be one implementation of this class for | |
29 | * each THML tag. | |
30 | * | |
31 | * @see gnu.lgpl.License The GNU Lesser General Public License for details. | |
32 | * @author Joe Walker | |
33 | */ | |
34 | public interface Tag { | |
35 | /** | |
36 | * What element does this class represent. For example the Tag that | |
37 | * represents the font element would return the string "font". | |
38 | * @return the element's tag name | |
39 | */ | |
40 | String getTagName(); | |
41 | ||
42 | /** | |
43 | * Make changes to the specified OSIS element given the attributes passed in | |
44 | * the source document. | |
45 | * | |
46 | * @param book the book | |
47 | * @param key the key | |
48 | * @param ele | |
49 | * The OSIS element to use as a parent | |
50 | * @param attrs | |
51 | * The source document attributes. | |
52 | * @return the element to which content is attached | |
53 | */ | |
54 | Element processTag(Book book, Key key, Element ele, Attributes attrs); | |
55 | ||
56 | /** | |
57 | * Do additional processing of the tag after the element has been created. | |
58 | * | |
59 | * @param book the book | |
60 | * @param key the key | |
61 | * @param ele | |
62 | * the created element to process | |
63 | */ | |
64 | void processContent(Book book, Key key, Element ele); | |
65 | } |