| Home >> All >> com >> eireneh >> bible >> [ book Javadoc ] |
• com.eireneh.bible.book: Javadoc index of package com.eireneh.bible.book.
Package Samples:
• com.eireneh.bible.book.config
• com.eireneh.bible.book.jdbc
• com.eireneh.bible.book.raw
• com.eireneh.bible.book.raw.config
• com.eireneh.bible.book.ser
• com.eireneh.bible.book.swing
• com.eireneh.bible.book.sword
• com.eireneh.bible.book.sword.config
• com.eireneh.bible.book.tasks
• com.eireneh.bible.book.stub
Classes:
• SerBible: A Biblical source that comes from files on the local file system. This format is designed to be fast. At any cost. So disk space does not matter, which is good because early versions used about 100Mb! This is a history of some of he design desisions that this class has been through. Searching I think that a Bible ought not to store anything other than Bible text. I have experimented with a saerch mechanism that cached searches in a very effective manner, however it took up a lot of disk space, and only worked for one version. It might be good to have it work in a more generic way, and an in-memory ...
• RawBible: RawBible is a custom Bible. It is designed to be: Compact: So that the download time is as small as possible Divisible: So that a download can be partial, and some text can be read whilst missing content like styles, notes, or even word case. As a result of this is can be very slow, or very memory hungry. I guess that the technology developed here could be useful as a delivery format, but the timings I am getting from my benchmarks say "start again". There is a question mark over how this format will handle rich text. The dictionary lookup scheme can be very space efficient but I'm not sure how ...
• WordItemsMem: The WordItemsMem stores words in a dictionary for a Bible. The single method that will be of use 99% of the time is the getWord(int) method. This method will be called once for each word every time we display a verse (Assuming that we have not implemented any caches). The getIndex(String) method is the reverse of this, and is used in creating the index in the first place. The class has an underlying File however this is transarent to the user, since calls to getIndex(String) have any disk changes automatically written to disk, and the implementation of this class must be free to choose whatever ...
• Book: Book is the most basic store of textual data - It can retrieve data either as an XML document or as plain text - It uses Bookmarks to refer to parts of itself, and can search for words (returning Bookmarks). All Books should have an no-arg constructor. This restriction is important because without this the config package can not create an instance of this class from a string in an options file. What type should we use to describe a part of a book that we want to wiew? This question is made more complex because a find() operation needs to be able to return a collection of pointers. String: This ...
• Version: A Version represents a method of translating the Bible. All Bibles with the same Version should return identical text for any call to Bible.getText(VerseRange) . The implication of this is that there may be many instances of the Version "NIV", as there are several different versions of the NIV - Original American-English, Anglicized, and Inclusive Language editions at least. Versions like Strings must be compared using .equals() instead of ==. A Bible must have the ability to handle a version unknown to ProjectB. So Bibles must be able to add versions to the system, and the system must cope with ...
• WordInstsMem: A WordInstsMem provides access to the list of word ids that make up a Passage. The central interface is an Eumeration over the words in the given verse. We should probably avoid cacheing at this level since there are other Bibles that could do with cacheing. The layout of the underlying file probably has a lot in common with the WordResource class, instead of an array of ascii bytes for each index, we have a get of integers in bytes for an index. Techniques like capitalizing the first letter to indicate the start of a new word will not work here, so perhaps we should no do them in WordResource ...
• StudyBible: A WordStudy is-an extension to Bible that knows about the original Greek/Hebrew in the form of Strongs numbers, and how these original words were translated into English (or whatever). You might expect a method something like Passage getPassage(String word) for completeness, however this is a core part of the Bible interface and so redundant here. The different conversions go something like this: .-------------------. | -> Strongs -------> Passage ---> PageDOM -\ | / `-._,-' \---> HTML String .-' `-. / '-> (Word) --------> Translation ----------/ Distribution Licence: Project B is free software; ...
• GeneratorPane: Bible Generator allows the creation of new Books - although it really only converts from one implementation of Book to another. This is needed because I drivers like JDBCBook and GBMLBook will not be very speed optimized. Since this code has been edited by JBuilder I have changed it and expect problems if it is edited that way again. The code that JB created did not compile with JDK1.1 and Swing 1.1 because it uses a constructor special to AWT in JDK 1.2, So I have changed code that read new GridBagConstraints to GuiUtil.getConstraints to fix this. Distribution Licence: Project B is free software; ...
• BookEle: A BookDoc is a simple container for a DOM that holds the structure of part of a Book. It allows us to abstract away the fact that we use XML an so decrease our reliance on it, and also simplify access to a text only version of the XML Document. A BookDoc also must track the current position at which we insert new elements of Data, and it may be able to interact with XSL to return formatted objects in HTML or some other markup language. Possible extension to this code include setting a DTD that can be enforced on any Documents that we contain. Distribution Licence: Project B is free software; you ...
• BibleEle: Some helper classes to aid Document creation, and to hide all the DOM/ProjectX/XML4J specific bits. The requirements for Document handling are these: - Do not force users of this or other packages to use org.w3c.dom - Model the current DTD. This is the root of a set of Element type objects to help creating a DOM according to our DTD. In general it is the job of each Parent to add child Elements to itself. In general you should use the parent to create a child because it is easier. Distribution Licence: Project B is free software; you can redistribute it and/or modify it under the terms of the GNU ...
• Bible: Bible is the core interface to a Bible store. The methods of this interface come into 3 categories: Meta-Information methods return information about the implementation and its environment. Retrieval methods are the core methods that give access to the real Biblical text. These are the core of the interface. Generation methods are there to allow this Version to be generated. TODO: Generalize this for the Book interface 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 ...
• CaseInstsMem: A CaseInstsMem provides access to the list of case ids that make up a Passage. The central interface is an array of cases of words in the given verse. This is different from WordInsts and PuncInsts in that there is no CaseInsts. This is because there are only 4 cases worthy of note, and they are all well defined in PassageUtil. Storing these 4 cases takes 2 bits per word, 4 words per byte. 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 ...
• BiblesListModel: BiblesListModel creates a Swing ListModel from the available Bibles. I would normally implement BiblesListener in an inner class however doing that would stop me calling fireInterval*() in AbstractListModel because that is a protected method and the inner class is neither in the same package or a sub class. 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 ...
• Mem: Mem is the root of all the data sources that load their data fully into memory at init time. This is fairly fast but very memory hungry. There is code here to implememt compressed data files, however this makes load time very very slow, instead of just slow, so it is all commented out. 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 ...
• VersewiseBible: 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. ...
• PuncItemsMem: PuncItemsMem is almost identical to WordItemsMem, but the Dictionary is much smaller, there are almost certainly less than 256 different intra-word punctuation sets, so we will only need 1 byte per word instead of 2. 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 ...
• Disk: Disk is the root of all the data sources that load only load an index into memory at init time, and read the rest of the data when requested. This is slower than the Mem alternative fast but less memory hungry. 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 ...
• PuncInstsMem: A PuncInstsMem provides access to the list of punctuation ids that make up a Passage. The central interface is an Eumeration over the words in the given verse. 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 ...
• MaintenancePane: Allows various maintenance procedures to be done on Bibles like deletion, renaming, and viewing the notes that are associated with the generation of a version. 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 ...
• StubBibleDriver: StubBibleDriver is a simple stub implementation of BibleDriver that is pretty much always going to work because it has no dependancies on external files. 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 ...
• SectionEle: A SectionElement contains a list of references, and a note that describes them. We can also override the version settting on the bible element here. 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 ...
• StubBible: StubBible is a simple stub implementation of Bible that is pretty much always going to work because it has no dependancies on external files. 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 ...
• PuncInstsDisk: PuncInstsDisk is like PuncInstsMem however the entire block of data is not stored in memory, it is simply indexed and left on disk. 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 ...
• WordInstsDisk: WordInstsDisk is like WordInstsMem however the entire block of data is not stored in memory, it is simply indexed and left on disk. 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 ...
• AbstractBibleDriver: The AbstractBibleDriver class implements some of the BibleDriver methods, that various BibleDrivers may do in the same way. 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 ...
| Home | Contact Us | Privacy Policy | Terms of Service |