Package com.echothree.model.control.index.server.indexer

Class BaseIndexer<BE extends BaseEntity>

java.lang.Object

com.echothree.util.server.control.BaseLogic

com.echothree.model.control.index.server.indexer.BaseIndexer<BE>

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

ComponentVendorIndexer, ContactMechanismIndexer, ContentCatalogIndexer, ContentCatalogItemIndexer, ContentCategoryIndexer, EntityAliasTypeIndexer, EntityAttributeGroupIndexer, EntityAttributeIndexer, EntityListItemIndexer, EntityTypeIndexer, ForumMessageIndexer, HarmonizedTariffScheduleCodeIndexer, ItemIndexer, OfferIndexer, PartyIndexer, SecurityRoleGroupIndexer, SecurityRoleIndexer, ShippingMethodIndexer, UseIndexer, UseTypeIndexer

public abstract class BaseIndexer<BE extends BaseEntity>
extends BaseLogic
implements Closeable

Field Summary

Fields

Modifier and Type	Field	Description
protected AppearanceControl	appearanceControl
protected ComponentControl	componentControl
protected CoreControl	coreControl
protected ExecutionErrorAccumulator	eea
protected EntityAliasControl	entityAliasControl
protected List<EntityAliasType>	entityAliasTypes
protected List<EntityAttribute>	entityAttributes
protected EntityType	entityType
protected EntityTypeControl	entityTypeControl
protected EventControl	eventControl
protected Index	index
protected IndexControl	indexControl
protected IndexStatus	indexStatus
protected org.apache.lucene.index.IndexWriter	indexWriter
protected Language	language
protected org.apache.commons.logging.Log	log
protected TagControl	tagControl
protected List<TagScope>	tagScopes
protected WorkflowControl	workflowControl

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseIndexer(ExecutionErrorAccumulator eea, Index index)

Method Summary

Modifier and Type	Method	Description
protected void	addEntityInstanceFieldsToDocument(org.apache.lucene.document.Document document, EntityInstance entityInstance)
protected void	addEntityInstanceToDocument(org.apache.lucene.document.Document document, EntityInstance entityInstance, BasePK basePK)
protected void	addEntityToIndex(EntityInstance entityInstance, BE baseEntity)
void	close()
protected void	closeIndexWriter()
protected abstract org.apache.lucene.document.Document	convertToDocument(EntityInstance entityInstance, BE item)
void	forceReindex()
protected org.apache.lucene.analysis.Analyzer	getAnalyzer()
protected abstract BE	getEntity(EntityInstance entityInstance)
EntityType	getEntityType()
Index	getIndex()
protected org.apache.lucene.document.Document	newDocumentWithEntityInstanceFields(EntityInstance entityInstance, BasePK basePK)
void	open()
protected void	openIndexWriter(org.apache.lucene.analysis.Analyzer analyzer)	Create a Lucene IndexWriter.
protected void	removeEntityFromIndex(BE baseEntity)
void	updateIndex(EntityInstance entityInstance)

Methods inherited from class com.echothree.util.server.control.BaseLogic

addExecutionError, addSecurityMessage, getEntityInstanceByBaseEntity, getEntityInstanceByBasePK, getSession, handleExecutionError, handleSecurityMessage, hasExecutionErrors

Methods inherited from class java.lang.Object

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

Field Details

appearanceControl

protected AppearanceControl appearanceControl

coreControl

protected CoreControl coreControl

componentControl

protected ComponentControl componentControl

entityAliasControl

protected EntityAliasControl entityAliasControl

entityTypeControl

protected EntityTypeControl entityTypeControl

eventControl

protected EventControl eventControl

indexControl

protected IndexControl indexControl

tagControl

protected TagControl tagControl

workflowControl

protected WorkflowControl workflowControl

log

protected org.apache.commons.logging.Log log

eea

protected ExecutionErrorAccumulator eea

index

protected Index index

language

protected Language language

entityType

protected EntityType entityType

indexStatus

protected IndexStatus indexStatus

entityAliasTypes

protected List<EntityAliasType> entityAliasTypes

entityAttributes

protected List<EntityAttribute> entityAttributes

tagScopes

protected List<TagScope> tagScopes

indexWriter

protected org.apache.lucene.index.IndexWriter indexWriter

Constructor Details

BaseIndexer

protected BaseIndexer(ExecutionErrorAccumulator eea,
 Index index)

Method Details

getIndex

public Index getIndex()

open

public void open()

getEntityType

public EntityType getEntityType()

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

addEntityInstanceToDocument

protected void addEntityInstanceToDocument(org.apache.lucene.document.Document document,
 EntityInstance entityInstance,
 BasePK basePK)

addEntityInstanceFieldsToDocument

protected void addEntityInstanceFieldsToDocument(org.apache.lucene.document.Document document,
 EntityInstance entityInstance)

newDocumentWithEntityInstanceFields

protected org.apache.lucene.document.Document newDocumentWithEntityInstanceFields(EntityInstance entityInstance,
 BasePK basePK)

openIndexWriter

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

Create a Lucene IndexWriter.

closeIndexWriter

protected void closeIndexWriter()

forceReindex

public void forceReindex()

getAnalyzer

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

getEntity

protected abstract BE getEntity(EntityInstance entityInstance)

convertToDocument

protected abstract org.apache.lucene.document.Document convertToDocument(EntityInstance entityInstance,
 BE item)

addEntityToIndex

protected void addEntityToIndex(EntityInstance entityInstance,
 BE baseEntity)
                         throws IOException

Throws:

IOException

removeEntityFromIndex

protected void removeEntityFromIndex(BE baseEntity)
                              throws IOException

Throws:

IOException

updateIndex

public void updateIndex(EntityInstance entityInstance)