|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.crosswire.jsword.passage.AbstractKeyList
org.crosswire.jsword.passage.DefaultKeyList
public class DefaultKeyList
A default implementation of Key.
This implementation uses java.util.TreeSet to store keys.
for license details.
The copyright to this program is held by it's authors.
,
Serialized FormNested Class Summary |
---|
Nested classes/interfaces inherited from class org.crosswire.jsword.passage.AbstractKeyList |
---|
AbstractKeyList.NameVisitor, AbstractKeyList.OsisIDVisitor, AbstractKeyList.OsisRefVisitor |
Field Summary | |
---|---|
private List |
keys
The store of Keys |
private static Logger |
log
The log stream |
private Key |
parent
The parent of this key |
private static long |
serialVersionUID
Serialization ID |
Constructor Summary | |
---|---|
DefaultKeyList()
Simple ctor |
|
DefaultKeyList(Key parent,
String name)
Simple ctor |
Method Summary | |
---|---|
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). |
boolean |
contains(Key key)
Returns true if this set contains the specified element. |
Key |
get(int index)
Gets a key from a specific point in this list of children. |
int |
getCardinality()
Returns the number of elements in this set (its cardinality). |
int |
getChildCount()
Returns the number of children that this node has. |
Key |
getParent()
All keys have parents unless they are the root of a Key. |
int |
indexOf(Key that)
Reverse a Key into the position the key holds in the list of children |
boolean |
isEmpty()
Does this Key have 0 members |
Iterator |
iterator()
|
void |
removeAll(Key key)
Removes the specified elements from this set if it is present. |
Methods inherited from class org.crosswire.jsword.passage.AbstractKeyList |
---|
clone, compareTo, equals, getName, getName, getOsisID, getOsisRef, getRootName, hashCode, retain, retainAll, setName, toString |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
private Key parent
private List keys
private static final long serialVersionUID
private static final Logger log
Constructor Detail |
---|
public DefaultKeyList()
public DefaultKeyList(Key parent, String name)
Method Detail |
---|
public boolean canHaveChildren()
Key
public int getChildCount()
Key
public int getCardinality()
Key
public boolean isEmpty()
Key
isEmpty
in interface Key
isEmpty
in class AbstractKeyList
public boolean contains(Key key)
Key
contains
in interface Key
contains
in class AbstractKeyList
key
- element whose presence in this set is to be tested.
public Iterator iterator()
public void addAll(Key key)
Key
key
- element to be added to this set.public void removeAll(Key key)
Key
key
- object to be removed from this set, if present.public void clear()
Key
public Key get(int index)
Key
index
- The index of the Key to retrieve
public int indexOf(Key that)
Key
that
- The Key to find
public Key getParent()
Key
public void blur(int by, RestrictionType restrict)
Key
by
- The number of verses/keys to widen byrestrict
- How should we restrict the blurring?Passage
|
Copyright ยจ 2003-2006 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |