senselogic.sitevision.api.search.index

Interface IndexUtil

@Requireable(value="IndexUtil")
public interface IndexUtil

Index utility interface.

An instance of the Sitevision class implementing this interface can be obtained via SearchFactory.getIndexUtil(). See SearchFactory for how to obtain an instance of the SearchFactory interface.

Since:

Sitevision 3.6

Author:

Magnus Lövgren

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IndexUtil.IndexType Type of default index, used by IndexUtil.

Method Summary

Modifier and Type	Method and Description
Node	getDefaultIndex(IndexUtil.IndexType aIndexType) Gets the default index for a specified index type.
Node	getIndexByName(String aIndexName) Gets an index by name.

Method Detail

getDefaultIndex

Node getDefaultIndex(IndexUtil.IndexType aIndexType)

Gets the default index for a specified index type.

Note!The default user identity index is only handled if a Social Collaboration license is in use. The default user-generated content (UGC) index is only handled if a Social Collaboration license is in use.

Parameters:

aIndexType - type of index

Returns:

the default index for aIndexType, or null if not available

getIndexByName

Node getIndexByName(String aIndexName)

Gets an index by name.

Lookup order:

1. Custom site index
2. Custom server index
3. Default index(-es), types specified by IndexUtil.IndexType

Note! Custom index is only handled if a Search Package 2 license is in use. The default user identity index is only handled if a Social Collaboration license is in use. The default user-generated content (UGC) index is only handled if a Social Collaboration license is in use.

Parameters:

aIndexName - the name of the index

Returns:

the index or null if no index matches aIndexName