er.indexing

Class ERAutoIndex

java.lang.Object

er.indexing.ERIndex

er.indexing.ERAutoIndex

public class ERAutoIndex
extends ERIndex

   File Documents.indexModel is 
   {
     // index class to use, default is er.indexing.ERIndex
     index = com.foo.SomeIndexClass;
     // url for the index files
     store = "file://tmp/Document";
     // if the index should be double-buffered (currently unused)
     buffered = false|true;
     // entities in this index
     entities = (Asset, File, Media);
     // properties to index, these are key paths off the objects
     // and are also used for the names of the index fields.
     // these don't need to be attributes or relationships
     // but can also be simple methods. In fact, if you have multiple
     // entities in your index, you will need to support a common set of 
     // these properties
     properties = {
         someAttribute = {
             // if the index should be stored
             store = "NO|YES|COMPRESS";
             // if the index is tokenized
             index = "NO|TOKENIZED|UN_TOKENIZED|NO_NORMS";
             // no idea what this does. consult the lucene docs
             termVector = "NO|YES|WITH_POSITIONS|WITH_OFFSETS|WITH_POSITIONS_OFFSETS";
             // which analyzer class to use. For german stuff, you'll
             // use the org.apache.lucene.analysis.de.GermanAnalyzer.
             analyzer = com.foo.SomeAnalyzerClass;
             // optional formater for the value
             format = com.foo.SomeFormatClass;
             // optional number format for the value
             numberformat = "0";
             // optional date format for the value
             dateformat = "yyyy.mm.dd";
         };
         someRelatedObject.name = {...};
         someRelationship.name = {...};
     };
 }

 

Author:

ak

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	ERAutoIndex.AutoTransactionHandler
protected class	ERAutoIndex.Configuration This class encapsulates the index configuration logic and configures this Index from the indexModel file associated with this ERIndex instance.
protected class	ERAutoIndex.ConfigurationEntry

Nested classes/interfaces inherited from class er.indexing.ERIndex

ERIndex.Command, ERIndex.IndexAttribute, ERIndex.IndexDocument, ERIndex.Job, ERIndex.Transaction, ERIndex.TransactionHandler

Field Summary

Fields inherited from class er.indexing.ERIndex

IndexingEndedNotification, IndexingFailedNotification, IndexingStartedNotification, KEY, log

Constructor Summary

Constructors

Constructor and Description
ERAutoIndex(String name, NSDictionary indexDef)

Method Summary

Modifier and Type	Method and Description
protected NSSet	entities()
protected boolean	handlesEntity(String name)
protected boolean	handlesObject(com.webobjects.eocontrol.EOEnterpriseObject eo)
void	reindexAllObjects()

Methods inherited from class er.indexing.ERIndex

addAttribute, addedDocumentsForObjects, addObjectsToIndex, analyzer, attributeNamed, attributeNames, clear, createAttribute, createDocumentForGlobalID, createDocumentForObject, createTerm, deletedTermsForObjects, deleteObjectsFromIndex, documentForGlobalID, documentForId, findDocument, findGlobalIDs, findGlobalIDs, findObjects, findObjects, findObjects, findObjects, findScoreDocs, findTermStringsForPrefix, handler, indexNamed, indexSearcher, name, setStore, setTransactionHandler, terms

Methods inherited from class java.lang.Object

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

Constructor Detail

ERAutoIndex

public ERAutoIndex(String name,
                   NSDictionary indexDef)

Method Detail

entities

protected NSSet entities()

reindexAllObjects

public void reindexAllObjects()

handlesEntity

protected boolean handlesEntity(String name)

handlesObject

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

Overrides:

handlesObject in class ERIndex