|
||||||||||
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.sword.SwordDictionary
public class SwordDictionary
A Sword version of Dictionary.
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 boolean |
active
Are we active |
private Backend |
backend
To read the data from the disk |
private Key |
global
The global key list |
private Map |
map
So we can quickly find a Key given the text for the key |
private SwordBookMetaData |
sbmd
The Sword configuration file |
private Key |
set
So we can implement getIndex() easily |
private static Pattern |
STRONGS_PATTERN
|
private static DecimalFormat |
ZERO_PAD
|
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 | |
---|---|
protected |
SwordDictionary(SwordBookMetaData sbmd,
Backend backend)
Start and to as much checking as we can without using memory. |
Method Summary | |
---|---|
void |
activate(Lock lock)
Called to indicate that the Book should initialize itself, and consume whatever system resources it needs to be able to respond to other queries. |
private void |
checkActive()
Helper method so we can quickly activate ourselves on access |
Key |
createEmptyKeyList()
Fetch an empty Key to which we can add Keys. |
void |
deactivate(Lock lock)
Called to indicate that the Book should release whatever system resources it can to make way for other uses. |
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 text)
Someone has typed in a reference to find, but we need a Key to actually look it up. |
String |
getRawData(Key key)
Returns the raw text that getData(Key key) builds into OSIS. |
private Key |
getStrongsKey(String text)
|
Methods inherited from class org.crosswire.jsword.book.basic.AbstractBook |
---|
addPropertyChangeListener, compareTo, equals, find, getBook, getBookMetaData, getDriver, getDriverName, getFullName, getIndexStatus, getInitials, getLanguage, getName, getOsisID, getProperties, getType, hasFeature, 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 static final Pattern STRONGS_PATTERN
private static final DecimalFormat ZERO_PAD
private Key global
private boolean active
private Map map
private Key set
private Backend backend
private SwordBookMetaData sbmd
Constructor Detail |
---|
protected SwordDictionary(SwordBookMetaData sbmd, Backend backend)
Method Detail |
---|
public final void activate(Lock lock)
Activatable
activate
in interface Activatable
activate
in class AbstractBook
lock
- An attempt to ensure that only the Activator calls this methodpublic final void deactivate(Lock lock)
Activatable
deactivate
in interface Activatable
deactivate
in class AbstractBook
lock
- An attempt to ensure that only the Activator calls this methodpublic BookData getData(Key key) throws BookException
Book
key
- The verses to search for
BookException
- If anything goes wrong with this methodpublic String getRawData(Key key) throws BookException
Book
key
- The verses to search for
BookException
- If anything goes wrong with this methodpublic Key getGlobalKeyList()
KeyFactory
public Key getKey(String text) throws NoSuchKeyException
KeyFactory
text
- The string to translate into a Key
NoSuchKeyException
- If the name can not be parsed.private Key getStrongsKey(String text)
public Key createEmptyKeyList()
KeyFactory
private final void checkActive()
|
Copyright ? 2003-2004 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |