org.crosswire.jsword.passage
Class RangedPassage

java.lang.Object
  org.crosswire.jsword.passage.AbstractPassage
      org.crosswire.jsword.passage.RangedPassage

All Implemented Interfaces:

Serializable, Cloneable, Comparable, Key, Passage

public class RangedPassage
extends AbstractPassage

A Passage that is implemented using a TreeSet of VerseRanges. The attributes of the style are:

• Compact storage of large amounts of data
• Fast getName()
• Slow manipulation

When to normalize()? This is a slow process, but one that is perhaps done bit-by-bit instead of killing everything just to do getName(). The options are:

• Before every read
• Before reads with a background thread
• After every change
• After every change with a cacheing scheme

I'm not sure which will be best. So I'm starting with 1 and optimizing later ... Maybe the best is to allow the user to choose?

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: RangedPassage.java,v 1.19 2005/03/19 18:44:58 dmsmith Exp $

Author:

Joe Walker [joe at eireneh dot com]

See Also:

Licence, Serialized Form

Nested Class Summary

private static class	RangedPassage.VerseIterator This class is here to prevent users of RangedPassage.iterator() from altering the underlying store and getting us out of sync.
private static class	RangedPassage.VerseRangeIterator Loop over the VerseRanges and check that they do not require digging into

Field Summary

(package private) static long	serialVersionUID To make serialization work across new versions
private SortedSet	store The place the real data is stored

Fields inherited from class org.crosswire.jsword.passage.AbstractPassage

BITWISE, DISTINCT, listeners, METHOD_COUNT, originalName, RANGED, REF_ALLOWED_DELIMS, REF_OSIS_DELIM, REF_PREF_DELIM, skipNormalization, suppressEvents

Constructor Summary

protected	RangedPassage() Create an empty RangedPassage.
protected	RangedPassage(String refs) Create a Verse from a human readable string.

Method Summary

void	add(VerseBase obj) Add this Verse/VerseRange to this Passage
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 Passage.
boolean	contains(VerseBase obj) Returns true if this collection contains all the specified Verse
int	countRanges(RestrictionType restrict) Like countVerses() that counts VerseRanges instead of Verses Returns the number of fragments in this collection.
int	countVerses() Returns the number of verses in this collection.
boolean	isEmpty() Does this Passage have 0 members
Iterator	iterator()
protected void	normalize() We sometimes need to sort ourselves out ...
Iterator	rangeIterator(RestrictionType restrict) Like verseElements() that iterates over VerseRanges instead of Verses.
private void	readObject(ObjectInputStream in) Call the support mechanism in AbstractPassage
void	remove(VerseBase obj) Remove this Verse/VerseRange from this Passage
void	retainAll(Key key) Removes all but the specified element from this set.
private void	writeObject(ObjectOutputStream out) Call the support mechanism in AbstractPassage

Methods inherited from class org.crosswire.jsword.passage.AbstractPassage

addAll, addPassageListener, addVerses, blur, booksInPassage, canHaveChildren, chaptersInPassage, compareTo, contains, containsAll, equals, fireContentsChanged, fireIntervalAdded, fireIntervalRemoved, get, getChildCount, getName, getOSISName, getOverview, getParent, getRangeAt, getVerseAt, hashCode, indexOf, lowerEventSuppresionAndTest, lowerNormalizeProtection, optimizeReads, optimizeWrites, raiseEventSuppresion, raiseNormalizeProtection, readDescription, readObjectSupport, removeAll, removePassageListener, setParent, toString, toVerseArray, toVerseRange, trimRanges, trimVerses, versesInPassage, writeDescription, writeObjectSupport

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

static final long serialVersionUID

To make serialization work across new versions

See Also:

Constant Field Values

store

private transient SortedSet store

The place the real data is stored

Constructor Detail

RangedPassage

protected RangedPassage()

Create an empty RangedPassage. There are no ctors from either Verse or VerseRange so you need to do new RangedPassage().add(...);

RangedPassage

protected RangedPassage(String refs)
                 throws NoSuchVerseException

Create a Verse from a human readable string. The opposite of getName(), Given any RangedPassage v1, and the following RangedPassage v2 = new RangedPassage(v1.getName()); Then v1.equals(v2); Theoretically, since there are many ways of representing a RangedPassage as text string comparision along the lines of: v1.getName().equals(v2.getName()) could be false. However since getName() is standardized this will be true. We don't need to worry about thread safety in a ctor since we don't exist yet.

Parameters:

refs - A String containing the text of the RangedPassage

Throws:

NoSuchVerseException - if refs is invalid

Method Detail

clone

public Object clone()

Description copied from interface: Passage

This needs to be declared here so that it is visible as a method on a derived Passage. Specifically, in SynchronizedPassage, ref.clone() where ref is only known as a Passage has to have clone visible in this interface.

Specified by:

clone in interface Passage

Overrides:

clone in class AbstractPassage

Returns:

A complete copy of ourselves

countRanges

public int countRanges(RestrictionType restrict)

Description copied from interface: Passage

Like countVerses() that counts VerseRanges instead of Verses Returns the number of fragments in this collection. This does not mean the Passage needs to use VerseRanges, just that it understands the concept.

Specified by:

countRanges in interface Passage

Overrides:

countRanges in class AbstractPassage

Parameters:

restrict - Do we break ranges at chapter/book boundries

Returns:

the number of VerseRanges in this collection

See Also:

VerseRange

countVerses

public int countVerses()

Description copied from interface: Passage

Returns the number of verses in this collection. Like Collection.size() This does not mean the Passage needs to use Verses, just that it understands the concept.

Specified by:

countVerses in interface Passage

Overrides:

countVerses in class AbstractPassage

Returns:

the number of Verses in this collection

See Also:

Verse

iterator

public Iterator iterator()

Specified by:

iterator in interface Key

Overrides:

iterator in class AbstractPassage

Returns:

an iterator over the elements in this set.

rangeIterator

public Iterator rangeIterator(RestrictionType restrict)

Description copied from interface: Passage

Like verseElements() that iterates over VerseRanges instead of Verses. Exactly the same data will be traversed, however using rangeIterator() will usually give less iterations (and never more)

Specified by:

rangeIterator in interface Passage

Overrides:

rangeIterator in class AbstractPassage

Parameters:

restrict - Do we break ranges over chapters

Returns:

A list enumerator

isEmpty

public boolean isEmpty()

Description copied from interface: Key

Does this Passage have 0 members

Specified by:

isEmpty in interface Key

Overrides:

isEmpty in class AbstractPassage

Returns:

true if this set contains no elements.

contains

public boolean contains(VerseBase obj)

Description copied from interface: Passage

Returns true if this collection contains all the specified Verse

Parameters:

obj - Verse or VerseRange that may exist in this Passage

Returns:

true if this collection contains that

add

public void add(VerseBase obj)

Description copied from interface: Passage

Add this Verse/VerseRange to this Passage

Parameters:

obj - The Verses to be removed from this Passage

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

Overrides:

clear in class AbstractPassage

remove

public void remove(VerseBase obj)

Description copied from interface: Passage

Remove this Verse/VerseRange from this Passage

Parameters:

obj - The Verses to be removed from this Passage

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

Overrides:

retainAll in class AbstractPassage

Parameters:

key - object to be left in this set.

normalize

protected void normalize()

We sometimes need to sort ourselves out ...

I don't think we need to be synchronised since we are private and we could check that all public calling of normalize() are synchronised, however this is safe, and I don't think there is a cost associated with a double synchronize. (?)

Overrides:

normalize in class AbstractPassage

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Call the support mechanism in AbstractPassage

Parameters:

out - The stream to write our state to

Throws:

IOException - if the read fails

See Also:

AbstractPassage.writeObjectSupport(ObjectOutputStream)

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
                        ClassNotFoundException

Call the support mechanism in AbstractPassage

Parameters:

in - The stream to read our state from

Throws:

IOException - if the read fails

ClassNotFoundException - If the read data is incorrect

See Also:

AbstractPassage.readObjectSupport(ObjectInputStream)