com.impetus.kundera.index.lucene

Interface Indexer

All Superinterfaces:

Indexer

public interface Indexer
extends Indexer

Interface to define the behavior of an Indexer.

Author:

animesh.kumar

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close on index writer/reader.
boolean	documentExistsInIndex(EntityMetadata metadata, Object id, EntityManagerFactoryImpl.KunderaMetadata kunderaMetadata, boolean isEmbeddedId, Class<?> parentClazz)
boolean	entityExistsInIndex(Class<?> entityClass, EntityManagerFactoryImpl.KunderaMetadata kunderaMetadata, EntityMetadata metadata)
void	flush() Flushes out indexes.
void	index(EntityMetadata metadata, MetamodelImpl metaModel, Object object) Indexes and object.
void	index(EntityMetadata metadata, MetamodelImpl metaModel, Object object, String parentId, Class<?> clazz) Indexes and object.
Map<String,Object>	search(String luceneQuery, int start, int count, boolean fetchRelation, EntityManagerFactoryImpl.KunderaMetadata kunderaMetadata, EntityMetadata metadata) Searches for an object.
void	unindex(EntityMetadata metadata, Object id, EntityManagerFactoryImpl.KunderaMetadata kunderaMetadata, Class<?> parentClazz) Unindexed an entity with key:id.
void	update(EntityMetadata metadata, MetamodelImpl metaModel, Object entity, Object id, String parentId) Updates the existing document.

Methods inherited from interface com.impetus.kundera.index.Indexer

index, search, search, search, unIndex

Method Detail

unindex

void unindex(EntityMetadata metadata,
           Object id,
           EntityManagerFactoryImpl.KunderaMetadata kunderaMetadata,
           Class<?> parentClazz)

Unindexed an entity with key:id.

Parameters:

metadata - the metadata

id - the id

index

void index(EntityMetadata metadata,
         MetamodelImpl metaModel,
         Object object)

Indexes and object.

Parameters:

metadata - the metadata

object - the object

index

void index(EntityMetadata metadata,
         MetamodelImpl metaModel,
         Object object,
         String parentId,
         Class<?> clazz)

Indexes and object.

Parameters:

metadata - the meta data.

object - the object.

parentId - parent Id.

clazz - parent class.

search

Map<String,Object> search(String luceneQuery,
                        int start,
                        int count,
                        boolean fetchRelation,
                        EntityManagerFactoryImpl.KunderaMetadata kunderaMetadata,
                        EntityMetadata metadata)

Searches for an object. Note that the "query" must be in Indexer specified form.

Parameters:

luceneQuery - the lucene query

start - the start

count - the count

fetchRelation - the fetch relation

Returns:

the list

close

void close()

Close on index writer/reader.

Specified by:

close in interface Indexer

flush

void flush()

Flushes out indexes.

update

void update(EntityMetadata metadata,
          MetamodelImpl metaModel,
          Object entity,
          Object id,
          String parentId)

Updates the existing document.

Parameters:

metadata - entity metadata.

entity - entity object.

id - entity id

parentId - parent entity id

parentClazz - parent class

entityExistsInIndex

boolean entityExistsInIndex(Class<?> entityClass,
                          EntityManagerFactoryImpl.KunderaMetadata kunderaMetadata,
                          EntityMetadata metadata)

Parameters:

entityClass -

kunderaMetadata -

metadata -

Returns:

documentExistsInIndex

boolean documentExistsInIndex(EntityMetadata metadata,
                            Object id,
                            EntityManagerFactoryImpl.KunderaMetadata kunderaMetadata,
                            boolean isEmbeddedId,
                            Class<?> parentClazz)

Parameters:

metadata -

id -

kunderaMetadata -

isEmbeddedId -

parentClazz -

Returns: