org.crosswire.jsword.passage
Class AbstractKeyList

java.lang.Object
  org.crosswire.jsword.passage.AbstractKeyList

All Implemented Interfaces:

Comparable, Key

Direct Known Subclasses:

DefaultKeyList, SetKeyList

public abstract class AbstractKeyList
extends Object
implements Key

An implementation of some of the easier methods from Key.

Distribution Licence:
JSword is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 2 as published by the Free Software Foundation.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
The License is available on the internet here, or by writing to: Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
The copyright to this program is held by it's authors.

Version:

$Id: AbstractKeyList.java,v 1.6 2004/08/25 22:54:37 joe Exp $

Author:

Joe Walker [joe at eireneh dot com]

See Also:

Licence

Field Summary

private String	name The common user visible name for this work
private String	osisName The OSIS ID attribute

Constructor Summary

AbstractKeyList()

Method Summary

int	compareTo(Object obj)
boolean	contains(Key key) Returns true if this set contains the specified element.
String	getName() A Human readable version of the Key.
String	getOSISName() The OSIS defined specification for this Passage.
boolean	isEmpty() Does this Passage have 0 members
protected static void	retain(Key alter, Key base) Utility to remove all the keys from alter that are not in base
void	retainAll(Key key) Removes all but the specified element from this set.
void	setName(String name) Override the default name with a custom name.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

addAll, blur, canHaveChildren, clear, get, getChildCount, getParent, indexOf, iterator, removeAll

Field Detail

name

private String name

The common user visible name for this work

osisName

private String osisName

The OSIS ID attribute

Constructor Detail

AbstractKeyList

public AbstractKeyList()

Method Detail

isEmpty

public boolean isEmpty()

Description copied from interface: Key

Does this Passage 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

Parameters:

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

Returns:

true if this set contains the specified element.

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.

retain

protected static void retain(Key alter,
                             Key base)

Utility to remove all the keys from alter that are not in base

Parameters:

alter - The key to remove keys from

base - The check key

toString

public String toString()

Overrides:

toString in class Object

setName

public void setName(String name)

Override the default name with a custom name. If the name is null then a name will be generated by concatenating the names of all the elements of this node.

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

getOSISName

public String getOSISName()

Description copied from interface: Key

The OSIS defined specification for this Passage. Uses short books names, with "." as a verse part separator.

Specified by:

getOSISName in interface Key

Returns:

a String containing the OSIS description of the verses

compareTo

public int compareTo(Object obj)

Specified by:

compareTo in interface Comparable