com.haulmont.cuba.gui.components.filter

Interface FtsFilterHelper

public interface FtsFilterHelper

Interface provides full text search functionality necessary to generic filter component. Its implementation is in FTS module.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FtsFilterHelper.FtsSearchResult Class for holding search result.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME
static java.lang.String	QUERY_KEY_PARAM_NAME
static java.lang.String	SESSION_ID_PARAM_NAME

Method Summary

Modifier and Type	Method and Description
CustomCondition	createFtsCondition(java.lang.String entityName) Creates a filter condition that joins a set of entities stored with given @{code queryKey}
java.lang.String	createFtsWhereClause(java.lang.String entityName)
java.lang.String	createFtsWhereClause(java.lang.String entityName, java.lang.String queryParamName, java.lang.String sessionIdParamName)
boolean	isEntityIndexed(java.lang.String entityName) Checks whether an entity is indexed by full text search engine
FtsFilterHelper.FtsSearchResult	search(java.lang.String searchTerm, java.lang.String entityName) Performs full text search and stores founded entity ids as QueryResult records in database.

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

QUERY_KEY_PARAM_NAME

static final java.lang.String QUERY_KEY_PARAM_NAME

See Also:

Constant Field Values

SESSION_ID_PARAM_NAME

static final java.lang.String SESSION_ID_PARAM_NAME

See Also:

Constant Field Values

Method Detail

isEntityIndexed

boolean isEntityIndexed(java.lang.String entityName)

Checks whether an entity is indexed by full text search engine

search

FtsFilterHelper.FtsSearchResult search(java.lang.String searchTerm,
                                       java.lang.String entityName)

Performs full text search and stores founded entity ids as QueryResult records in database.

Parameters:

entityName - name of entity from datasource. Please note that result will contain not only entities with given name but its descendants as well

Returns:

search result that contains queryKey and map that holds search result descriptions (see FtsFilterHelper.FtsSearchResult)

createFtsCondition

CustomCondition createFtsCondition(java.lang.String entityName)

Creates a filter condition that joins a set of entities stored with given @{code queryKey}

createFtsWhereClause

java.lang.String createFtsWhereClause(java.lang.String entityName)

createFtsWhereClause

java.lang.String createFtsWhereClause(java.lang.String entityName,
                                      java.lang.String queryParamName,
                                      java.lang.String sessionIdParamName)