com.haulmont.fts.core.app

Class FtsServiceBean

java.lang.Object

com.haulmont.fts.core.app.FtsServiceBean

All Implemented Interfaces:

FtsService

@Service(value="cuba_FtsService")
public class FtsServiceBean
extends java.lang.Object
implements FtsService

Field Summary

Fields inherited from interface com.haulmont.fts.app.FtsService

NAME

Constructor Summary

Constructors

Constructor and Description
FtsServiceBean()

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	collectEntityHierarchyNames(java.lang.String entityName)
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, java.util.List<java.lang.String> entityNames) Performs a full text search.
SearchResult	search(java.lang.String searchTerm, QueryKey queryKey) Performs a full text search among all entities described in fts configuration file.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.haulmont.fts.app.FtsService

search

Constructor Detail

FtsServiceBean

public FtsServiceBean()

Method Detail

search

public SearchResult search(java.lang.String searchTerm,
                           QueryKey queryKey)

Description copied from interface: FtsService

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

Specified by:

search in interface FtsService

search

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

Description copied from interface: FtsService

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

Specified by:

search in interface FtsService

isEntityIndexed

public boolean isEntityIndexed(java.lang.String entityName)

Description copied from interface: FtsService

Checks whether an entity is indexed by full text search engine

Specified by:

isEntityIndexed in interface FtsService

collectEntityHierarchyNames

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

Specified by:

collectEntityHierarchyNames in interface FtsService

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

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

Specified by:

getHitPropertyCaption in interface FtsService

Returns:

a caption for entity property that was found by fts

getPrimaryKeyPropertyForFts

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

Description copied from interface: FtsService

See FtsManagerAPI#getPrimaryKeyPropertyForFts() javadoc for details

Specified by:

getPrimaryKeyPropertyForFts in interface FtsService