|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.crosswire.jsword.book.basic.AbstractBookMetaData
public abstract class AbstractBookMetaData
An implementaion of the Propery Change methods from BookMetaData.
for license details.
The copyright to this program is held by it's authors.
Field Summary | |
---|---|
private BookDriver |
driver
|
private IndexStatus |
indexStatus
|
private Map |
prop
The single key version of the properties |
Fields inherited from interface org.crosswire.jsword.book.BookMetaData |
---|
KEY_BOOK, KEY_CATEGORY, KEY_DRIVER, KEY_INDEXSTATUS, KEY_INITIALS, KEY_LANGUAGE, KEY_LIBRARY_URI, KEY_LOCATION_URI, KEY_NAME, KEY_XML_LANG |
Constructor Summary | |
---|---|
AbstractBookMetaData()
|
Method Summary | |
---|---|
int |
compareTo(Object obj)
|
boolean |
equals(Object obj)
|
BookDriver |
getDriver()
Accessor for the driver that runs this Book. |
String |
getDriverName()
Calculated field: The name of the name, which could be helpful to distinguish similar Books available through 2 BookDrivers. |
IndexStatus |
getIndexStatus()
Has anyone generated a search index for this Book? |
String |
getLanguage()
The language of the book is the common name for the iso639 code. |
URI |
getLibrary()
Get the base URI for library of this module. |
URI |
getLocation()
Get the base URI for relative URIs in the document. |
String |
getOsisID()
Calculated field: Get an OSIS identifier for the OsisText.setOsisIDWork() and the Work.setOsisWork() methods. |
Map |
getProperties()
Get a list of all the properties available to do with this Book. |
String |
getProperty(String key)
|
String |
getUnlockKey()
Gets the unlock key for the module. |
boolean |
hasFeature(FeatureType feature)
Return whether the feature is supported by the book. |
int |
hashCode()
|
boolean |
isEnciphered()
Indicate whether this book is enciphered. |
boolean |
isLocked()
Indicate whether this book is enciphered and without a key. |
boolean |
isQuestionable()
Indicate whether this book is questionable. |
boolean |
isSupported()
Indicate whether this book is supported by JSword. |
void |
putProperty(String key,
String value)
|
void |
setDriver(BookDriver driver)
|
void |
setIndexStatus(IndexStatus newValue)
This method does not alter the index status, however it is for Indexers that are responsible for indexing and have changed the status themselves. |
void |
setLibrary(URI library)
Set the base URI for library of this module. |
void |
setLocation(URI location)
Set the base URI for relative URIs in the document. |
void |
setProperties(Map newProperties)
|
org.jdom.Document |
toOSIS()
Get an OSIS representation of information concerning this Book. |
String |
toString()
|
boolean |
unlock(String unlockKey)
Unlocks a book with the given key. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.crosswire.jsword.book.BookMetaData |
---|
getBookCategory, getInitials, getName, isLeftToRight |
Field Detail |
---|
private Map prop
private BookDriver driver
private IndexStatus indexStatus
Constructor Detail |
---|
public AbstractBookMetaData()
Method Detail |
---|
public BookDriver getDriver()
BookMetaData
getDriver
in interface BookMetaData
public String getDriverName()
BookMetaData
getDriverName
in interface BookMetaData
public boolean hasFeature(FeatureType feature)
BookMetaData
hasFeature
in interface BookMetaData
public String getOsisID()
BookMetaData
getOsisID
in interface BookMetaData
public boolean isSupported()
BookMetaData
isSupported
in interface BookMetaData
public boolean isEnciphered()
BookMetaData
isEnciphered
in interface BookMetaData
public boolean isLocked()
BookMetaData
isLocked
in interface BookMetaData
public boolean unlock(String unlockKey)
BookMetaData
unlock
in interface BookMetaData
unlockKey
- the key to try
public String getUnlockKey()
BookMetaData
getUnlockKey
in interface BookMetaData
public boolean isQuestionable()
BookMetaData
isQuestionable
in interface BookMetaData
public String getLanguage()
BookMetaData
getLanguage
in interface BookMetaData
public URI getLibrary()
BookMetaData
getLibrary
in interface BookMetaData
public void setLibrary(URI library)
BookMetaData
setLibrary
in interface BookMetaData
library
- the base URI or null if there is nonepublic void setLocation(URI location)
BookMetaData
setLocation
in interface BookMetaData
location
- the base URI or null if there is nonepublic URI getLocation()
BookMetaData
getLocation
in interface BookMetaData
public Map getProperties()
BookMetaData
getProperties
in interface BookMetaData
public void setProperties(Map newProperties)
newProperties
- public String getProperty(String key)
getProperty
in interface BookMetaData
key
- the key of the property.
public void putProperty(String key, String value)
putProperty
in interface BookMetaData
key
- the key of the property to setvalue
- the value of the propertypublic IndexStatus getIndexStatus()
BookMetaData
getIndexStatus
in interface BookMetaData
IndexManager
public void setIndexStatus(IndexStatus newValue)
BookMetaData
setIndexStatus
in interface BookMetaData
IndexManager
public org.jdom.Document toOSIS()
BookMetaData
toOSIS
in interface BookMetaData
public void setDriver(BookDriver driver)
driver
- The driver to set.public boolean equals(Object obj)
equals
in class Object
public int hashCode()
hashCode
in class Object
public int compareTo(Object obj)
compareTo
in interface Comparable
public String toString()
toString
in class Object
|
Copyright ยจ 2003-2007 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |