|
||||||||||
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.sword.SwordBookMetaData
public class SwordBookMetaData
A utility class for loading and representing Sword module configs.
Config file format. See also: http://sword.sourceforge.net/cgi-bin/twiki/view/Swordapi/ConfFileLayout
The contents of the About field are in rtf.
\ is used as a continuation line.
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 ConfigEntryTable |
cet
|
(package private) static Map |
ENCODING_JAVA
The language strings need to be converted to Java charsets |
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 | |
---|---|
SwordBookMetaData(File file,
String internal)
Loads a sword config from a given File. |
|
SwordBookMetaData(Reader in,
String internal)
Loads a sword config from a given Reader. |
Method Summary | |
---|---|
private void |
buildProperties()
|
String |
getConfPath()
|
Filter |
getFilter()
Returns the sourceType. |
String |
getInitials()
The initials of this book - how people familiar with this book will know it, for example "NIV", "KJV". |
String |
getModuleCharset()
Returns the Charset of the module based on the encoding attribute |
String |
getModulePath()
|
ModuleType |
getModuleType()
Returns the Module Type. |
String |
getName()
The name of the book, for example "King James Version" or "Bible in Basic English" or "Greek". |
String |
getProperty(ConfigEntryType entry)
Get the string value for the property or null if it is not defined. |
BookType |
getType()
What type of content is this, a Bible or a reference work like a Dictionary or Commentary |
boolean |
hasFeature(FeatureType feature)
Return whether the feature is supported by the book. |
boolean |
isLeftToRight()
Return the orientation of the language of the Book. |
boolean |
isSupported()
Is this one of the supported book types? |
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, hashCode, putProperty, removePropertyChangeListener, setDriver, setIndexStatus, setProperties, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
static final Map ENCODING_JAVA
private ConfigEntryTable cet
Constructor Detail |
---|
public SwordBookMetaData(File file, String internal) throws IOException
IOException
public SwordBookMetaData(Reader in, String internal) throws IOException
IOException
Method Detail |
---|
public boolean isSupported()
public String getName()
BookMetaData
public String getModuleCharset()
public ModuleType getModuleType()
public Filter getFilter()
public String getConfPath()
public String getModulePath()
public BookType getType()
BookMetaData
public org.jdom.Document toOSIS()
BookMetaData
toOSIS
in interface BookMetaData
toOSIS
in class AbstractBookMetaData
public String getInitials()
BookMetaData
public String getProperty(ConfigEntryType entry)
entry
- the ConfigEntryType
public boolean isLeftToRight()
BookMetaData
public boolean hasFeature(FeatureType feature)
BookMetaData
hasFeature
in interface BookMetaData
hasFeature
in class AbstractBookMetaData
private void buildProperties()
|
Copyright ? 2003-2004 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |