Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

com.eireneh.bible.book.raw
Interface Items  view Items download Items.java

All Known Implementing Classes:
ItemsDisk, ItemsMem

public interface Items

Items is a list of words, puncuation marks or other bits of data that can be indexed by number.
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

Method Summary
 java.util.Enumeration getEnumeration()
          Get an Enumeration through the words
 int getIndex(java.lang.String data)
          This method is called during the creation of the index to add a word to the index or to get a current id.
 int[] getIndex(java.lang.String[] data)
          Set a list of word indexes as the test to a Verse
 java.lang.String getItem(int index)
          Fetch an item from the dictionary by an id.
 void save()
          Ensure that all changes to the index of words are written to disk
 int size()
          How many items are there in the current dictionary
 

Method Detail

getEnumeration

public java.util.Enumeration getEnumeration()
Get an Enumeration through the words


getItem

public java.lang.String getItem(int index)
                         throws NoSuchResourceException
Fetch an item from the dictionary by an id.


getIndex

public int getIndex(java.lang.String data)
This method is called during the creation of the index to add a word to the index or to get a current id. If the IndexedResource was created without create=true then we do not create a new id we just return -1


getIndex

public int[] getIndex(java.lang.String[] data)
Set a list of word indexes as the test to a Verse


size

public int size()
How many items are there in the current dictionary


save

public void save()
          throws java.io.IOException
Ensure that all changes to the index of words are written to disk