@Service(value="cuba_FtsService") public class FtsServiceBean extends java.lang.Object implements FtsService
NAME
Constructor and Description |
---|
FtsServiceBean() |
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,
FtsSearchOption... searchOptions)
Performs a full text search among all entities described in fts configuration file.
|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
search
public SearchResult search(java.lang.String searchTerm, QueryKey queryKey, FtsSearchOption... searchOptions)
FtsService
FtsConfig.getMaxSearchResults()
If the searchOptions
contains the FtsSearchOption.POPULATE_HIT_INFOS
value then all SearchResultEntry
of the SearchResult
will contain hitInfos
collection filled.
search
in interface FtsService
public SearchResult search(java.lang.String searchTerm, java.util.List<java.lang.String> entityNames)
FtsService
entityNames
parameter.
Please notice that the result will contain all entities that match a search criteria
The hitInfos
collection of the SearchResultEntry
WILL NOT be filled.
search
in interface FtsService
public boolean isEntityIndexed(java.lang.String entityName)
FtsService
isEntityIndexed
in interface FtsService
public java.util.List<java.lang.String> collectEntityHierarchyNames(java.lang.String entityName)
collectEntityHierarchyNames
in interface FtsService
public java.lang.String getHitPropertyCaption(java.lang.String entityName, java.lang.String hitProperty)
getHitPropertyCaption
in interface FtsService
public com.haulmont.chile.core.model.MetaProperty getPrimaryKeyPropertyForFts(com.haulmont.chile.core.model.MetaClass metaClass)
FtsService
FtsManagerAPI#getPrimaryKeyPropertyForFts()
javadoc for detailsgetPrimaryKeyPropertyForFts
in interface FtsService