org.crosswire.jsword.book.sword
Class AbstractKeyBackend

java.lang.Object
  org.crosswire.jsword.book.sword.AbstractBackend
      org.crosswire.jsword.book.sword.AbstractKeyBackend

All Implemented Interfaces:

Serializable, Cloneable, Comparable, Activatable, Iterable, Key

Direct Known Subclasses:

RawLDBackend

public abstract class AbstractKeyBackend
extends AbstractBackend
implements Key

A Backend that can be used as a global key list.

Author:

DM Smith [dmsmith555 at yahoo dot com]

See Also:

for license details. The copyright to this program is held by it's authors., Serialized Form

Constructor Summary

AbstractKeyBackend(SwordBookMetaData sbmd)
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).
Object	clone() This needs to be declared here so that it is visible as a method on a derived Key.
int	compareTo(Object obj)
boolean	contains(Key key) Returns true if this set contains the specified element.
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	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.

Methods inherited from class org.crosswire.jsword.book.sword.AbstractBackend

decipher, encipher, getBookMetaData, getExpandedDataPath, getRawText, isSupported, isWritable, readIndex, setRawText

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.crosswire.jsword.passage.Key

get, getCardinality, indexOf

Methods inherited from interface org.crosswire.common.activate.Activatable

activate, deactivate

Constructor Detail

AbstractKeyBackend

public AbstractKeyBackend(SwordBookMetaData sbmd)

Simple ctor

Parameters:

sbmd - the book's metadata

Method Detail

canHaveChildren

public boolean canHaveChildren()

Description copied from interface: Key

Returns false if the receiver is a leaf node and can not have children. Any attempt to add()/remove() wlll throw

Specified by:

canHaveChildren in interface Key

getChildCount

public int getChildCount()

Description copied from interface: Key

Returns the number of children that this node has. Leaf nodes return 0.

Specified by:

getChildCount in interface Key

isEmpty

public boolean isEmpty()

Description copied from interface: Key

Does this Key have 0 members

Specified by:

isEmpty in interface Key

Returns:

true if this set contains no elements.

contains

public boolean contains(Key key)

Description copied from interface: Key

Returns true if this set contains the specified element.

Specified by:

contains in interface Key

Specified by:

contains in class AbstractBackend

Parameters:

key - element whose presence in this set is to be tested.

Returns:

true if this set contains the specified element.

iterator

public Iterator iterator()

Specified by:

iterator in interface Iterable

addAll

public void addAll(Key key)

Description copied from interface: Key

Adds the specified element to this set if it is not already present.

Specified by:

addAll in interface Key

Parameters:

key - element to be added to this set.

removeAll

public void removeAll(Key key)

Description copied from interface: Key

Removes the specified elements from this set if it is present.

Specified by:

removeAll in interface Key

Parameters:

key - object to be removed from this set, if present.

clear

public void clear()

Description copied from interface: Key

Removes all of the elements from this set (optional operation). This set will be empty after this call returns (unless it throws an exception).

Specified by:

clear in interface Key

getParent

public Key getParent()

Description copied from interface: Key

All keys have parents unless they are the root of a Key.

Specified by:

getParent in interface Key

Returns:

The parent of this tree, or null if this Key is the root.

clone

public Object clone()

Description copied from interface: Key

This needs to be declared here so that it is visible as a method on a derived Key.

Specified by:

clone in interface Key

Overrides:

clone in class Object

Returns:

A complete copy of ourselves

getName

public String getName()

Description copied from interface: Key

A Human readable version of the Key. For Biblical passages this uses short books names, and the shortest sensible rendering eg "Mat 3:1-4" and "Mar 1:1, 3, 5" and "3Jo, Jude"

Specified by:

getName in interface Key

Returns:

a String containing a description of the Key

getName

public String getName(Key base)

Description copied from interface: Key

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.

Specified by:

getName in interface Key

Parameters:

base - The key to use to cut down unnecessary output.

Returns:

The string representation

getOsisID

public String getOsisID()

Description copied from interface: Key

The OSIS defined id specification for this Key. When the key is a single element, it is an OSIS book name with '.' separating the parts. When the key is multiple elements, it uses a space to separate each.

Specified by:

getOsisID in interface Key

Returns:

a String containing the OSIS description of the verses

getOsisRef

public String getOsisRef()

Description copied from interface: Key

The OSIS defined reference specification for this Key. When the key is a single element, it is an OSIS book name with '.' separating the parts. When the key is multiple elements, it uses a range notation. Note, this will create a comma separated list of ranges, which is improper OSIS.

Specified by:

getOsisRef in interface Key

Returns:

a String containing the OSIS description of the verses

getRootName

public String getRootName()

Description copied from interface: Key

A Human readable version of the Key's top level name. For Biblical passages this uses short books names. For a dictionary it might return A-Z.

Specified by:

getRootName in interface Key

Returns:

a String containing a description of the Key

retainAll

public void retainAll(Key key)

Description copied from interface: Key

Removes all but the specified element from this set.

Specified by:

retainAll in interface Key

Parameters:

key - object to be left in this set.

equals

public boolean equals(Object obj)

Description copied from interface: Key

This needs to be declared here so that it is visible as a method on a derived Key.

Specified by:

equals in interface Key

Overrides:

equals in class Object

Returns:

true if equal

hashCode

public int hashCode()

Description copied from interface: Key

This needs to be declared here so that it is visible as a method on a derived Key.

Specified by:

hashCode in interface Key

Overrides:

hashCode in class Object

Returns:

the hashcode

compareTo

public int compareTo(Object obj)

Specified by:

compareTo in interface Comparable

blur

public void blur(int by,
                 RestrictionType restrict)

Description copied from interface: Key

Widen the range of the verses/keys in this list. This is primarily for "find x within n verses of y" type applications.

Specified by:

blur in interface Key

Parameters:

by - The number of verses/keys to widen by

restrict - How should we restrict the blurring?

See Also:

Passage