Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> eireneh >> bible >> [ book overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

com.eireneh.bible.book
Class VersewiseBible  

java.lang.Object
  com.eireneh.bible.book.AbstractBible
      com.eireneh.bible.book.VersewiseBible

All Implemented Interfaces:

Bible, Book

---

public abstract class VersewiseBible

extends AbstractBible

The VersewiseMutableBook class makes it easier to implement MutableBook by splitting the job up into a Verse by Verse effort. setDocument() is called once for every verse in the Bible in order, and flush() is called when done.

Distribution Licence: Project B 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, by writing to Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA, Or locally at the Licence link below. The copyright to this program is held by it's authors.

Version:

D5.I4.T2

---

Field Summary
private static com.eireneh.bible.passage.Passage	whole           The Whole Bible

 

Fields inherited from class com.eireneh.bible.book.AbstractBible

listeners, percent

 

Constructor Summary

VersewiseBible()

 

Method Summary
void	flush()           Flush the data written to disk
abstract  void	foundPassage(java.lang.String word, com.eireneh.bible.passage.Passage ref)           Save a list of found words.
void	generate(Bible version)           Read from the given source version to generate ourselves
protected  void	generatePassages(Bible source)           Read from the given source version to generate ourselves
protected  void	generateText(Bible source)           Read from the given source version to generate ourselves
abstract  java.net.URL	getBaseURL()           Get a URL in which we can save a generation report
com.eireneh.config.Config	getProperties()           This returns a simple Config, that displays the generation notes
abstract  void	setDocument(BibleEle text)           Write the XML to disk.
abstract  void	setVersion(Version version)           Setup the Version information

 

Methods inherited from class com.eireneh.bible.book.AbstractBible

addProgressListener, fireProgressMade, getElement, getPropertiesURL, getText, removeProgressListener

 

Methods inherited from class java.lang.Object

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

 

Methods inherited from interface com.eireneh.bible.book.Bible

findPassage, getDocument, getDriver, getName, getStartsWith, getVersion, listWords

 

Field Detail

whole

private static com.eireneh.bible.passage.Passage whole

The Whole Bible

Constructor Detail

VersewiseBible

public VersewiseBible()

Method Detail

setDocument

public abstract void setDocument(BibleEle text)
                          throws BookException

Write the XML to disk. Children will almost certainly want to override this.

---

foundPassage

public abstract void foundPassage(java.lang.String word,
                                  com.eireneh.bible.passage.Passage ref)
                           throws BookException

Save a list of found words. Children will probably want to override this.

---

setVersion

public abstract void setVersion(Version version)

Setup the Version information

---

flush

public void flush()
           throws BookException

Flush the data written to disk

---

getBaseURL

public abstract java.net.URL getBaseURL()

Get a URL in which we can save a generation report

---

getProperties

public com.eireneh.config.Config getProperties()
                                        throws BookException

This returns a simple Config, that displays the generation notes

Specified by:

getProperties in interface Bible

Overrides:

getProperties in class AbstractBible

---

generate

public void generate(Bible version)
              throws BookException

Read from the given source version to generate ourselves

Specified by:

generate in interface Bible

Overrides:

generate in class AbstractBible

---

generateText

protected void generateText(Bible source)
                     throws java.io.IOException,
                            com.eireneh.bible.passage.NoSuchVerseException,
                            BookException

Read from the given source version to generate ourselves

---

generatePassages

protected void generatePassages(Bible source)
                         throws java.io.IOException,
                                com.eireneh.bible.passage.NoSuchVerseException,
                                BookException

Read from the given source version to generate ourselves

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> eireneh >> bible >> [ book overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---