|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.crosswire.jsword.passage.ReadOnlyPassage
final class ReadOnlyPassage
This is a simple proxy to a real Passage object that denies all attempts to write to it.
for license details.
The copyright to this program is held by it's authors.
Field Summary | |
---|---|
private boolean |
ignore
Do we just silently ignore change attempts or throw up |
private Passage |
ref
The object we are proxying to |
private static long |
serialVersionUID
Serialization ID |
Constructor Summary | |
---|---|
protected |
ReadOnlyPassage(Passage ref,
boolean ignore)
Construct a ReadOnlyPassage from a real Passage to which we proxy. |
Method Summary | |
---|---|
void |
add(Key that)
Add this Verse/VerseRange to this Passage |
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 |
void |
blur(int by,
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. |
int |
chaptersInPassage(int book)
How many chapters are there in a particular book in 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 Key. |
int |
compareTo(Object o)
|
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. |
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 |
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 |
Iterator |
iterator()
|
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. |
Iterator |
rangeIterator(RestrictionType restrict)
Like verseElements() 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. |
void |
remove(Key that)
Remove this Verse/VerseRange from this Passage |
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. |
String |
toString()
|
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. |
int |
versesInPassage(int book,
int chapter)
How many chapters are there in a particular book in this Passage Note that versesInPassage(ref, 0, 0) == ref.countVerses() |
void |
writeDescription(Writer out)
To be compatible with humans we read/write ourselves to a file that a human can read and even edit. |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
private Passage ref
private boolean ignore
private static final long serialVersionUID
Constructor Detail |
---|
protected ReadOnlyPassage(Passage ref, boolean ignore)
ref
- The real Passageignore
- Do we throw up if someone tries to change usMethod Detail |
---|
public void addAll(Key key)
Key
addAll
in interface Key
key
- element to be added to this set.public void removeAll(Key key)
Key
removeAll
in interface Key
key
- object to be removed from this set, if present.public void retainAll(Key key)
Key
retainAll
in interface Key
key
- object to be left in this set.public boolean contains(Key key)
Passage
contains
in interface Key
contains
in interface Passage
key
- Verse or VerseRange that may exist in this Passage
public boolean canHaveChildren()
Key
canHaveChildren
in interface Key
public int getChildCount()
Key
getChildCount
in interface Key
public int getCardinality()
Key
getCardinality
in interface Key
public Iterator iterator()
iterator
in interface Iterable
public Key get(int index)
Key
get
in interface Key
index
- The index of the Key to retrieve
public int indexOf(Key that)
Key
indexOf
in interface Key
that
- The Key to find
public Key getParent()
Key
getParent
in interface Key
public String getName()
Key
getName
in interface Key
public String getName(Key base)
Key
getName
in interface Key
base
- The key to use to cut down unnecessary output.
public String getRootName()
Key
getRootName
in interface Key
public String getOsisRef()
Key
getOsisRef
in interface Key
public String getOsisID()
Key
getOsisID
in interface Key
public String getOverview()
Passage
getOverview
in interface Passage
public boolean isEmpty()
Key
isEmpty
in interface Key
public int countVerses()
Passage
countVerses
in interface Passage
Verse
public boolean hasRanges(RestrictionType restrict)
Passage
hasRanges
in interface Passage
restrict
- Do we break ranges at chapter/book boundaries
VerseRange
public int countRanges(RestrictionType restrict)
Passage
countRanges
in interface Passage
restrict
- Do we break ranges at chapter/book boundaries
VerseRange
public Passage trimVerses(int count)
Passage
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.
trimVerses
in interface Passage
count
- The maximum number of Verses to allow in this collection
Verse
public Passage trimRanges(int count, RestrictionType restrict)
Passage
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.
trimRanges
in interface Passage
count
- The maximum number of VerseRanges to allow in this collectionrestrict
- Do we break ranges at chapter/book boundaries
VerseRange
public int booksInPassage()
Passage
booksInPassage
in interface Passage
public int chaptersInPassage(int book) throws NoSuchVerseException
Passage
chaptersInPassage
in interface Passage
book
- The book to check (0 for distinct chapters in all books)
NoSuchVerseException
- if the book is invalidpublic int versesInPassage(int book, int chapter) throws NoSuchVerseException
Passage
versesInPassage(ref, 0, 0) == ref.countVerses()
versesInPassage
in interface Passage
book
- The book to check (0 for distinct chapters in all books)chapter
- The chapter to check (0 for distinct verses in all chapters)
NoSuchVerseException
- if the book/chapter is invalidpublic Verse getVerseAt(int offset) throws ArrayIndexOutOfBoundsException
Passage
getVerseAt
in interface Passage
offset
- The verse offset (legal values are 0 to countVerses()-1)
ArrayIndexOutOfBoundsException
- If the offset is out of rangepublic VerseRange getRangeAt(int offset, RestrictionType restrict) throws ArrayIndexOutOfBoundsException
Passage
getRangeAt
in interface Passage
offset
- The verse range offset (legal values are 0 to countRanges()-1)restrict
- Do we break ranges at chapter/book boundaries
ArrayIndexOutOfBoundsException
- If the offset is out of rangepublic Iterator rangeIterator(RestrictionType restrict)
Passage
rangeIterator
in interface Passage
restrict
- Do we break ranges over chapters
public void add(Key that)
Passage
add
in interface Passage
that
- The Verses to be removed from this Passagepublic void remove(Key that)
Passage
remove
in interface Passage
that
- The Verses to be removed from this Passagepublic boolean containsAll(Passage that)
Passage
containsAll
in interface Passage
that
- Passage to be checked for containment in this collection.
public void clear()
Key
clear
in interface Key
public void blur(int by, RestrictionType restrict)
Key
blur
in interface Key
by
- The number of verses/keys to widen byrestrict
- How should we restrict the blurring?Passage
public void readDescription(Reader in)
Passage
readDescription
in interface Passage
in
- The stream to read frompublic void writeDescription(Writer out) throws IOException
Passage
writeDescription
in interface Passage
out
- The stream to write to
IOException
- If the file/network etc breakspublic void optimizeReads()
Passage
optimizeReads
in interface Passage
public void addPassageListener(PassageListener li)
Passage
addPassageListener
in interface Passage
li
- The listener to addpublic void removePassageListener(PassageListener li)
Passage
removePassageListener
in interface Passage
li
- The listener to removepublic boolean equals(Object obj)
Key
equals
in interface Key
equals
in class Object
public int hashCode()
Key
hashCode
in interface Key
hashCode
in class Object
public String toString()
toString
in class Object
public Object clone()
Key
clone
in interface Key
clone
in class Object
public int compareTo(Object o)
compareTo
in interface Comparable
|
Copyright ยจ 2003-2007 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |