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

Class PartyIndexer

java.lang.Object

com.echothree.util.server.control.BaseLogic

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

com.echothree.model.control.party.server.indexer.PartyIndexer

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

CustomerIndexer, EmployeeIndexer, VendorIndexer, WarehouseIndexer

public abstract class PartyIndexer
extends BaseIndexer<Party>

Field Summary

Fields

Modifier and Type	Field	Description
protected String	entityNameIndexField
protected PartyType	partyType

Fields inherited from class com.echothree.model.control.index.server.indexer.BaseIndexer

appearanceControl, componentControl, eea, entityAliasControl, entityAliasTypes, entityAttributes, entityType, entityTypeControl, eventControl, index, indexControl, indexStatus, indexWriter, language, log, tagControl, tagScopes, workflowControl

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

coreControl

Constructor Summary

Constructors

Constructor	Description
PartyIndexer()

Method Summary

Modifier and Type	Method	Description
protected void	addPartyFieldsToDocument(Party party, String entityName, org.apache.lucene.document.Document document)
protected org.apache.lucene.document.Document	convertToDocument(EntityInstance entityInstance, Party party)
protected org.apache.lucene.analysis.Analyzer	getAnalyzer()
protected Party	getEntity(EntityInstance entityInstance)
protected abstract String	getEntityNameFromParty(Party party)	All PartyTypes have their own EntityName in addition to the partyName.
protected BaseIndexer<Party>	setup(ExecutionErrorAccumulator eea, Index index, String partyTypeName, String entityNameIndexField)

Methods inherited from class com.echothree.model.control.index.server.indexer.BaseIndexer

addEntityInstanceFieldsToDocument, addEntityInstanceToDocument, addEntityToIndex, close, closeIndexWriter, forceReindex, getEntityType, getIndex, newDocumentWithEntityInstanceFields, open, openIndexWriter, removeEntityFromIndex, setup, updateIndex

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

partyType

protected PartyType partyType

entityNameIndexField

protected String entityNameIndexField

Constructor Details

PartyIndexer

public PartyIndexer()

Method Details

setup

protected BaseIndexer<Party> setup(ExecutionErrorAccumulator eea,
 Index index,
 String partyTypeName,
 String entityNameIndexField)

getEntity

protected Party getEntity(EntityInstance entityInstance)

Specified by:

getEntity in class BaseIndexer<Party>

getAnalyzer

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

Overrides:

getAnalyzer in class BaseIndexer<Party>

getEntityNameFromParty

protected abstract String getEntityNameFromParty(Party party)

All PartyTypes have their own EntityName in addition to the partyName. If null is returned for this field, it likely indicates that the Party has been deleted before indexing picked it up and it will be ignored.

Parameters:

party - Party to return the EntityName for

Returns:

String with the EntityName, or null if it was not found

addPartyFieldsToDocument

protected void addPartyFieldsToDocument(Party party,
 String entityName,
 org.apache.lucene.document.Document document)

convertToDocument

protected org.apache.lucene.document.Document convertToDocument(EntityInstance entityInstance,
 Party party)

Specified by:

convertToDocument in class BaseIndexer<Party>