er.indexing
Class ERIndex

java.lang.Object
  er.indexing.ERIndex

Direct Known Subclasses:

ERAttributeIndex, ERAutoIndex

public class ERIndex
extends java.lang.Object

Nested Class Summary

protected static class	ERIndex.Command
protected class	ERIndex.IndexAttribute
class	ERIndex.IndexDocument
protected class	ERIndex.Job
protected class	ERIndex.Transaction
protected class	ERIndex.TransactionHandler

Field Summary

static java.lang.String	IndexingEndedNotification
static java.lang.String	IndexingFailedNotification
static java.lang.String	IndexingStartedNotification
protected static java.lang.String	KEY
protected org.apache.log4j.Logger	log

Constructor Summary

protected

ERIndex(java.lang.String name)

Method Summary

void	addAttribute(java.lang.String propertyName, com.webobjects.foundation.NSDictionary propertyDefinition)
protected com.webobjects.foundation.NSArray<org.apache.lucene.document.Document>	addedDocumentsForObjects(com.webobjects.foundation.NSArray<? extends com.webobjects.eocontrol.EOEnterpriseObject> objects)
void	addObjectsToIndex(com.webobjects.eocontrol.EOEditingContext ec, com.webobjects.foundation.NSArray<? extends com.webobjects.eocontrol.EOEnterpriseObject> objects)
protected org.apache.lucene.analysis.Analyzer	analyzer()
protected ERIndex.IndexAttribute	attributeNamed(java.lang.String fieldName)
com.webobjects.foundation.NSArray<java.lang.String>	attributeNames()
void	clear()
protected ERIndex.IndexAttribute	createAttribute(java.lang.String propertyName, com.webobjects.foundation.NSDictionary propertyDefinition) Creates a new ERIndex.IndexAttribute and adds it to the attributes dictionary of this Index
ERIndex.IndexDocument	createDocumentForGlobalID(com.webobjects.eocontrol.EOKeyGlobalID globalID)
protected org.apache.lucene.document.Document	createDocumentForObject(com.webobjects.eocontrol.EOEnterpriseObject eo)
protected org.apache.lucene.index.Term	createTerm(com.webobjects.eocontrol.EOEnterpriseObject eo)
protected com.webobjects.foundation.NSArray<org.apache.lucene.index.Term>	deletedTermsForObjects(com.webobjects.foundation.NSArray<? extends com.webobjects.eocontrol.EOEnterpriseObject> objects)
void	deleteObjectsFromIndex(com.webobjects.eocontrol.EOEditingContext ec, com.webobjects.foundation.NSArray<? extends com.webobjects.eocontrol.EOEnterpriseObject> objects)
ERIndex.IndexDocument	documentForGlobalID(com.webobjects.eocontrol.EOKeyGlobalID globalID)
ERDocument	documentForId(int docId, float score)
ERIndex.IndexDocument	findDocument(com.webobjects.eocontrol.EOKeyGlobalID globalID)
com.webobjects.foundation.NSArray<com.webobjects.eocontrol.EOKeyGlobalID>	findGlobalIDs(com.webobjects.eocontrol.EOQualifier qualifier)
com.webobjects.foundation.NSArray<com.webobjects.eocontrol.EOKeyGlobalID>	findGlobalIDs(java.lang.String queryString)
org.apache.lucene.search.Hits	findHits(org.apache.lucene.search.Query query) Deprecated.
com.webobjects.foundation.NSArray<? extends com.webobjects.eocontrol.EOEnterpriseObject>	findObjects(com.webobjects.eocontrol.EOEditingContext ec, com.webobjects.eocontrol.EOQualifier qualifier)
com.webobjects.foundation.NSArray<? extends com.webobjects.eocontrol.EOEnterpriseObject>	findObjects(com.webobjects.eocontrol.EOEditingContext ec, org.apache.lucene.search.Query query)
com.webobjects.foundation.NSArray<? extends com.webobjects.eocontrol.EOEnterpriseObject>	findObjects(com.webobjects.eocontrol.EOEditingContext ec, org.apache.lucene.search.Query query, org.apache.lucene.search.Filter filter, org.apache.lucene.search.Sort sort, int start, int end)
com.webobjects.foundation.NSArray<? extends com.webobjects.eocontrol.EOEnterpriseObject>	findObjects(com.webobjects.eocontrol.EOEditingContext ec, java.lang.String queryString)
org.apache.lucene.search.ScoreDoc[]	findScoreDocs(org.apache.lucene.search.Query query, int hitsPerPage)
com.webobjects.foundation.NSArray<org.apache.lucene.index.Term>	findTerms(org.apache.lucene.search.Query q) Deprecated.
com.webobjects.foundation.NSArray<java.lang.String>	findTermStrings(org.apache.lucene.search.Query q) Deprecated.
com.webobjects.foundation.NSArray<java.lang.String>	findTermStringsForPrefix(java.lang.String field, java.lang.String prefix)
protected ERIndex.TransactionHandler	handler()
protected boolean	handlesObject(com.webobjects.eocontrol.EOEnterpriseObject eo)
static ERIndex	indexNamed(java.lang.String key)
org.apache.lucene.search.IndexSearcher	indexSearcher()
java.lang.String	name()
protected void	setStore(java.lang.String store)
protected void	setTransactionHandler(ERIndex.TransactionHandler handler)
com.webobjects.foundation.NSArray<java.lang.String>	terms(java.lang.String fieldName)

Methods inherited from class java.lang.Object

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

Field Detail

log

protected org.apache.log4j.Logger log

IndexingStartedNotification

public static java.lang.String IndexingStartedNotification

IndexingEndedNotification

public static java.lang.String IndexingEndedNotification

IndexingFailedNotification

public static java.lang.String IndexingFailedNotification

KEY

protected static final java.lang.String KEY

See Also:

Constant Field Values

Constructor Detail

ERIndex

protected ERIndex(java.lang.String name)

Method Detail

addObjectsToIndex

public void addObjectsToIndex(com.webobjects.eocontrol.EOEditingContext ec,
                              com.webobjects.foundation.NSArray<? extends com.webobjects.eocontrol.EOEnterpriseObject> objects)

deleteObjectsFromIndex

public void deleteObjectsFromIndex(com.webobjects.eocontrol.EOEditingContext ec,
                                   com.webobjects.foundation.NSArray<? extends com.webobjects.eocontrol.EOEnterpriseObject> objects)

handler

protected ERIndex.TransactionHandler handler()

setTransactionHandler

protected void setTransactionHandler(ERIndex.TransactionHandler handler)

setStore

protected void setStore(java.lang.String store)

analyzer

protected org.apache.lucene.analysis.Analyzer analyzer()

addAttribute

public void addAttribute(java.lang.String propertyName,
                         com.webobjects.foundation.NSDictionary propertyDefinition)

createAttribute

protected ERIndex.IndexAttribute createAttribute(java.lang.String propertyName,
                                                 com.webobjects.foundation.NSDictionary propertyDefinition)

Creates a new ERIndex.IndexAttribute and adds it to the attributes dictionary of this Index

Parameters:

propertyName -

propertyDefinition -

Returns:

the new ERIndex.IndexAttribute

indexSearcher

public org.apache.lucene.search.IndexSearcher indexSearcher()
                                                     throws org.apache.lucene.index.CorruptIndexException,
                                                            java.io.IOException

Throws:

org.apache.lucene.index.CorruptIndexException

java.io.IOException

name

public java.lang.String name()

attributeNames

public com.webobjects.foundation.NSArray<java.lang.String> attributeNames()

clear

public void clear()

attributeNamed

protected ERIndex.IndexAttribute attributeNamed(java.lang.String fieldName)

handlesObject

protected boolean handlesObject(com.webobjects.eocontrol.EOEnterpriseObject eo)

addedDocumentsForObjects

protected com.webobjects.foundation.NSArray<org.apache.lucene.document.Document> addedDocumentsForObjects(com.webobjects.foundation.NSArray<? extends com.webobjects.eocontrol.EOEnterpriseObject> objects)

createDocumentForObject

protected org.apache.lucene.document.Document createDocumentForObject(com.webobjects.eocontrol.EOEnterpriseObject eo)

deletedTermsForObjects

protected com.webobjects.foundation.NSArray<org.apache.lucene.index.Term> deletedTermsForObjects(com.webobjects.foundation.NSArray<? extends com.webobjects.eocontrol.EOEnterpriseObject> objects)

createTerm

protected org.apache.lucene.index.Term createTerm(com.webobjects.eocontrol.EOEnterpriseObject eo)

findObjects

public com.webobjects.foundation.NSArray<? extends com.webobjects.eocontrol.EOEnterpriseObject> findObjects(com.webobjects.eocontrol.EOEditingContext ec,
                                                                                                            org.apache.lucene.search.Query query,
                                                                                                            org.apache.lucene.search.Filter filter,
                                                                                                            org.apache.lucene.search.Sort sort,
                                                                                                            int start,
                                                                                                            int end)

findObjects

public com.webobjects.foundation.NSArray<? extends com.webobjects.eocontrol.EOEnterpriseObject> findObjects(com.webobjects.eocontrol.EOEditingContext ec,
                                                                                                            org.apache.lucene.search.Query query)

findGlobalIDs

public com.webobjects.foundation.NSArray<com.webobjects.eocontrol.EOKeyGlobalID> findGlobalIDs(java.lang.String queryString)

findGlobalIDs

public com.webobjects.foundation.NSArray<com.webobjects.eocontrol.EOKeyGlobalID> findGlobalIDs(com.webobjects.eocontrol.EOQualifier qualifier)

findScoreDocs

public org.apache.lucene.search.ScoreDoc[] findScoreDocs(org.apache.lucene.search.Query query,
                                                         int hitsPerPage)

findHits

@Deprecated
public org.apache.lucene.search.Hits findHits(org.apache.lucene.search.Query query)

Deprecated.

findTermStringsForPrefix

public com.webobjects.foundation.NSArray<java.lang.String> findTermStringsForPrefix(java.lang.String field,
                                                                                    java.lang.String prefix)

findTerms

@Deprecated
public com.webobjects.foundation.NSArray<org.apache.lucene.index.Term> findTerms(org.apache.lucene.search.Query q)

Deprecated.

findTermStrings

@Deprecated
public com.webobjects.foundation.NSArray<java.lang.String> findTermStrings(org.apache.lucene.search.Query q)

Deprecated.

findDocument

public ERIndex.IndexDocument findDocument(com.webobjects.eocontrol.EOKeyGlobalID globalID)

documentForId

public ERDocument documentForId(int docId,
                                float score)

findObjects

public com.webobjects.foundation.NSArray<? extends com.webobjects.eocontrol.EOEnterpriseObject> findObjects(com.webobjects.eocontrol.EOEditingContext ec,
                                                                                                            com.webobjects.eocontrol.EOQualifier qualifier)

findObjects

public com.webobjects.foundation.NSArray<? extends com.webobjects.eocontrol.EOEnterpriseObject> findObjects(com.webobjects.eocontrol.EOEditingContext ec,
                                                                                                            java.lang.String queryString)

terms

public com.webobjects.foundation.NSArray<java.lang.String> terms(java.lang.String fieldName)

documentForGlobalID

public ERIndex.IndexDocument documentForGlobalID(com.webobjects.eocontrol.EOKeyGlobalID globalID)

createDocumentForGlobalID

public ERIndex.IndexDocument createDocumentForGlobalID(com.webobjects.eocontrol.EOKeyGlobalID globalID)

indexNamed

public static ERIndex indexNamed(java.lang.String key)