|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.crosswire.jsword.book.basic.AbstractBookMetaData
org.crosswire.jsword.book.basic.DefaultBookMetaData
public class DefaultBookMetaData
DefaultBookMetaData is an implementation of the of the BookMetaData interface. A less complete implementation design for imheritance is available in AbstractBookMetaData where the complexity is in the setup rather than the inheritance. DefaultBookMetaData is probably the preferred implementation.
for license details.
The copyright to this program is held by it's authors.
Field Summary | |
---|---|
private String |
initials
|
private String |
name
|
private BookCategory |
type
|
Fields inherited from class org.crosswire.jsword.book.basic.AbstractBookMetaData |
---|
DEFAULT_LANG_CODE |
Fields inherited from interface org.crosswire.jsword.book.BookMetaData |
---|
KEY_BOOK, KEY_CATEGORY, KEY_DRIVER, KEY_INDEXSTATUS, KEY_INITIALS, KEY_LANGUAGE, KEY_NAME |
Constructor Summary | |
---|---|
DefaultBookMetaData(BookDriver driver,
Book book,
Map prop)
Ctor with a properties from which to get values. |
|
DefaultBookMetaData(BookDriver driver,
String name,
BookCategory type)
Ctor with some default values. |
Method Summary | |
---|---|
private void |
addRow(org.jdom.Element table,
String key,
String value)
|
BookCategory |
getBookCategory()
What category of content is this, a Bible or a reference work like a Dictionary or Commentary. |
String |
getInitials()
The initials of this book - how people familiar with this book will know it, for example "NIV", "KJV". |
String |
getName()
The name of the book, for example "King James Version" or "Bible in Basic English" or "Greek". |
boolean |
isLeftToRight()
Return the orientation of the language of the Book. |
void |
setBookCategory(BookCategory aType)
|
void |
setInitials(String initials)
See note on setName() for side effect on setInitials(). |
void |
setLanguage(String language)
|
void |
setName(String name)
Setting the name also sets some default initials, so if you wish to set some specific initials then it should be done after setting the name. |
void |
setType(String typestr)
|
org.jdom.Document |
toOSIS()
Get an OSIS representation of information concerning this Book. |
Methods inherited from class org.crosswire.jsword.book.basic.AbstractBookMetaData |
---|
compareTo, equals, getDriver, getDriverName, getFullName, getIndexStatus, getLanguage, getLanguage, getOsisID, getProperties, getProperty, getUnlockKey, hasFeature, hashCode, isEnciphered, isLocked, isQuestionable, isSupported, putProperty, setDriver, setIndexStatus, setProperties, toString, unlock |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
private BookCategory type
private String name
private String initials
Constructor Detail |
---|
public DefaultBookMetaData(BookDriver driver, Book book, Map prop)
public DefaultBookMetaData(BookDriver driver, String name, BookCategory type)
Method Detail |
---|
public BookCategory getBookCategory()
BookMetaData
public String getName()
BookMetaData
public String getInitials()
BookMetaData
public boolean isLeftToRight()
BookMetaData
public void setLanguage(String language)
language
- The language to set.public void setInitials(String initials)
initials
- The initials to set.setName(String)
public void setName(String name)
name
- The name to set.setInitials(String)
public void setBookCategory(BookCategory aType)
aType
- The type to set.public void setType(String typestr)
typestr
- The string version of the type to set.public org.jdom.Document toOSIS()
BookMetaData
toOSIS
in interface BookMetaData
toOSIS
in class AbstractBookMetaData
private void addRow(org.jdom.Element table, String key, String value)
|
Copyright ยจ 2003-2006 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |