com.day.cq.search.suggest

Interface SuggestionIndexManager

public interface SuggestionIndexManager

Service interface for managing SuggestionIndexes, e.g. reading, creating and deleting them.

Method Summary

Methods

Modifier and Type	Method and Description
void	delete(String name) Deletes a suggestion index.
SuggestionIndex	get(String name) Gets or creates a suggestion index.
Iterable<String>	list() Lists the available suggestions indexes.

Method Detail

get

SuggestionIndex get(String name)
                    throws RepositoryException

Gets or creates a suggestion index. The index will be created on demand when the first term is added.

Note: make sure to close the index after usage to properly release affected resources, e.g. the underlying JCR session. This should be done in a try/finally block.

The returned index is not thread-safe.

Parameters:

name - name or path of the index

Returns:

a suggestion index

Throws:

RepositoryException - if an unexpected repository problem occurred

delete

void delete(String name)
            throws RepositoryException

Deletes a suggestion index.

Parameters:

name - name or path of the index

Throws:

RepositoryException - if an unexpected repository problem occurred

list

Iterable<String> list()
                      throws RepositoryException

Lists the available suggestions indexes.

If the indexes were created with path names in get(String), these will always be returned as relative paths, ie. without a leading slash. Both variants, "/index" and "index" will work with get(String) and delete(String).

Returns:

a list of index names (relative paths)

Throws:

RepositoryException - if an unexpected repository problem occurred