|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.crosswire.jsword.book.BookData
public class BookData
BookData is the assembler of the OSIS that is returned by the filters. As such it puts that into an OSIS document. When several books are supplied, it gets the data from each and puts it into a parallel or interlinear view. Note: it is critical that all the books are able to understand the same key. That does not mean that each has to have content for each key. Missing keys are represented by empty cells.
for license details.
The copyright to this program is held by it's authors.
Field Summary | |
---|---|
private Book[] |
books
The books to which the key should be applied. |
private boolean |
comparingBooks
Whether the Books should be compared. |
private org.jdom.Element |
fragment
Just the element |
private Key |
key
What key was used to create this data |
private org.jdom.Element |
osis
The complete OSIS container for the element |
Constructor Summary | |
---|---|
BookData(Book[] books,
Key key,
boolean compare)
Create BookData for multiple books. |
|
BookData(Book book,
Key key)
Ctor |
Method Summary | |
---|---|
Book[] |
getBooks()
Who created this data. |
Book |
getFirstBook()
Get the first book. |
Key |
getKey()
The key used to obtain data from one or more books. |
org.jdom.Element |
getOsis()
Accessor for the root OSIS element |
private org.jdom.Element |
getOsisContent()
|
org.jdom.Element |
getOsisFragment()
Accessor for the root OSIS element |
SAXEventProvider |
getSAXEventProvider()
Output the current data as a SAX stream. |
boolean |
isComparingBooks()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private Key key
private Book[] books
private boolean comparingBooks
private org.jdom.Element osis
private org.jdom.Element fragment
Constructor Detail |
---|
public BookData(Book book, Key key)
public BookData(Book[] books, Key key, boolean compare)
Method Detail |
---|
public org.jdom.Element getOsis() throws BookException
BookException
public org.jdom.Element getOsisFragment() throws BookException
BookException
public SAXEventProvider getSAXEventProvider() throws BookException
BookException
public Book[] getBooks()
getBooks
in interface BookProvider
public Book getFirstBook()
getFirstBook
in interface BookProvider
public Key getKey()
public boolean isComparingBooks()
private org.jdom.Element getOsisContent() throws BookException
BookException
|
Copyright ยจ 2003-2007 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |