com.impetus.kundera.index

Class LuceneIndexer

java.lang.Object

com.impetus.kundera.index.DocumentIndexer

com.impetus.kundera.index.LuceneIndexer

All Implemented Interfaces:

Indexer

public class LuceneIndexer
extends DocumentIndexer

Provides indexing functionality using lucene library.

Author:

amresh.singh

Field Summary

Fields

Modifier and Type	Field and Description
private static org.apache.lucene.store.Directory	index The index.
private static LuceneIndexer	indexer The indexer.
private static boolean	isInitialized The is initialized.
private static org.slf4j.Logger	log log for this class.
private static String	luceneDirPath The lucene dir path.
private static org.apache.lucene.index.IndexReader	reader The reader.
private static boolean	readyForCommit The ready for commit.
private static org.apache.lucene.index.IndexWriter	w The w.

Fields inherited from class com.impetus.kundera.index.DocumentIndexer

analyzer, DEFAULT_SEARCHABLE_FIELD, docNumber, INDEX_NAME, SUPERCOLUMN_INDEX, tokenizer

Constructor Summary

Constructors

Modifier	Constructor and Description
private	LuceneIndexer(String lucDirPath) Instantiates a new lucene indexer.

Method Summary

Modifier and Type	Method and Description
void	close() Close of transaction.
private void	copy(org.apache.lucene.store.Directory src, org.apache.lucene.store.Directory to)
boolean	documentExistsInIndex(EntityMetadata metadata, Object id, EntityManagerFactoryImpl.KunderaMetadata kunderaMetadata, boolean isEmbeddedId, Class<?> parentClazz)
boolean	entityExistsInIndex(Class<?> entityClass, EntityManagerFactoryImpl.KunderaMetadata kunderaMetadata, EntityMetadata metadata)
void	flush()
private void	flushInternal() Flush internal.
private File	getIndexDirectory() Creates a Lucene index directory if it does not exist.
private org.apache.lucene.index.IndexReader	getIndexReader() Returns default index reader.
private org.apache.lucene.index.IndexWriter	getIndexWriter() Added for HBase support.
static LuceneIndexer	getInstance(String lucDirPath) Gets the single instance of LuceneIndexer.
private String	getLuceneQuery(EntityMetadata metadata, Object id, boolean isEmbeddedId, MetamodelImpl metaModel, Class<?> parentClazz)
void	index(Class entityClazz, EntityMetadata entityMetadata, Map<String,Object> values, Object parentId, Class parentClazz)
void	index(EntityMetadata metadata, MetamodelImpl metaModel, Object object)
void	index(EntityMetadata metadata, MetamodelImpl metaModel, Object object, String parentId, Class<?> clazz)
private org.apache.lucene.document.Document	indexCollectionObject(EntityMetadata metadata, Object entity, String parentId, Class<?> clazz, boolean isUpdate, Object rowKey, String attributeName, javax.persistence.metamodel.EmbeddableType embeddableAttribute, ElementCollectionCacheManager ecCacheHandler, int lastEmbeddedObjectCount, Object obj, MetamodelImpl metamodel)
void	indexDocument(EntityMetadata metadata, org.apache.lucene.document.Document document) Indexes document in file system using lucene.
private org.apache.lucene.document.Document	indexDocument(EntityMetadata metadata, MetamodelImpl metaModel, Object object, String parentId, Class<?> clazz) Index document.
private void	onCommit() On commit.
void	prepareEmbeddedId(org.apache.lucene.search.TopDocs docs, Map<String,Object> indexCol, org.apache.lucene.search.IndexSearcher searcher, EntityMetadata metadata, MetamodelImpl metaModel) search the data from lucene for embeddedid
private void	prepareEmbeddedIdFields(Set<javax.persistence.metamodel.Attribute> embeddedAttributes, MetamodelImpl metaModel, Map<String,Object> embeddedIdFields, org.apache.lucene.document.Document doc, EntityMetadata metadata)
Map<String,Object>	search(Class<?> clazz, EntityMetadata m, String luceneQuery, int start, int end)
Map<String,Object>	search(EntityManagerFactoryImpl.KunderaMetadata kunderaMetadata, KunderaQuery kunderaQuery, PersistenceDelegator persistenceDelegator, EntityMetadata m, int maxResults)
Map<String,Object>	search(String luceneQuery, int start, int count, boolean fetchRelation, EntityManagerFactoryImpl.KunderaMetadata kunderaMetadata, EntityMetadata metadata)
void	unIndex(Class entityClazz, Object entity, EntityMetadata metadata, MetamodelImpl metamodel)
void	unindex(EntityMetadata metadata, Object id, EntityManagerFactoryImpl.KunderaMetadata kunderaMetadata, Class<?> parentClazz)
void	update(EntityMetadata metadata, MetamodelImpl metaModel, Object entity, Object id, String parentId)
private void	updateDocument(EntityMetadata metadata, MetamodelImpl metaModel, Object entity, String parentId, Class<? extends Object> class1, boolean b) Updates document.
void	updateDocument(String id, org.apache.lucene.document.Document document, String EmbeddedEntityFieldName) Indexes document in file system using lucene.
private org.apache.lucene.document.Document	updateOrCreateIndex(EntityMetadata metadata, MetamodelImpl metaModel, Object entity, String parentId, Class<?> clazz, boolean isUpdate) Update/Index document.
private org.apache.lucene.document.Document	updateOrCreateIndexCollectionTypeEmbeddedObject(EntityMetadata metadata, MetamodelImpl metaModel, Object entity, String parentId, Class<?> clazz, boolean isUpdate, org.apache.lucene.document.Document document, Object embeddedObject, Object rowKey, String attributeName, javax.persistence.metamodel.EmbeddableType embeddableAttribute) update or create indexes when embedded object is of collection type
private void	updateOrCreateIndexEmbeddedIdFields(Set<javax.persistence.metamodel.Attribute> embeddedAttributes, MetamodelImpl metaModel, org.apache.lucene.document.Document document, EntityMetadata metadata, Object rowKey)
private org.apache.lucene.document.Document	updateOrCreateIndexNonSuperColumnFamily(EntityMetadata metadata, MetamodelImpl metaModel, Object entity, String parentId, Class<?> clazz, boolean isUpdate, boolean isEmbeddedId, Object rowKey) update or Create Index for non super columnfamily

Methods inherited from class com.impetus.kundera.index.DocumentIndexer

addAssociatedEntitiesToDocument, addEntityClassToDocument, addEntityFieldsToDocument, addParentKeyToDocument, createSuperColumnDocument, getCannonicalPropertyName, getKunderaId, indexCompositeKey, indexSuperColumn, prepareDocumentForSuperColumn, search

Methods inherited from class java.lang.Object

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

Field Detail

log

private static org.slf4j.Logger log

log for this class.

w

private static org.apache.lucene.index.IndexWriter w

The w.

reader

private static org.apache.lucene.index.IndexReader reader

The reader.

index

private static org.apache.lucene.store.Directory index

The index.

isInitialized

private static boolean isInitialized

The is initialized.

indexer

private static LuceneIndexer indexer

The indexer.

readyForCommit

private static boolean readyForCommit

The ready for commit.

luceneDirPath

private static String luceneDirPath

The lucene dir path.

Constructor Detail

LuceneIndexer

private LuceneIndexer(String lucDirPath)

Instantiates a new lucene indexer.

Parameters:

analyzer - the analyzer

lucDirPath - the luc dir path

Method Detail

getInstance

public static LuceneIndexer getInstance(String lucDirPath)

Gets the single instance of LuceneIndexer.

Parameters:

analyzer - the analyzer

lucDirPath - the luc dir path

Returns:

single instance of LuceneIndexer

getIndexWriter

private org.apache.lucene.index.IndexWriter getIndexWriter()

Added for HBase support.

Returns:

default index writer

getIndexReader

private org.apache.lucene.index.IndexReader getIndexReader()

Returns default index reader.

Returns:

index reader.

getIndexDirectory

private File getIndexDirectory()

Creates a Lucene index directory if it does not exist.

Returns:

the index directory

index

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

unindex

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

Throws:

LuceneIndexingException

getLuceneQuery

private String getLuceneQuery(EntityMetadata metadata,
                              Object id,
                              boolean isEmbeddedId,
                              MetamodelImpl metaModel,
                              Class<?> parentClazz)

Parameters:

metadata -

id -

isEmbeddedId -

metaModel -

Returns:

update

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

prepareEmbeddedId

public void prepareEmbeddedId(org.apache.lucene.search.TopDocs docs,
                              Map<String,Object> indexCol,
                              org.apache.lucene.search.IndexSearcher searcher,
                              EntityMetadata metadata,
                              MetamodelImpl metaModel)

search the data from lucene for embeddedid

Parameters:

docs -

indexCol -

searcher -

metadata -

metaModel -

prepareEmbeddedIdFields

private void prepareEmbeddedIdFields(Set<javax.persistence.metamodel.Attribute> embeddedAttributes,
                                     MetamodelImpl metaModel,
                                     Map<String,Object> embeddedIdFields,
                                     org.apache.lucene.document.Document doc,
                                     EntityMetadata metadata)

search

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

indexDocument

public void indexDocument(EntityMetadata metadata,
                          org.apache.lucene.document.Document document)

Indexes document in file system using lucene.

Specified by:

indexDocument in class DocumentIndexer

Parameters:

metadata - the metadata

document - the document

updateDocument

public void updateDocument(String id,
                           org.apache.lucene.document.Document document,
                           String EmbeddedEntityFieldName)

Indexes document in file system using lucene.

Parameters:

metadata - the metadata

document - the document

flushInternal

private void flushInternal()

Flush internal.

close

public void close()

Close of transaction.

flush

public void flush()

index

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

entityExistsInIndex

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

documentExistsInIndex

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

indexDocument

private org.apache.lucene.document.Document indexDocument(EntityMetadata metadata,
                                                          MetamodelImpl metaModel,
                                                          Object object,
                                                          String parentId,
                                                          Class<?> clazz)

Index document.

Parameters:

metadata - the metadata

object - the object

parentId - the parent id

clazz - the clazz

Returns:

the document

updateOrCreateIndex

private org.apache.lucene.document.Document updateOrCreateIndex(EntityMetadata metadata,
                                                                MetamodelImpl metaModel,
                                                                Object entity,
                                                                String parentId,
                                                                Class<?> clazz,
                                                                boolean isUpdate)

Update/Index document.

Parameters:

metadata - the metadata

entity - the object

parentId - the parent id

clazz - the clazz

Returns:

the document

updateOrCreateIndexNonSuperColumnFamily

private org.apache.lucene.document.Document updateOrCreateIndexNonSuperColumnFamily(EntityMetadata metadata,
                                                                                    MetamodelImpl metaModel,
                                                                                    Object entity,
                                                                                    String parentId,
                                                                                    Class<?> clazz,
                                                                                    boolean isUpdate,
                                                                                    boolean isEmbeddedId,
                                                                                    Object rowKey)

update or Create Index for non super columnfamily

Parameters:

metadata -

metaModel -

entity -

parentId -

clazz -

isUpdate -

isEmbeddedId -

rowKey -

Returns:

updateOrCreateIndexEmbeddedIdFields

private void updateOrCreateIndexEmbeddedIdFields(Set<javax.persistence.metamodel.Attribute> embeddedAttributes,
                                                 MetamodelImpl metaModel,
                                                 org.apache.lucene.document.Document document,
                                                 EntityMetadata metadata,
                                                 Object rowKey)

updateOrCreateIndexCollectionTypeEmbeddedObject

private org.apache.lucene.document.Document updateOrCreateIndexCollectionTypeEmbeddedObject(EntityMetadata metadata,
                                                                                            MetamodelImpl metaModel,
                                                                                            Object entity,
                                                                                            String parentId,
                                                                                            Class<?> clazz,
                                                                                            boolean isUpdate,
                                                                                            org.apache.lucene.document.Document document,
                                                                                            Object embeddedObject,
                                                                                            Object rowKey,
                                                                                            String attributeName,
                                                                                            javax.persistence.metamodel.EmbeddableType embeddableAttribute)

update or create indexes when embedded object is of collection type

Parameters:

metadata -

metaModel -

entity -

parentId -

clazz -

isUpdate -

document -

embeddedObject -

rowKey -

attributeName -

embeddableAttribute -

Returns:

indexCollectionObject

private org.apache.lucene.document.Document indexCollectionObject(EntityMetadata metadata,
                                                                  Object entity,
                                                                  String parentId,
                                                                  Class<?> clazz,
                                                                  boolean isUpdate,
                                                                  Object rowKey,
                                                                  String attributeName,
                                                                  javax.persistence.metamodel.EmbeddableType embeddableAttribute,
                                                                  ElementCollectionCacheManager ecCacheHandler,
                                                                  int lastEmbeddedObjectCount,
                                                                  Object obj,
                                                                  MetamodelImpl metamodel)

onCommit

private void onCommit()

On commit.

index

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

unIndex

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

search

public Map<String,Object> search(Class<?> clazz,
                                 EntityMetadata m,
                                 String luceneQuery,
                                 int start,
                                 int end)

copy

private void copy(org.apache.lucene.store.Directory src,
                  org.apache.lucene.store.Directory to)
           throws IOException

Throws:

IOException

updateDocument

private void updateDocument(EntityMetadata metadata,
                            MetamodelImpl metaModel,
                            Object entity,
                            String parentId,
                            Class<? extends Object> class1,
                            boolean b)

Updates document.

Parameters:

metadata - the metadata

entity - the object

parentId - the parent id

clazz - the clazz

search

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