com.impetus.kundera.index

Interface Indexer

All Known Subinterfaces:

Indexer

public interface Indexer

Indexer interface. Any custom implementation for this interface can be plugged-in by configuring kundera.indexer.class property in persistence.xml. Once this is enabled in persistence provider, Kundera will automatically delegate index related requests to configure indexer interface implementation but will keep functioning for any database specific requests. For example, developer may rely upon custom index implementation for inverted indexes(e.g. @Id attributes) but entity data population will be handled by Kundera.

Author:

vivek.mishra

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close indexer instance.
void	index(Class entityClazz, EntityMetadata entityMetadata, Map<String,Object> values, Object parentId, Class parentClazz) Index a document for given entity class and collection of values.
Map<String,Object>	search(Class<?> clazz, EntityMetadata m, String luceneQuery, int start, int count) Deprecated.
Map<String,Object>	search(EntityManagerFactoryImpl.KunderaMetadata kunderaMetadata, KunderaQuery kunderaQuery, PersistenceDelegator persistenceDelegator, EntityMetadata m, int maxResults)
Map<String,Object>	search(String query, Class<?> parentClass, EntityMetadata parentMetadata, Class<?> childClass, EntityMetadata childMetadata, Object entityId, int start, int count) Searches into a secondary index
void	unIndex(Class entityClazz, Object entity, EntityMetadata entityMetadata, MetamodelImpl metamodel) Deletes index for given entity class.

Method Detail

index

void index(Class entityClazz,
         EntityMetadata entityMetadata,
         Map<String,Object> values,
         Object parentId,
         Class parentClazz)

Index a document for given entity class and collection of values.

Parameters:

entityClazz - entity class

values - map of values containing field name as key and it's value.

search

@Deprecated
Map<String,Object> search(Class<?> clazz,
                                   EntityMetadata m,
                                   String luceneQuery,
                                   int start,
                                   int count)

Deprecated.

Executes lucene query and returns inverted indices as output. TODO: Indexer interface shouldn't make any assumption about its implementation, this method signature accepts lucene query, and hence should go away

Parameters:

queryString - lucene query.

start - start counter

end - end counter

Returns:

collection containing stored index value.

search

Map<String,Object> search(String query,
                        Class<?> parentClass,
                        EntityMetadata parentMetadata,
                        Class<?> childClass,
                        EntityMetadata childMetadata,
                        Object entityId,
                        int start,
                        int count)

Searches into a secondary index

Returns:

search

Map<String,Object> search(EntityManagerFactoryImpl.KunderaMetadata kunderaMetadata,
                        KunderaQuery kunderaQuery,
                        PersistenceDelegator persistenceDelegator,
                        EntityMetadata m,
                        int maxResults)

unIndex

void unIndex(Class entityClazz,
           Object entity,
           EntityMetadata entityMetadata,
           MetamodelImpl metamodel)

Deletes index for given entity class.

Parameters:

entityClazz - entity class

entity - Entity object

close

void close()

Close indexer instance.