org.dizitart.no2.fulltext

Interface TextIndexingService

public interface TextIndexingService

Represents a full-text indexing engine. It scans a document and modifies full-text index entries by decomposing texts of an indexed field, into a set of string tokens. It uses the full-text index to search for a specific text.

Since:

1.0

See Also:

NitriteBuilder.textIndexingService(TextIndexingService), Filters.text(String, String), ObjectFilters.text(String, String)

Method Summary

Modifier and Type	Method and Description
void	clear() Deletes all full-text index entries.
void	createIndex(NitriteId id, java.lang.String field, java.lang.String text) Creates a full-text index entry from a specific field containing the text.
void	deleteIndex(NitriteId id, java.lang.String field, java.lang.String text) Deletes a full-text index entry.
void	deleteIndexesByField(java.lang.String field) Deletes all full-text index entries of the field.
void	drop() Drops all full-text index entries of a collection.
java.util.Set<NitriteId>	searchByIndex(java.lang.String field, java.lang.String searchString) Searches searchString using the full-text index of the field.
void	updateIndex(NitriteId id, java.lang.String field, java.lang.String text) Updates a full-text index entry.

Method Detail

createIndex

void createIndex(NitriteId id,
                 java.lang.String field,
                 java.lang.String text)

Creates a full-text index entry from a specific field containing the text.

Parameters:

id - the id associated with the document containing the text

field - the indexed field

text - the text to index

updateIndex

void updateIndex(NitriteId id,
                 java.lang.String field,
                 java.lang.String text)

Updates a full-text index entry.

Parameters:

id - the id associated with the document containing the text

field - the indexed field

text - the text to update

deleteIndex

void deleteIndex(NitriteId id,
                 java.lang.String field,
                 java.lang.String text)

Deletes a full-text index entry.

Parameters:

id - the id associated with the document containing the text

field - the indexed field

text - the text to delete

deleteIndexesByField

void deleteIndexesByField(java.lang.String field)

Deletes all full-text index entries of the field.

Parameters:

field - the field

searchByIndex

java.util.Set<NitriteId> searchByIndex(java.lang.String field,
                                       java.lang.String searchString)

Searches searchString using the full-text index of the field.

Parameters:

field - the field

searchString - the search string to search using index

Returns:

the set of NitriteIds for the matching documents.

drop

void drop()

Drops all full-text index entries of a collection.

clear

void clear()

Deletes all full-text index entries.