Index

The Index class manages a search index. It contains the indexes and stores all the tokens and document lookups. It also provides the main user facing API for the library.

There are two formats for the index:

• The original uncompressed format, used by the Javascript elasticlunr project
• A compressed formatcompressed format, allowing ro reduce the size of the index by a factor 3

Index creation

To create a new Index:

• Call the ElasticLunr.createIndex() method
• Add the field of documents in the index by calling Index.addField(String field) for each field
• Set the document ref identification by calling the Index.setRef(String ref) method