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

---

com.eireneh.bible.control.map
Class LinkArray  

java.lang.Object
  com.eireneh.bible.control.map.LinkArray

All Implemented Interfaces:

java.io.Serializable

---

public class LinkArray

extends java.lang.Object

implements java.io.Serializable

LinkArray contains a set of links for each verse in the Bible. It is similar to a central margin reference data set, except that every verse is linked to a constant number of others, and the links have strengths.

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:

D0.I0.T0

---

Field Summary
private  com.eireneh.bible.book.Bible	bible           The Bible that we search in
private  com.eireneh.bible.control.search.Matcher	engine           The thing we use to generate matches
private  int	linked           The number of verses checked
private  Link[][]	links           The link data
private static int	LINKS_PER_VERSE           The number of links we record for each verse
protected static com.eireneh.util.Logger	log           The log stream
private  int	miss_total           The total miss mark
(package private) static long	serialVersionUID           To make serialization work across new versions

 

Constructor Summary

LinkArray(com.eireneh.bible.book.Bible bible)           Basic constructor

 

Method Summary
void	cacheAll()           Fill up the link cache
private static java.lang.String	debug(Link[] set)           Debug for an array of Links
Link[]	getLinks(int ord)           Turn a PassageTally into an array of links.
float	getMatchScore()           What is the average index for a given match.

 

Methods inherited from class java.lang.Object

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

 

Field Detail

serialVersionUID

static final long serialVersionUID

To make serialization work across new versions

See Also:

Constant Field Values

---

miss_total

private transient int miss_total

The total miss mark

---

linked

private transient int linked

The number of verses checked

---

bible

private transient com.eireneh.bible.book.Bible bible

The Bible that we search in

---

engine

private transient com.eireneh.bible.control.search.Matcher engine

The thing we use to generate matches

---

LINKS_PER_VERSE

private static final int LINKS_PER_VERSE

The number of links we record for each verse

See Also:

Constant Field Values

---

links

private Link[][] links

The link data

---

log

protected static com.eireneh.util.Logger log

The log stream

Constructor Detail

LinkArray

public LinkArray(com.eireneh.bible.book.Bible bible)
          throws com.eireneh.bible.passage.NoSuchVerseException,
                 com.eireneh.bible.book.BookException,
                 com.eireneh.bible.control.search.SearchException

Basic constructor

Method Detail

cacheAll

public void cacheAll()
              throws com.eireneh.bible.passage.NoSuchVerseException,
                     com.eireneh.bible.book.BookException,
                     com.eireneh.bible.control.search.SearchException

Fill up the link cache

---

getLinks

public Link[] getLinks(int ord)

Turn a PassageTally into an array of links.

---

getMatchScore

public float getMatchScore()

What is the average index for a given match. This is a measure of how good the nest match algorithm is. The closer to zero the better

---

debug

private static java.lang.String debug(Link[] set)

Debug for an array of Links

---

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

---