T
- The type of the OpenFileState that this class extends.public abstract class AbstractKeyBackend<T extends OpenFileState> extends AbstractBackend<T> implements Key
The GNU Lesser General Public License for details.
,
Serialized FormModifier and Type | Field and Description |
---|---|
private static long |
serialVersionUID
Serialization ID
|
Constructor and Description |
---|
AbstractKeyBackend(SwordBookMetaData sbmd)
Simple ctor
|
Modifier and Type | Method and Description |
---|---|
void |
addAll(Key key)
Adds the specified element to this set if it is not already present.
|
void |
blur(int by,
RestrictionType restrict)
Widen the range of the verses/keys in this list.
|
boolean |
canHaveChildren()
Returns false if the receiver is a leaf node and can not have children.
|
void |
clear()
Removes all of the elements from this set (optional operation).
|
AbstractKeyBackend<T> |
clone()
This needs to be declared here so that it is visible as a method on a
derived Key.
|
int |
compareTo(Key that) |
boolean |
contains(Key key)
Determine whether this Book contains the key in question
|
boolean |
equals(Object obj)
This needs to be declared here so that it is visible as a method on a
derived Key.
|
int |
getChildCount()
Returns the number of children that this node has.
|
String |
getName()
A Human readable version of the Key.
|
String |
getName(Key base)
Translate the Key into a human readable string, with the assumption that
the specified Key has just been output, so if we are in the same region,
we do not need to display the region name, and so on.
|
String |
getOsisID()
The OSIS defined id specification for this Key.
|
String |
getOsisRef()
The OSIS defined reference specification for this Key.
|
Key |
getParent()
All keys have parents unless they are the root of a Key.
|
String |
getRootName()
A Human readable version of the Key's top level name.
|
int |
hashCode()
This needs to be declared here so that it is visible as a method on a
derived Key.
|
boolean |
isEmpty()
Does this Key have 0 members
|
Iterator<Key> |
iterator() |
void |
removeAll(Key key)
Removes the specified elements from this set if it is present.
|
void |
retainAll(Key key)
Removes all but the specified element from this set.
|
void |
setAliasKey(T state,
Key alias,
Key source)
Sets alias for a comment on a verse range I.e.
|
void |
setRawText(T state,
Key key,
String text)
Set the text allotted for the given verse
|
create, decipher, encipher, getBookMetaData, getGlobalKeyList, getRawText, getRawTextLength, isSupported, isWritable, readIndex, readToOsis, setAliasKey
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
get, getCardinality, indexOf
initState, readRawContent
private static final long serialVersionUID
public AbstractKeyBackend(SwordBookMetaData sbmd)
sbmd
- the book's metadatapublic boolean canHaveChildren()
Key
canHaveChildren
in interface Key
public int getChildCount()
Key
getChildCount
in interface Key
public boolean isEmpty()
Key
public boolean contains(Key key)
Backend
contains
in interface Backend<T extends OpenFileState>
contains
in interface Key
contains
in class AbstractBackend<T extends OpenFileState>
key
- The key whose presence is desired.public void addAll(Key key)
Key
public void removeAll(Key key)
Key
public void clear()
Key
public void setAliasKey(T state, Key alias, Key source) throws IOException
StatefulFileBackedBackend
setAliasKey
in interface StatefulFileBackedBackend<T extends OpenFileState>
state
- the open file statealias
- Alias Keysource
- Source KeyIOException
- Exception when anything goes wrong on writing the aliaspublic void setRawText(T state, Key key, String text) throws BookException, IOException
StatefulFileBackedBackend
setRawText
in interface StatefulFileBackedBackend<T extends OpenFileState>
state
- TODOkey
- The key to set text totext
- The text to be set for keyBookException
- If the data can not be set.IOException
- If the module data path could not be created.public Key getParent()
Key
public AbstractKeyBackend<T> clone()
Key
public String getName()
Key
public String getName(Key base)
Key
public String getOsisID()
Key
public String getOsisRef()
Key
getOsisRef
in interface Key
public String getRootName()
Key
getRootName
in interface Key
public void retainAll(Key key)
Key
public boolean equals(Object obj)
Key
public int hashCode()
Key
public int compareTo(Key that)
compareTo
in interface Comparable<Key>
public void blur(int by, RestrictionType restrict)
Key