com.haulmont.fts.app

Interface FtsService

All Known Implementing Classes:

FtsServiceBean

public interface FtsService

Provides search functionality to clients.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	collectEntityHierarchyNames(java.lang.String entityName)
SearchResult	expandResult(SearchResult result, java.lang.String entityName) Loads more results.
java.lang.String	getHitPropertyCaption(java.lang.String entityName, java.lang.String hitProperty)
com.haulmont.chile.core.model.MetaProperty	getPrimaryKeyPropertyForFts(com.haulmont.chile.core.model.MetaClass metaClass) See FtsManagerAPI#getPrimaryKeyPropertyForFts() javadoc for details
boolean	isEntityIndexed(java.lang.String entityName) Checks whether an entity is indexed by full text search engine
SearchResult	search(java.lang.String searchTerm) Performs a full text search among all entities described in fts configuration file.
SearchResult	search(java.lang.String searchTerm, java.util.List<java.lang.String> entityNames) Performs a full text search.

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

search

SearchResult search(java.lang.String searchTerm)

Performs a full text search among all entities described in fts configuration file. Number of entities in result is restricted by FtsConfig.getMaxSearchResults()

search

SearchResult search(java.lang.String searchTerm,
                    java.util.List<java.lang.String> entityNames)

Performs a full text search. SearchResult will contain only entities with names passed in entityNames parameter.

Please notice that the result will contain all entities that match a search criteria

expandResult

SearchResult expandResult(SearchResult result,
                          java.lang.String entityName)

Loads more results.

isEntityIndexed

boolean isEntityIndexed(java.lang.String entityName)

Checks whether an entity is indexed by full text search engine

collectEntityHierarchyNames

java.util.List<java.lang.String> collectEntityHierarchyNames(java.lang.String entityName)

Returns:

a list of entity names that contains entity name from parameter itself, names of entity descendants and name of original meta class if passed entity is an extension

getHitPropertyCaption

java.lang.String getHitPropertyCaption(java.lang.String entityName,
                                       java.lang.String hitProperty)

Returns:

a caption for entity property that was found by fts

getPrimaryKeyPropertyForFts

com.haulmont.chile.core.model.MetaProperty getPrimaryKeyPropertyForFts(com.haulmont.chile.core.model.MetaClass metaClass)

See FtsManagerAPI#getPrimaryKeyPropertyForFts() javadoc for details