|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.crosswire.jsword.book.sword.ConfigEntryTable
public class ConfigEntryTable
A utility class for loading the entries in a Sword book's conf file. Since the conf files are manually maintained, there can be all sorts of errors in them. This class does robust checking and reporting.
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.
for license details.
The copyright to this program is held by it's authors.
Field Summary | |
---|---|
static ConfigEntryType[] |
BASIC_INFO
|
private BookType |
bookType
The BookType for this ConfigEntry |
static ConfigEntryType[] |
COPYRIGHT_INFO
|
static ConfigEntryType[] |
FEATURE_INFO
|
private String |
internal
The original name of this config file from mods.d. |
static ConfigEntryType[] |
LANG_INFO
|
private static Logger |
log
The log stream |
private boolean |
questionable
True if this book is considered questionable. |
private String |
readahead
A helper for the reading of the conf file. |
static ConfigEntryType[] |
REQUIRED
These are the elements that JSword requires. |
private boolean |
supported
True if this book's config type can be used by JSword. |
static ConfigEntryType[] |
SYSTEM_INFO
|
private Map |
table
A map of lists of known config entries. |
Constructor Summary | |
---|---|
ConfigEntryTable(Reader in,
String bookName)
Loads a sword config from a given Reader. |
Method Summary | |
---|---|
private void |
add(ConfigEntryType type,
String aValue)
A helper to create/replace a value for a given type. |
private void |
adjustBookType()
|
private void |
adjustLanguage()
|
private void |
adjustName()
|
private String |
advance(BufferedReader bin)
Get the next line from the input |
private void |
backup(String oops)
Read too far ahead and need to return a line. |
BookType |
getBookType()
Returns an Enumeration of all the keys found in the config file. |
private void |
getContinuation(ConfigEntry configEntry,
BufferedReader bin,
StringBuffer buf)
Get continuation lines, if any. |
Iterator |
getKeys()
Returns an Enumeration of all the keys found in the config file. |
Object |
getValue(ConfigEntryType type)
Gets a particular ConfigEntry's value by its type |
boolean |
isEnciphered()
Determines whether the Sword Book is enciphered and without a key. |
private boolean |
isKeyLine(String line)
Does this line of text represent a key/value pair? |
boolean |
isQuestionable()
Determines whether the Sword Book's conf is supported by JSword. |
boolean |
isSupported()
Determines whether the Sword Book's conf is supported by JSword. |
private void |
loadContents(BufferedReader in)
|
private void |
loadFile(Reader in)
|
private void |
loadInitials(BufferedReader in)
|
boolean |
match(ConfigEntryType type,
Object search)
Determine whether this ConfigEntryTable has the ConfigEntry and it matches the value. |
org.jdom.Element |
toOSIS()
Sort the keys for a more meaningful presentation order. |
private void |
toOSIS(OSISUtil.ObjectFactory factory,
org.jdom.Element ele,
String aTitle,
ConfigEntryType[] category)
Build an ordered map so that it displays in a consistent order. |
private void |
validate()
Determine which books are not supported. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final ConfigEntryType[] REQUIRED
public static final ConfigEntryType[] BASIC_INFO
public static final ConfigEntryType[] LANG_INFO
public static final ConfigEntryType[] COPYRIGHT_INFO
public static final ConfigEntryType[] FEATURE_INFO
public static final ConfigEntryType[] SYSTEM_INFO
private static final Logger log
private boolean questionable
private boolean supported
private BookType bookType
private Map table
private String internal
private String readahead
Constructor Detail |
---|
public ConfigEntryTable(Reader in, String bookName) throws IOException
IOException
Method Detail |
---|
public boolean isQuestionable()
public boolean isSupported()
public boolean isEnciphered()
public Iterator getKeys()
public BookType getBookType()
public Object getValue(ConfigEntryType type)
type
- of the ConfigEntry
public boolean match(ConfigEntryType type, Object search)
type
- The kind of ConfigEntry to look forsearch
- the value to match against
public org.jdom.Element toOSIS()
private void loadFile(Reader in) throws IOException
IOException
private void loadContents(BufferedReader in) throws IOException
IOException
private void loadInitials(BufferedReader in) throws IOException
IOException
private void getContinuation(ConfigEntry configEntry, BufferedReader bin, StringBuffer buf) throws IOException
IOException
private String advance(BufferedReader bin) throws IOException
bin
- The reader to get data from
IOException
private void backup(String oops)
private boolean isKeyLine(String line)
private void add(ConfigEntryType type, String aValue)
type
- aValue
- private void adjustLanguage()
private void adjustBookType()
private void adjustName()
private void validate()
private void toOSIS(OSISUtil.ObjectFactory factory, org.jdom.Element ele, String aTitle, ConfigEntryType[] category)
|
Copyright ยจ 2003-2005 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |