|
||||||||||
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.
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 String |
initials
|
private String |
name
|
private BookType |
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_DRIVER, KEY_INDEXSTATUS, KEY_INITIALS, KEY_LANGUAGE, KEY_NAME, KEY_TYPE |
Constructor Summary | |
---|---|
DefaultBookMetaData(BookDriver driver,
Book book,
Properties prop)
Ctor with a properties from which to get values. |
|
DefaultBookMetaData(BookDriver driver,
String name,
BookType type)
Ctor with some default values. |
Method Summary | |
---|---|
private void |
addRow(org.jdom.Element table,
String key,
String value)
|
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". |
BookType |
getType()
What type of content is this, a Bible or a reference work like a Dictionary or Commentary |
boolean |
isLeftToRight()
Return the orientation of the language of the Book. |
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(BookType type)
|
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 |
---|
addPropertyChangeListener, compareTo, equals, firePropertyChange, getDriver, getDriverName, getFullName, getIndexStatus, getLanguage, getLanguage, getOsisID, getProperties, getProperty, hasFeature, hashCode, putProperty, removePropertyChangeListener, setDriver, setIndexStatus, setProperties, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
private BookType type
private String name
private String initials
Constructor Detail |
---|
public DefaultBookMetaData(BookDriver driver, Book book, Properties prop)
public DefaultBookMetaData(BookDriver driver, String name, BookType type)
Method Detail |
---|
public BookType getType()
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 setType(BookType type)
type
- 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-2004 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |