AbstractPassage

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

All Implemented Interfaces:

Serializable, Cloneable, Comparable<Key>, Iterable<Key>, Key, Passage, VerseKey<Passage>

Direct Known Subclasses:

BitwisePassage, DistinctPassage, PassageTally, RangedPassage
```
public abstract class AbstractPassage
extends Object
implements Passage
```
This is a base class to help with some of the common implementation details of being a Passage.
Importantly, this class takes care of Serialization in a general yet optimized way. I think I am going to have a look at replacement here.

Author:

Joe Walker, DM Smith

See Also:
The GNU Lesser General Public License for details., Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class AbstractPassage.VerseRangeIterator
Skip over verses that are part of a range

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`AbstractPassage.VerseRangeIterator` Skip over verses that are part of a range

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`BITWISE` Serialization type constant for a BitWise layout
`protected static int`	`DISTINCT` Serialization type constant for a Distinct layout
`protected List<PassageListener>`	`listeners` Support for change notification
`private static org.slf4j.Logger`	`log` The log stream
`protected static int`	`METHOD_COUNT` Count of serializations methods
`protected String`	`originalName` The original string for picky users
`private Key`	`parent` The parent key.
`protected static int`	`RANGED` Serialization type constant for a Ranged layout
`static String`	`REF_ALLOWED_DELIMS` What characters can we use to separate VerseRanges in a Passage
`static String`	`REF_OSIS_DELIM` What characters should we use to separate VerseRanges in a Passage
`static String`	`REF_PREF_DELIM` What characters should we use to separate VerseRanges in a Passage
`private static long`	`serialVersionUID` Serialization ID
`protected int`	`skipNormalization` Do we skip normalization for now - if we want to skip then we increment this, and the decrement it when done.
`protected int`	`suppressEvents` If we have several changes to make then we increment this and then decrement it when done (and fire an event off).
`private Versification`	`v11n` The Versification to which this passage belongs.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractPassage(Versification v11n)` Setup that leaves original name being null
`protected`	`AbstractPassage(Versification v11n, String passageName)` Setup the original name of this reference

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addAll(Key key)` Adds the specified element to this set if it is not already present.
`void`	`addPassageListener(PassageListener li)` Event Listeners - Add Listener
`protected void`	`addVerses(String refs, Key basis)` Create a Passage from a human readable string.
`void`	`blur(int verses, RestrictionType restrict)` Widen the range of the verses/keys in this list.
`int`	`booksInPassage()` How many books are there in this Passage
`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).
`AbstractPassage`	`clone()` This needs to be declared here so that it is visible as a method on a derived Key.
`int`	`compareTo(Key obj)`
`boolean`	`contains(Key key)` Returns true if this collection contains all the specified Verse
`boolean`	`containsAll(Passage that)` Returns true if this Passage contains all of the verses in that Passage
`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`	`equals(Object obj)` This needs to be declared here so that it is visible as a method on a derived Key.
`protected void`	`fireContentsChanged(Object source, Verse start, Verse end)` AbstractPassage subclasses must call this method before one or more elements of the list are added.
`protected void`	`fireIntervalAdded(Object source, Verse start, Verse end)` AbstractPassage subclasses must call this method after one or more elements of the list are added.
`protected void`	`fireIntervalRemoved(Object source, Verse start, Verse end)` AbstractPassage subclasses must call this method before one or more elements of the list are added.
`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.
`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.
`String`	`getOverview()` A summary of the verses in this Passage For example "10 verses in 4 books"
`Key`	`getParent()` All keys have parents unless they are the root of a Key.
`VerseRange`	`getRangeAt(int offset, RestrictionType restrict)` Get a specific VerseRange from this collection
`String`	`getRootName()` A Human readable version of the Key's top level name.
`Verse`	`getVerseAt(int offset)` Get a specific Verse from this collection
`Versification`	`getVersification()` Get the Versification that defines the Verses in this VerseKey.
`Passage`	`getWhole()` Convert this reference into one without a sub-identifier.
`int`	`hashCode()` This needs to be declared here so that it is visible as a method on a derived Key.
`boolean`	`hasRanges(RestrictionType restrict)` Determine whether there are two or more ranges.
`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
`boolean`	`isWhole()` A VerseKey that does not have an OSIS sub identifier is a whole reference.
`boolean`	`lowerEventSuppressionAndTest()` If things want to prevent event firing because they are doing a set of changes that should be notified in one go, they should call raiseEventSuppression() and when done call this.
`void`	`lowerNormalizeProtection()` If things want to prevent normalization because they are doing a set of changes that should be normalized in one go, they should call raiseNormalizeProtection() and when done call this.
`(package private) void`	`normalize()` We sometimes need to sort ourselves out ...
`void`	`optimizeReads()` For performance reasons we may well want to hint to the Passage that we have done editing it for now and that it is safe to cache certain values to speed up future reads.
`protected void`	`optimizeWrites()` Simple method to instruct children to stop caching results
`void`	`raiseEventSuppresion()` If things want to prevent event firing because they are doing a set of changes that should be notified in one go, this is what to call.
`void`	`raiseNormalizeProtection()` If things want to prevent normalization because they are doing a set of changes that should be normalized in one go, this is what to call.
`Iterator<VerseRange>`	`rangeIterator(RestrictionType restrict)` Like iterator() that iterates over VerseRanges instead of Verses.
`void`	`readDescription(Reader in)` To be compatible with humans we read/write ourselves to a file that a human can read and even edit.
`private void`	`readObject(ObjectInputStream is)` Serialization support.
`protected void`	`readObjectSupport(ObjectInputStream is)` Write out the object to the given ObjectOutputStream
`void`	`removeAll(Key key)` Removes the specified elements from this set if it is present.
`void`	`removePassageListener(PassageListener li)` Event Listeners - Remove Listener
`void`	`retainAll(Key key)` Removes all but the specified element from this set.
`Passage`	`reversify(Versification newVersification)` Cast this VerseKey into another Versification.
`void`	`setParent(Key parent)` Set a parent Key.
`String`	`toString()`
`protected static VerseRange`	`toVerseRange(Versification v11n, Object base)` Convert the Object to a VerseRange.
`Passage`	`trimRanges(int count, RestrictionType restrict)` Ensures that there are a maximum of `count` VerseRanges in this Passage.
`Passage`	`trimVerses(int count)` Ensures that there are a maximum of `count` Verses in this Passage.
`void`	`writeDescription(Writer out)` To be compatible with humans we read/write ourselves to a file that a human can read and even edit.
`protected void`	`writeObjectSupport(ObjectOutputStream out)` Write out the object to the given ObjectOutputStream.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.crosswire.jsword.passage.Passage
add, remove

Methods inherited from interface java.lang.Iterable
iterator

- Field Detail
  - log
```
private static final org.slf4j.Logger log
```
    The log stream
  - BITWISE
```
protected static final int BITWISE
```
    Serialization type constant for a BitWise layout
    
    See Also:
    Constant Field Values
  - DISTINCT
```
protected static final int DISTINCT
```
    Serialization type constant for a Distinct layout
    
    See Also:
    Constant Field Values
  - RANGED
```
protected static final int RANGED
```
    Serialization type constant for a Ranged layout
    
    See Also:
    Constant Field Values
  - METHOD_COUNT
```
protected static final int METHOD_COUNT
```
    Count of serializations methods
    
    See Also:
    Constant Field Values
  - v11n
```
private transient Versification v11n
```
    The Versification to which this passage belongs.
  - parent
```
private transient Key parent
```
    The parent key. See the key interface for more information. NOTE(joe): These keys are not serialized, should we?
    
    See Also:
    Key
  - listeners
```
protected transient List<PassageListener> listeners
```
    Support for change notification
  - originalName
```
protected transient String originalName
```
    The original string for picky users
  - suppressEvents
```
protected transient int suppressEvents
```
    If we have several changes to make then we increment this and then decrement it when done (and fire an event off). If the cost of calculating the parameters to the fire is high then we can check that this is 0 before doing the calculation.
  - skipNormalization
```
protected transient int skipNormalization
```
    Do we skip normalization for now - if we want to skip then we increment this, and the decrement it when done.
  - REF_ALLOWED_DELIMS
```
public static final String REF_ALLOWED_DELIMS
```
    What characters can we use to separate VerseRanges in a Passage
    
    See Also:
    Constant Field Values
  - REF_PREF_DELIM
```
public static final String REF_PREF_DELIM
```
    What characters should we use to separate VerseRanges in a Passage
    
    See Also:
    Constant Field Values
  - REF_OSIS_DELIM
```
public static final String REF_OSIS_DELIM
```
    What characters should we use to separate VerseRanges in a Passage
    
    See Also:
    Constant Field Values
  - serialVersionUID
```
private static final long serialVersionUID
```
    Serialization ID
    
    See Also:
    Constant Field Values
- Constructor Detail
  - AbstractPassage
```
protected AbstractPassage(Versification v11n)
```
    Setup that leaves original name being null
    
    Parameters:
    v11n - The Versification to which this Passage belongs.
  - AbstractPassage
```
protected AbstractPassage(Versification v11n,
               String passageName)
```
    Setup the original name of this reference
    
    Parameters:
    v11n - The Versification to which this Passage belongs.
    passageName - The text originally used to create this Passage.
- Method Detail
  - getVersification
```
public Versification getVersification()
```
    Description copied from interface: VerseKey
    
    Get the Versification that defines the Verses in this VerseKey.
    
    Specified by:
    
    getVersification in interface VerseKey<Passage>
    
    Returns:
    this VerseKey Versification.
  - reversify
```
public Passage reversify(Versification newVersification)
```
    Description copied from interface: VerseKey
    
    Cast this VerseKey into another Versification. OSIS Sub Identifiers are ignored.
    Note: This is dangerous as it does not consider chapter boundaries or whether the verses in this VerseKey are actually part of the new versification. It should only be used when the start and end verses are in both Versifications. You have been warned.
    
    Specified by:
    
    reversify in interface VerseKey<Passage>
    
    Returns:
    this VerseKey Versification.
  - isWhole
```
public boolean isWhole()
```
    Description copied from interface: VerseKey
    
    A VerseKey that does not have an OSIS sub identifier is a whole reference.
    
    Specified by:
    
    isWhole in interface VerseKey<Passage>
    
    Returns:
    whether this is a whole reference
  - getWhole
```
public Passage getWhole()
```
    Description copied from interface: VerseKey
    
    Convert this reference into one without a sub-identifier. A Verse with an OSIS sub-identifier represents part of a reference.
    
    Specified by:
    
    getWhole in interface VerseKey<Passage>
    
    Returns:
    a whole reference
  - compareTo
```
public int compareTo(Key obj)
```
    Specified by:
    
    compareTo in interface Comparable<Key>
  - clone
```
public AbstractPassage 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
  - 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
  - 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, for example "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
  - 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
  - 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
  - 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
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getOverview
```
public String getOverview()
```
    Description copied from interface: Passage
    
    A summary of the verses in this Passage For example "10 verses in 4 books"
    
    Specified by:
    
    getOverview in interface Passage
    
    Returns:
    a String containing an overview of the verses
  - 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.
  - 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
    
    Returns:
    the number of Verses in this collection
    See Also:
    Verse
  - hasRanges
```
public boolean hasRanges(RestrictionType restrict)
```
    Description copied from interface: Passage
    
    Determine whether there are two or more ranges.
    
    Specified by:
    
    hasRanges in interface Passage
    
    Parameters:
    restrict - Do we break ranges at chapter/book boundaries
    
    Returns:
    whether there are two or more ranges
    See Also:
    VerseRange
  - 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
    
    Parameters:
    restrict - Do we break ranges at chapter/book boundaries
    
    Returns:
    the number of VerseRanges in this collection
    See Also:
    VerseRange
  - booksInPassage
```
public int booksInPassage()
```
    Description copied from interface: Passage
    
    How many books are there in this Passage
    
    Specified by:
    
    booksInPassage in interface Passage
    
    Returns:
    The number of distinct books
  - getVerseAt
```
public Verse getVerseAt(int offset)
                 throws ArrayIndexOutOfBoundsException
```
    Description copied from interface: Passage
    
    Get a specific Verse from this collection
    
    Specified by:
    
    getVerseAt in interface Passage
    
    Parameters:
    offset - The verse offset (legal values are 0 to countVerses()-1)
    
    Returns:
    The Verse
    
    Throws:
    
    ArrayIndexOutOfBoundsException - If the offset is out of range
  - getRangeAt
```
public VerseRange getRangeAt(int offset,
                    RestrictionType restrict)
                      throws ArrayIndexOutOfBoundsException
```
    Description copied from interface: Passage
    
    Get a specific VerseRange from this collection
    
    Specified by:
    
    getRangeAt in interface Passage
    
    Parameters:
    offset - The verse range offset (legal values are 0 to countRanges()-1)
    restrict - Do we break ranges at chapter/book boundaries
    
    Returns:
    The Verse Range
    
    Throws:
    
    ArrayIndexOutOfBoundsException - If the offset is out of range
  - rangeIterator
```
public Iterator<VerseRange> rangeIterator(RestrictionType restrict)
```
    Description copied from interface: Passage
    
    Like iterator() that iterates over VerseRanges instead of Verses. Exactly the same data will be traversed, however using rangeIterator() will usually give fewer iterations (and never more)
    
    Specified by:
    
    rangeIterator in interface Passage
    
    Parameters:
    restrict - Do we break ranges over chapters
    
    Returns:
    A list enumerator
  - containsAll
```
public boolean containsAll(Passage that)
```
    Description copied from interface: Passage
    
    Returns true if this Passage contains all of the verses in that Passage
    
    Specified by:
    
    containsAll in interface Passage
    
    Parameters:
    that - Passage to be checked for containment in this collection.
    
    Returns:
    true if this reference contains all of the Verses in that Passage
  - trimVerses
```
public Passage trimVerses(int count)
```
    Description copied from interface: Passage
    
    Ensures that there are a maximum of count Verses in this Passage. If there were more than count Verses then a new Passage is created containing the Verses from count+1 onwards. If there was not greater than count in the Passage, then the passage remains unchanged, and null is returned.
    
    Specified by:
    
    trimVerses in interface Passage
    
    Parameters:
    count - The maximum number of Verses to allow in this collection
    
    Returns:
    A new Passage containing the remaining verses or null
    See Also:
    Verse
  - trimRanges
```
public Passage trimRanges(int count,
                 RestrictionType restrict)
```
    Description copied from interface: Passage
    
    Ensures that there are a maximum of count VerseRanges in this Passage. If there were more than count VerseRanges then a new Passage is created containing the VerseRanges from count+1 onwards. If there was not greater than count in the Passage, then the passage remains unchanged, and null is returned.
    
    Specified by:
    
    trimRanges in interface Passage
    
    Parameters:
    count - The maximum number of VerseRanges to allow in this collection
    restrict - Do we break ranges at chapter/book boundaries
    
    Returns:
    A new Passage containing the remaining verses or null
    See Also:
    VerseRange
  - 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.
  - 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.
  - 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
  - blur
```
public void blur(int verses,
        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:
    verses - The number of verses/keys to widen by
    restrict - How should we restrict the blurring?
    See Also:
    Passage
  - writeDescription
```
public void writeDescription(Writer out)
                      throws IOException
```
    Description copied from interface: Passage
    
    To be compatible with humans we read/write ourselves to a file that a human can read and even edit. OLB verse.lst integration is a good goal here.
    
    Specified by:
    
    writeDescription in interface Passage
    
    Parameters:
    out - The stream to write to
    
    Throws:
    
    IOException - If the file/network etc breaks
  - readDescription
```
public void readDescription(Reader in)
                     throws IOException,
                            NoSuchVerseException
```
    Description copied from interface: Passage
    
    To be compatible with humans we read/write ourselves to a file that a human can read and even edit. OLB verse.lst integration is a good goal here.
    
    Specified by:
    
    readDescription in interface Passage
    
    Parameters:
    in - The stream to read from
    
    Throws:
    
    IOException - If the file/network etc breaks
    
    NoSuchVerseException - If the file was invalid
  - optimizeReads
```
public void optimizeReads()
```
    Description copied from interface: Passage
    
    For performance reasons we may well want to hint to the Passage that we have done editing it for now and that it is safe to cache certain values to speed up future reads. Any action taken by this method will be undone simply by making a future edit, and the only loss in calling optimizeReads() is a loss of time if you then persist in writing to the Passage.
    
    Specified by:
    
    optimizeReads in interface Passage
  - optimizeWrites
```
protected void optimizeWrites()
```
    Simple method to instruct children to stop caching results
  - addPassageListener
```
public void addPassageListener(PassageListener li)
```
    Description copied from interface: Passage
    
    Event Listeners - Add Listener
    
    Specified by:
    
    addPassageListener in interface Passage
    
    Parameters:
    li - The listener to add
  - removePassageListener
```
public void removePassageListener(PassageListener li)
```
    Description copied from interface: Passage
    
    Event Listeners - Remove Listener
    
    Specified by:
    
    removePassageListener in interface Passage
    
    Parameters:
    li - The listener to remove
  - contains
```
public boolean contains(Key key)
```
    Description copied from interface: Passage
    
    Returns true if this collection contains all the specified Verse
    
    Specified by:
    
    contains in interface Key
    
    Specified by:
    
    contains in interface Passage
    
    Parameters:
    key - Verse or VerseRange that may exist in this Passage
    
    Returns:
    true if this collection contains that
  - getCardinality
```
public int getCardinality()
```
    Description copied from interface: Key
    
    Returns the number of elements in this set (its cardinality). If this set contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.
    This method is potentially expensive, as it often requires cycling through all the keys in the set.
    
    Specified by:
    
    getCardinality in interface Key
    
    Returns:
    the number of elements in this set (its cardinality).
  - indexOf
```
public int indexOf(Key that)
```
    Description copied from interface: Key
    
    Reverse a Key into the position the key holds in the list of children
    
    Specified by:
    
    indexOf in interface Key
    
    Parameters:
    that - The Key to find
    
    Returns:
    The index of the key or < 0 if the key is not in the list
  - 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() will throw
    
    Specified by:
    
    canHaveChildren in interface Key
    
    Returns:
    true if the key can have children
  - 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
    
    Returns:
    the number of children for the node
  - get
```
public Key get(int index)
```
    Description copied from interface: Key
    
    Gets a key from a specific point in this list of children.
    
    Specified by:
    
    get in interface Key
    
    Parameters:
    index - The index of the Key to retrieve
    
    Returns:
    The specified 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.
  - setParent
```
public void setParent(Key parent)
```
    Set a parent Key. This allows us to follow the Key interface more closely, although the concept of a parent for a verse is fairly alien.
    
    Parameters:
    parent - The parent Key for this verse
  - fireIntervalAdded
```
protected void fireIntervalAdded(Object source,
                     Verse start,
                     Verse end)
```
    AbstractPassage subclasses must call this method after one or more elements of the list are added. The changed elements are specified by a closed interval from start to end.
    
    Parameters:
    source - The thing that changed, typically "this".
    start - One end of the new interval.
    end - The other end of the new interval.
    See Also:
    PassageListener
  - fireIntervalRemoved
```
protected void fireIntervalRemoved(Object source,
                       Verse start,
                       Verse end)
```
    AbstractPassage subclasses must call this method before one or more elements of the list are added. The changed elements are specified by a closed interval from start to end.
    
    Parameters:
    source - The thing that changed, typically "this".
    start - One end of the new interval.
    end - The other end of the new interval.
    See Also:
    PassageListener
  - fireContentsChanged
```
protected void fireContentsChanged(Object source,
                       Verse start,
                       Verse end)
```
    AbstractPassage subclasses must call this method before one or more elements of the list are added. The changed elements are specified by a closed interval from start to end.
    
    Parameters:
    source - The thing that changed, typically "this".
    start - One end of the new interval.
    end - The other end of the new interval.
    See Also:
    PassageListener
  - addVerses
```
protected void addVerses(String refs,
             Key basis)
                  throws NoSuchVerseException
```
    Create a Passage from a human readable string. The opposite of toString(). Since this method is not public it leaves control of suppress_events up to the people that call it.
    
    Parameters:
    refs - A String containing the text of the RangedPassage
    basis - The basis for understanding refs
    
    Throws:
    
    NoSuchVerseException - if the string is invalid
  - normalize
```
void normalize()
```
    We sometimes need to sort ourselves out ... I don't think we need to be synchronized since we are private and we could check that all public calling of normalize() are synchronized, however this is safe, and I don't think there is a cost associated with a double synchronize. (?)
  - raiseNormalizeProtection
```
public void raiseNormalizeProtection()
```
    If things want to prevent normalization because they are doing a set of changes that should be normalized in one go, this is what to call. Be sure to call lowerNormalizeProtection() when you are done.
  - lowerNormalizeProtection
```
public void lowerNormalizeProtection()
```
    If things want to prevent normalization because they are doing a set of changes that should be normalized in one go, they should call raiseNormalizeProtection() and when done call this. This also calls normalize() if the count reaches zero.
  - raiseEventSuppresion
```
public void raiseEventSuppresion()
```
    If things want to prevent event firing because they are doing a set of changes that should be notified in one go, this is what to call. Be sure to call lowerEventSuppression() when you are done.
  - lowerEventSuppressionAndTest
```
public boolean lowerEventSuppressionAndTest()
```
    If things want to prevent event firing because they are doing a set of changes that should be notified in one go, they should call raiseEventSuppression() and when done call this.
    
    Returns:
    true if it is then safe to fire an event.
  - toVerseRange
```
protected static VerseRange toVerseRange(Versification v11n,
                      Object base)
                                  throws ClassCastException
```
    Convert the Object to a VerseRange. If base is a Verse then return a VerseRange of zero length.
    
    Parameters:
    base - The object to be cast
    
    Returns:
    The VerseRange
    
    Throws:
    
    ClassCastException - If this is not a Verse or a VerseRange
  - writeObjectSupport
```
protected void writeObjectSupport(ObjectOutputStream out)
                           throws IOException
```
    Write out the object to the given ObjectOutputStream. There are 3 ways of doing this - according to the 3 implementations of Passage.
    - Distinct: If we write out a list if verse ordinals then the space used is 4 bytes per verse.
    - Bitwise: If we write out a bitmap then the space used is something like 31104/8 = 4k bytes.
    - Ranged: The we write a list of start/end pairs then the space used is 8 bytes per range.
    Since we can take our time about this section, we calculate the optimal storage method before we do the saving. If some methods come out equal first then bitwise is preferred, then distinct, then ranged, because I imagine that for speed of deserialization this is the sensible order. I've not tested it though.
    Parameters:
    out - The stream to write our state to
    
    Throws:
    
    IOException - if the read fails
  - readObject
```
private void readObject(ObjectInputStream is)
                 throws IOException,
                        ClassNotFoundException
```
    Serialization support.
    
    Parameters:
    is -
    
    Throws:
    
    IOException
    
    ClassNotFoundException
  - readObjectSupport
```
protected void readObjectSupport(ObjectInputStream is)
                          throws IOException,
                                 ClassNotFoundException
```
    Write out the object to the given ObjectOutputStream
    
    Parameters:
    is - The stream to read our state from
    
    Throws:
    
    IOException - if the read fails
    
    ClassNotFoundException - If the read data is incorrect

Class AbstractPassage

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

Field Detail

log

BITWISE

DISTINCT

RANGED

METHOD_COUNT

v11n

parent

listeners

originalName

suppressEvents

skipNormalization

REF_ALLOWED_DELIMS

REF_PREF_DELIM

REF_OSIS_DELIM

serialVersionUID

Constructor Detail

AbstractPassage

AbstractPassage

Method Detail

getVersification

reversify

isWhole

getWhole

compareTo

clone

equals

hashCode

getName

getName

getRootName

getOsisRef

getOsisID

toString

getOverview

isEmpty

countVerses

hasRanges

countRanges

booksInPassage

getVerseAt

getRangeAt

rangeIterator

containsAll

trimVerses

trimRanges

addAll

removeAll

retainAll

clear

blur

writeDescription

readDescription

optimizeReads

optimizeWrites

addPassageListener

removePassageListener

contains

getCardinality

indexOf

canHaveChildren

getChildCount

get

getParent

setParent

fireIntervalAdded

fireIntervalRemoved

fireContentsChanged

addVerses

normalize

raiseNormalizeProtection

lowerNormalizeProtection