|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.crosswire.jsword.book.sword.ConfigEntryType
public class ConfigEntryType
Constants for the keys in a Sword Config file. Taken from http://sword.sourceforge.net/cgi-bin/twiki/view/Swordapi/ConfFileLayout now located at http://www.crosswire.org/ucgi-bin/twiki/view/Swordapi/ConfFileLayout now located at http://www.crosswire.org/wiki/index.php/DevTools:Modules
for license details.
The copyright to this program is held by it's authors.
,
Serialized FormNested Class Summary | |
---|---|
static class |
ConfigEntryType.ConfigEntryPickType
A ConfigEntryPickType is a ConfigEntryType that allows values from a pick list. |
static class |
ConfigEntryType.ConfigEntrySyntheticType
Represents a ConfigEntryType that is not actually represented by the Sword Config file. |
Field Summary | |
---|---|
static ConfigEntryType |
ABOUT
Contains rtf that describes the book. |
static ConfigEntryType |
BLOCK_COUNT
single value integer, unknown use, some indications that we ought to be using it |
static ConfigEntryType |
BLOCK_TYPE
The level at which compression is applied, BOOK, CHAPTER, or VERSE |
private static String[] |
BLOCK_TYPE_PICKS
|
private static String[] |
BOOLEAN_PICKS
|
static ConfigEntryType |
CATEGORY
The Category of the book. |
private static String[] |
CATEGORY_PICKS
|
static ConfigEntryType |
CIPHER_KEY
If this exists in the conf, then the book is encrypted. |
static ConfigEntryType |
COMPRESS_TYPE
The type of compression in use. |
private static String[] |
COMPRESS_TYPE_PICKS
|
static ConfigEntryType |
COPYRIGHT
Informational copyright notice. |
static ConfigEntryType |
COPYRIGHT_CONTACT_ADDRESS
Copyright info. |
static ConfigEntryType |
COPYRIGHT_CONTACT_EMAIL
Copyright info. |
static ConfigEntryType |
COPYRIGHT_CONTACT_NAME
Copyright info. |
static ConfigEntryType |
COPYRIGHT_CONTACT_NOTES
Copyright info. |
static ConfigEntryType |
COPYRIGHT_DATE
Copyright info. |
static ConfigEntryType |
COPYRIGHT_HOLDER
single value string, unknown use |
static ConfigEntryType |
COPYRIGHT_NOTES
Copyright info. |
static ConfigEntryType |
DATA_PATH
Relative path to the data files, some issues with this |
private Object |
defaultValue
The default for the ConfigEntryType |
static ConfigEntryType |
DESCRIPTION
The full name of this book |
static ConfigEntryType |
DIRECTION
The layout direction of the text in the book. |
static String |
DIRECTION_BIDI
|
static String |
DIRECTION_LTOR
Constants for direction |
private static String[] |
DIRECTION_PICKS
|
static String |
DIRECTION_RTOL
|
static ConfigEntryType |
DISPLAY_LEVEL
Display level is used by GenBooks to do auto expansion in the tree. |
static ConfigEntryType |
DISTRIBUTION_LICENSE
Copyright info. |
static ConfigEntryType |
DISTRIBUTION_NOTES
Copyright info. |
static ConfigEntryType |
DISTRIBUTION_SOURCE
Similar to DataPath. |
static ConfigEntryType |
ENCODING
The character encoding. |
private static String[] |
ENCODING_PICKS
|
static ConfigEntryType |
FEATURE
A Feature describes a characteristic of the Book. |
private static String[] |
FEATURE_PICKS
|
static ConfigEntryType |
FONT
A recommended font to use for the book. |
static ConfigEntryType |
GLOBAL_OPTION_FILTER
Global Option Filters are the names of routines in Sword that can be used to display the data. |
private static String[] |
GLOBAL_OPTION_FILTER_PICKS
|
static ConfigEntryType |
GLOSSARY_FROM
Books with a Feature of Glossary are used to map words FROM one language TO another. |
static ConfigEntryType |
GLOSSARY_TO
Books with a Feature of Glossary are used to map words FROM one language TO another. |
static ConfigEntryType |
HISTORY
multiple values starting with History, some sort of change-log. |
static ConfigEntryType |
INITIALS
The abbreviated name by which this book is known. |
static ConfigEntryType |
INSTALL_SIZE
The installed size of the book in bytes. |
static ConfigEntryType |
KEY_TYPE
The kind of key that a Generic Book uses. |
private static String[] |
KEY_TYPE_PICKS
|
static ConfigEntryType |
LANG
single value string, defaults to en, the language of the book |
static ConfigEntryType |
LCSH
Library of Congress Subject Heading. |
static ConfigEntryType |
LIBRARY_URL
The location of a collection of modules. |
private static String[] |
LICENSE_PICKS
|
static ConfigEntryType |
LOCATION_URL
The location of the module. |
static ConfigEntryType |
MINIMUM_VERSION
single value version number, lowest sword c++ version that can read this book JSword does not use this value. |
static ConfigEntryType |
MOD_DRV
This indicates how the book was stored. |
private static String[] |
MOD_DRV_PICKS
|
private String |
name
The name of the ConfigEntryType |
private static int |
nextObj
|
private int |
obj
|
static ConfigEntryType |
OBSOLETES
A list of prior "initials" for the current book. |
static ConfigEntryType |
OSIS_Q_TO_TICK
When false do not show quotation marks for OSIS text that has elements. |
static ConfigEntryType |
OSIS_VERSION
single value version number, lowest sword c++ version that can read this book JSword does not use this value. |
private static long |
serialVersionUID
Serialization ID |
static ConfigEntryType |
SHORT_COPYRIGHT
A one line copyright statement, required by Lockman for NASB |
static ConfigEntryType |
SHORT_PROMO
A one line promo statement, required by Lockman for NASB |
static ConfigEntryType |
SOURCE_TYPE
This indicates the kind of markup used for the book. |
private static String[] |
SOURCE_TYPE_PICKS
|
static ConfigEntryType |
SWORD_VERSION_DATE
The date that this version of the book was last updated. |
static ConfigEntryType |
TEXT_SOURCE
Information on where the book's text was obtained. |
private static ConfigEntryType[] |
VALUES
|
static ConfigEntryType |
VERSION
An informational string indicating the current version of the book. |
Constructor Summary | |
---|---|
protected |
ConfigEntryType(String name)
Simple ctor |
protected |
ConfigEntryType(String name,
Object defaultValue)
Simple ctor |
Method Summary | |
---|---|
boolean |
allowsContinuation()
While most fields are single line or single value, some allow continuation. |
boolean |
allowsRTF()
RTF is allowed in a few config entries. |
Object |
convert(String input)
Convert the string value from the conf into the representation of this ConfigEntryType. |
boolean |
equals(Object o)
Prevent subclasses from overriding canonical identity based Object methods |
String |
filter(String value)
Modify the value if necessary. |
static ConfigEntryType |
fromInteger(int i)
Lookup method to convert from an integer |
static ConfigEntryType |
fromString(String name)
Lookup method to convert from a String |
Object |
getDefault()
Some ConfigEntryTypes have defaults. |
String |
getName()
Returns the normalized name of this ConfigEntry. |
protected boolean |
hasChoices()
Some keys can repeat. |
int |
hashCode()
Prevent subclasses from overriding canonical identity based Object methods |
boolean |
isAllowed(String value)
Determines whether the string is allowed. |
boolean |
isSynthetic()
Synthetic keys are those that are not in the Sword Book's conf, but are needed by the program. |
boolean |
mayRepeat()
Some keys can repeat. |
(package private) Object |
readResolve()
|
boolean |
reportDetails()
Determines the level of detail stored in the histogram. |
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String DIRECTION_LTOR
public static final String DIRECTION_RTOL
public static final String DIRECTION_BIDI
private static final String[] BLOCK_TYPE_PICKS
private static final String[] BOOLEAN_PICKS
private static final String[] KEY_TYPE_PICKS
private static final String[] CATEGORY_PICKS
private static final String[] COMPRESS_TYPE_PICKS
private static final String[] DIRECTION_PICKS
private static final String[] LICENSE_PICKS
private static final String[] ENCODING_PICKS
private static final String[] GLOBAL_OPTION_FILTER_PICKS
private static final String[] FEATURE_PICKS
private static final String[] MOD_DRV_PICKS
private static final String[] SOURCE_TYPE_PICKS
public static final ConfigEntryType ABOUT
public static final ConfigEntryType BLOCK_COUNT
public static final ConfigEntryType BLOCK_TYPE
public static final ConfigEntryType KEY_TYPE
public static final ConfigEntryType CATEGORY
public static final ConfigEntryType CIPHER_KEY
public static final ConfigEntryType COMPRESS_TYPE
public static final ConfigEntryType COPYRIGHT
public static final ConfigEntryType COPYRIGHT_CONTACT_ADDRESS
public static final ConfigEntryType COPYRIGHT_CONTACT_EMAIL
public static final ConfigEntryType COPYRIGHT_CONTACT_NAME
public static final ConfigEntryType COPYRIGHT_CONTACT_NOTES
public static final ConfigEntryType COPYRIGHT_DATE
public static final ConfigEntryType COPYRIGHT_HOLDER
public static final ConfigEntryType COPYRIGHT_NOTES
public static final ConfigEntryType DATA_PATH
public static final ConfigEntryType DESCRIPTION
public static final ConfigEntryType DIRECTION
public static final ConfigEntryType DISPLAY_LEVEL
public static final ConfigEntryType DISTRIBUTION_LICENSE
public static final ConfigEntryType DISTRIBUTION_NOTES
public static final ConfigEntryType DISTRIBUTION_SOURCE
public static final ConfigEntryType ENCODING
public static final ConfigEntryType GLOBAL_OPTION_FILTER
public static final ConfigEntryType GLOSSARY_FROM
public static final ConfigEntryType GLOSSARY_TO
public static final ConfigEntryType HISTORY
public static final ConfigEntryType INSTALL_SIZE
public static final ConfigEntryType FEATURE
public static final ConfigEntryType FONT
public static final ConfigEntryType LANG
public static final ConfigEntryType LCSH
public static final ConfigEntryType MOD_DRV
public static final ConfigEntryType MINIMUM_VERSION
public static final ConfigEntryType OBSOLETES
public static final ConfigEntryType SOURCE_TYPE
public static final ConfigEntryType SWORD_VERSION_DATE
public static final ConfigEntryType TEXT_SOURCE
public static final ConfigEntryType VERSION
public static final ConfigEntryType OSIS_Q_TO_TICK
elements.
public static final ConfigEntryType OSIS_VERSION
public static final ConfigEntryType INITIALS
public static final ConfigEntryType SHORT_PROMO
public static final ConfigEntryType SHORT_COPYRIGHT
public static final ConfigEntryType LIBRARY_URL
public static final ConfigEntryType LOCATION_URL
private String name
private Object defaultValue
private static final long serialVersionUID
private static int nextObj
private final int obj
private static final ConfigEntryType[] VALUES
Constructor Detail |
---|
protected ConfigEntryType(String name)
protected ConfigEntryType(String name, Object defaultValue)
Method Detail |
---|
public String getName()
public boolean isAllowed(String value)
value
- the string to be checked
public String filter(String value)
value
- the input
public boolean allowsRTF()
public boolean allowsContinuation()
public boolean mayRepeat()
public boolean reportDetails()
protected boolean hasChoices()
public boolean isSynthetic()
public Object getDefault()
public Object convert(String input)
public static ConfigEntryType fromString(String name)
public static ConfigEntryType fromInteger(int i)
public final boolean equals(Object o)
equals
in class Object
Object.equals(java.lang.Object)
public final int hashCode()
hashCode
in class Object
Object.hashCode()
public String toString()
toString
in class Object
Object readResolve()
|
Copyright ยจ 2003-2007 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |