|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.crosswire.jsword.book.basic.AbstractBook
org.crosswire.jsword.book.readings.ReadingsBook
public class ReadingsBook
A Dictionary that displays daily Readings.
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. |
Licence
Field Summary | |
---|---|
private Key |
global
The global key list |
private Map |
hash
The store of keys and data |
private static String |
KEYBASE
The base for the keys in the properties file. |
private static Logger |
log
The log stream |
Fields inherited from interface org.crosswire.jsword.book.BookMetaData |
---|
KEY_BOOK, KEY_DRIVER, KEY_INDEXSTATUS, KEY_INITIALS, KEY_LANGUAGE, KEY_NAME, KEY_TYPE |
Constructor Summary | |
---|---|
ReadingsBook(ReadingsBookDriver driver,
String name,
BookType type)
Constructor for ReadingsBook. |
Method Summary | |
---|---|
Key |
createEmptyKeyList()
Fetch an empty Key to which we can add Keys. |
BookData |
getData(Key key)
Retrieval: Add to the given document some mark-up for the specified Verses. |
Key |
getGlobalKeyList()
Get a complete list of index entries. |
Key |
getKey(String name)
Someone has typed in a reference to find, but we need a Key to actually look it up. |
Key |
getPreferred()
What Key would this object like us to use? |
String |
getRawData(Key key)
Returns the raw text that getData(Key key) builds into OSIS. |
boolean |
hasFeature(FeatureType feature)
Return whether the feature is supported by the book. |
Methods inherited from class org.crosswire.jsword.book.basic.AbstractBook |
---|
activate, addPropertyChangeListener, compareTo, deactivate, equals, find, getBook, getBookMetaData, getDriver, getDriverName, getFullName, getIndexStatus, getInitials, getLanguage, getName, getOsisID, getProperties, getType, hashCode, isLeftToRight, removePropertyChangeListener, setBookMetaData, setIndexStatus, toOSIS, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
private Key global
private static final String KEYBASE
private Map hash
private static final Logger log
Constructor Detail |
---|
public ReadingsBook(ReadingsBookDriver driver, String name, BookType type)
Method Detail |
---|
public Key getPreferred()
PreferredKey
getPreferred
in interface PreferredKey
public BookData getData(Key key) throws BookException
Book
getData
in interface Book
key
- The verses to search for
BookException
- If anything goes wrong with this methodpublic String getRawData(Key key) throws BookException
Book
getRawData
in interface Book
key
- The verses to search for
BookException
- If anything goes wrong with this methodpublic Key getKey(String name) throws NoSuchKeyException
KeyFactory
getKey
in interface KeyFactory
name
- The string to translate into a Key
NoSuchKeyException
- If the name can not be parsed.public Key getGlobalKeyList()
KeyFactory
getGlobalKeyList
in interface KeyFactory
public Key createEmptyKeyList()
KeyFactory
createEmptyKeyList
in interface KeyFactory
public boolean hasFeature(FeatureType feature)
BookMetaData
hasFeature
in interface BookMetaData
hasFeature
in class AbstractBook
|
Copyright ? 2003-2004 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |