com.haulmont.fts.core.app

Class FtsManager

java.lang.Object

com.haulmont.fts.core.app.FtsManager

All Implemented Interfaces:

FtsManagerAPI

@Component(value="cuba_FtsManager")
public class FtsManager
extends java.lang.Object
implements FtsManagerAPI

Field Summary

Fields inherited from interface com.haulmont.fts.core.app.FtsManagerAPI

NAME

Constructor Summary

Constructors

Constructor and Description
FtsManager()

Method Summary

Modifier and Type	Method and Description
void	asyncReindexAll()
void	asyncReindexEntity(java.lang.String entityName)
void	deleteIndex()
void	deleteIndexForEntity(java.lang.String entityName)
java.lang.String	getIndexFormatVersion()
java.lang.String	getLatestIndexFormatVersion()
com.haulmont.chile.core.model.MetaProperty	getPrimaryKeyPropertyForFts(com.haulmont.chile.core.model.MetaClass metaClass) From FTS point of view there are cases when non-PK field must be treated as primary key for building JPQL queries, for example.
java.util.Queue<java.lang.String>	getReindexEntitiesQueue()
java.util.List<com.haulmont.cuba.core.entity.Entity>	getSearchableEntities(com.haulmont.cuba.core.entity.Entity entity)
boolean	isEnabled()
boolean	isEntityCanBeIndexed(com.haulmont.chile.core.model.MetaClass metaClass) Method checks whether entities of the given MetaClass can be indexed.
boolean	isReindexing()
boolean	isWriting()
java.lang.String	optimize()
int	processQueue()
int	reindexAll()
int	reindexEntity(java.lang.String entityName)
int	reindexNextBatch()
void	setEnabled(boolean value)
void	setServerInfo(com.haulmont.cuba.core.app.ServerInfoAPI serverInfo)
boolean	showInResults(java.lang.String entityName)
java.lang.String	upgrade()

Methods inherited from class java.lang.Object

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

Constructor Detail

FtsManager

public FtsManager()

Method Detail

setServerInfo

@Inject
public void setServerInfo(com.haulmont.cuba.core.app.ServerInfoAPI serverInfo)

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface FtsManagerAPI

setEnabled

public void setEnabled(boolean value)

Specified by:

setEnabled in interface FtsManagerAPI

isWriting

public boolean isWriting()

Specified by:

isWriting in interface FtsManagerAPI

isReindexing

public boolean isReindexing()

Specified by:

isReindexing in interface FtsManagerAPI

getReindexEntitiesQueue

public java.util.Queue<java.lang.String> getReindexEntitiesQueue()

Specified by:

getReindexEntitiesQueue in interface FtsManagerAPI

getSearchableEntities

public java.util.List<com.haulmont.cuba.core.entity.Entity> getSearchableEntities(com.haulmont.cuba.core.entity.Entity entity)

Specified by:

getSearchableEntities in interface FtsManagerAPI

processQueue

public int processQueue()

Specified by:

processQueue in interface FtsManagerAPI

optimize

public java.lang.String optimize()

Specified by:

optimize in interface FtsManagerAPI

upgrade

public java.lang.String upgrade()

Specified by:

upgrade in interface FtsManagerAPI

showInResults

public boolean showInResults(java.lang.String entityName)

Specified by:

showInResults in interface FtsManagerAPI

deleteIndexForEntity

public void deleteIndexForEntity(java.lang.String entityName)

Specified by:

deleteIndexForEntity in interface FtsManagerAPI

deleteIndex

public void deleteIndex()

Specified by:

deleteIndex in interface FtsManagerAPI

reindexEntity

public int reindexEntity(java.lang.String entityName)

Specified by:

reindexEntity in interface FtsManagerAPI

asyncReindexEntity

public void asyncReindexEntity(java.lang.String entityName)

Specified by:

asyncReindexEntity in interface FtsManagerAPI

reindexAll

public int reindexAll()

Specified by:

reindexAll in interface FtsManagerAPI

asyncReindexAll

public void asyncReindexAll()

Specified by:

asyncReindexAll in interface FtsManagerAPI

reindexNextBatch

public int reindexNextBatch()

Specified by:

reindexNextBatch in interface FtsManagerAPI

isEntityCanBeIndexed

public boolean isEntityCanBeIndexed(com.haulmont.chile.core.model.MetaClass metaClass)

Description copied from interface: FtsManagerAPI

Method checks whether entities of the given MetaClass can be indexed. For example, indexing of entities that have composite primary key and don't implement HasUuid interface is not possible.

Specified by:

isEntityCanBeIndexed in interface FtsManagerAPI

getPrimaryKeyPropertyForFts

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

Description copied from interface: FtsManagerAPI

From FTS point of view there are cases when non-PK field must be treated as primary key for building JPQL queries, for example.

When indexing or performing a full-text search on an entity with composite key, its 'uuid' field (if presented) must be used instead of its real primary key (embedded entity).

Specified by:

getPrimaryKeyPropertyForFts in interface FtsManagerAPI

Returns:

a MetaProperty with a primary key or a MetaProperty for 'uuid' field (in case of entity with composite primary key

getIndexFormatVersion

public java.lang.String getIndexFormatVersion()

Specified by:

getIndexFormatVersion in interface FtsManagerAPI

Returns:

current index format version

getLatestIndexFormatVersion

public java.lang.String getLatestIndexFormatVersion()

Specified by:

getLatestIndexFormatVersion in interface FtsManagerAPI

Returns:

last index format version supported by lucene