|
||||||||||
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.
The GNU Lesser General Public License for details.
Field Summary | |
---|---|
private Filter |
filter
The filter to use to convert to OSIS. |
Constructor Summary | |
---|---|
protected |
SwordDictionary(SwordBookMetaData sbmd,
Backend backend)
Construct an SwordDictionary given the BookMetaData and the AbstractBackend. |
Method Summary | |
---|---|
boolean |
contains(Key key)
Returns true if this book contains the specified element. |
Key |
createEmptyKeyList()
Fetch an empty Key to which we can add Keys. |
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. |
List<org.jdom2.Content> |
getOsis(Key key,
RawTextToXmlProcessor processor)
|
Iterator<org.jdom2.Content> |
getOsisIterator(Key key,
boolean allowEmpty,
boolean allowGenTitles)
Return an iterator that returns each key's OSIS in turn. |
String |
getRawText(Key key)
Returns the raw text that getData(Key key) builds into OSIS. |
Key |
getValidKey(String name)
Get a Key for the name, if possible. |
boolean |
isWritable()
A Book is writable if the file system allows the underlying files to be opened for writing and if the driver for the book allows writing. |
void |
setAliasKey(Key alias,
Key source)
Store an alias of one key to another. |
void |
setRawText(Key key,
String rawData)
Store the raw text for the given key. |
Methods inherited from class org.crosswire.jsword.book.basic.AbstractBook |
---|
activate, addIndexStatusListener, compareTo, deactivate, equals, find, find, firePropertyChange, getAbbreviation, getBackend, getBook, getBookCategory, getBookMetaData, getDriver, getDriverName, getIndexStatus, getInitials, getLanguage, getName, getOsisID, getProperty, getPropertyKeys, getScope, getUnlockKey, hasFeature, hashCode, isEnciphered, isLeftToRight, isLocked, isQuestionable, isSupported, match, putProperty, putProperty, removeIndexStatusListener, setBookMetaData, setIndexStatus, toOSIS, toString, unlock |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
private Filter filter
Constructor Detail |
---|
protected SwordDictionary(SwordBookMetaData sbmd, Backend backend)
sbmd
- the metadata that describes the bookbackend
- the means by which the resource is accessedMethod Detail |
---|
public Iterator<org.jdom2.Content> getOsisIterator(Key key, boolean allowEmpty, boolean allowGenTitles) throws BookException
Book
key
- the Items to locateallowEmpty
- indicates whether empty keys should be present.allowGenTitles
- indicates whether to generate titles
BookException
- If anything goes wrong with this methodpublic String getRawText(Key key) throws BookException
Book
key
- The item to locate
BookException
- If anything goes wrong with this methodpublic boolean contains(Key key)
Book
key
- element whose presence in this book is to be tested.
public List<org.jdom2.Content> getOsis(Key key, RawTextToXmlProcessor processor) throws BookException
getOsis
in class AbstractBook
BookException
public boolean isWritable()
Book
public void setRawText(Key key, String rawData) throws BookException
Book
key
- The item to locaterawData
- The text to store
BookException
- If anything goes wrong with this methodpublic void setAliasKey(Key alias, Key source) throws BookException
Book
It should be an exception to set an alias when that alias already has raw text. Also, it should be an exception to set an alias to an alias. However, getRawText(Key) must be able to handle alias chains.
alias
- the key that aliases anothersource
- the key that holds the text
BookException
- If anything goes wrong with this methodpublic Key getGlobalKeyList()
Book
public Key getValidKey(String name)
Book
name
- The string to translate into a Key
public Key getKey(String text) throws NoSuchKeyException
Book
text
- The string to translate into a Key
NoSuchKeyException
- If the name can not be parsed.public Key createEmptyKeyList()
Book
|
Copyright ยจ 2003-2015 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |