Package com.echothree.model.control.item.server.search

Class ItemSearchEvaluator

java.lang.Object

com.echothree.util.server.control.BaseLogic

com.echothree.model.control.search.server.search.BaseEvaluator

com.echothree.model.control.search.server.search.BaseSearchEvaluator

com.echothree.model.control.item.server.search.ItemSearchEvaluator

public class ItemSearchEvaluator
extends BaseSearchEvaluator

Field Summary

Fields inherited from class com.echothree.model.control.search.server.search.BaseSearchEvaluator

searchSortDirection, searchSortOrder, searchType, searchUseType, session

Fields inherited from class com.echothree.model.control.search.server.search.BaseEvaluator

entityType, field, fields, index, q, query, searchControl, searchDefaultOperator, userVisit

Constructor Summary

Constructors

Constructor	Description
ItemSearchEvaluator(UserVisit userVisit, Language language, SearchType searchType, SearchDefaultOperator searchDefaultOperator, SearchSortOrder searchSortOrder, SearchSortDirection searchSortDirection, SearchUseType searchUseType)	Creates a new instance of ItemSearchEvaluator

Method Summary

Modifier and Type	Method	Description
protected int	countParameters()	Counts the number of search parameters.
protected EntityInstancePKHolder	executeSearch(ExecutionErrorAccumulator eea)
BasicAnalyzer	getAnalyzer(ExecutionErrorAccumulator eea, Language language)
EntityInstancePKHolder	getEntityInstancePKHolderByItemStatusWorkflowStep(WorkflowStep itemStatusWorkflowStep)
EntityInstancePKHolder	getEntityInstancePKHolderByItemType(ItemType itemType)
EntityInstancePKHolder	getEntityInstancePKHolderByItemUseType(ItemUseType itemUseType)
String	getItemNameOrAlias()	Returns the itemNameOrAlias.
WorkflowStep	getItemStatusWorkflowStep()	Returns the itemStatusWorkflowStep.
ItemType	getItemType()	Returns the itemType.
ItemUseType	getItemUseType()	Returns the itemUseType.
org.apache.lucene.search.SortField[]	getSortFields(String searchSortOrderName)
protected boolean	isResultCachable()	Determines if the result of the search may be cached.
void	setItemNameOrAlias(String itemNameOrAlias)	Sets the itemNameOrAlias.
void	setItemStatusWorkflowStep(WorkflowStep itemStatusWorkflowStep)	Sets the itemStatusWorkflowStep.
void	setItemStatusWorkflowSteps(List<WorkflowStep> itemStatusWorkflowSteps)	Sets the itemStatusWorkflowSteps.
void	setItemType(ItemType itemType)	Sets the itemType.
void	setItemUseType(ItemUseType itemUseType)	Sets the itemUseType.

Methods inherited from class com.echothree.model.control.search.server.search.BaseSearchEvaluator

createCachedExecutedSearchResults, createUserVisitSearchResults, execute, executeCachableSearch, executeQuery, getCreatedSince, getEntityInstancePKHolderByCreatedTime, getEntityInstancePKHolderByModifiedTime, getEntityInstancePKHolderFromQuery, getEntityInstancePKHolderFromQuery, getModifiedSince, getSearchSortOrderName, getSize, getSoundex, removeUserVisitSearch, setCreatedSince, setModifiedSince

Methods inherited from class com.echothree.model.control.search.server.search.BaseEvaluator

getCachedAnalyzer, getCoreControl, getField, getFields, getIndexControl, getLanguage, getLanguageIsoName, getLog, getQ, getSearchDefaultOperatorName, getUserControl, parseQuery, setField, setFields, setQ

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

Constructor Details

ItemSearchEvaluator

public ItemSearchEvaluator(UserVisit userVisit,
 Language language,
 SearchType searchType,
 SearchDefaultOperator searchDefaultOperator,
 SearchSortOrder searchSortOrder,
 SearchSortDirection searchSortDirection,
 SearchUseType searchUseType)

Creates a new instance of ItemSearchEvaluator

Method Details

countParameters

protected int countParameters()

Counts the number of search parameters.

Overrides:

countParameters in class BaseSearchEvaluator

isResultCachable

protected boolean isResultCachable()

Determines if the result of the search may be cached. For Items, the only field that may be used is the description, "q." If any others are utilized, the result may not be cached.

Overrides:

isResultCachable in class BaseSearchEvaluator

getEntityInstancePKHolderByItemType

public EntityInstancePKHolder getEntityInstancePKHolderByItemType(ItemType itemType)

getEntityInstancePKHolderByItemUseType

public EntityInstancePKHolder getEntityInstancePKHolderByItemUseType(ItemUseType itemUseType)

getEntityInstancePKHolderByItemStatusWorkflowStep

public EntityInstancePKHolder getEntityInstancePKHolderByItemStatusWorkflowStep(WorkflowStep itemStatusWorkflowStep)

getItemNameOrAlias

public String getItemNameOrAlias()

Returns the itemNameOrAlias.

Returns:

the itemNameOrAlias

setItemNameOrAlias

public void setItemNameOrAlias(String itemNameOrAlias)

Sets the itemNameOrAlias.

Parameters:

itemNameOrAlias - the itemNameOrAlias to set

getItemType

public ItemType getItemType()

Returns the itemType.

Returns:

the itemType

setItemType

public void setItemType(ItemType itemType)

Sets the itemType.

Parameters:

itemType - the itemType to set

getItemUseType

public ItemUseType getItemUseType()

Returns the itemUseType.

Returns:

the itemUseType

setItemUseType

public void setItemUseType(ItemUseType itemUseType)

Sets the itemUseType.

Parameters:

itemUseType - the itemUseType to set

getItemStatusWorkflowStep

public WorkflowStep getItemStatusWorkflowStep()

Returns the itemStatusWorkflowStep.

Returns:

the itemStatusWorkflowStep

setItemStatusWorkflowStep

public void setItemStatusWorkflowStep(WorkflowStep itemStatusWorkflowStep)

Sets the itemStatusWorkflowStep.

Parameters:

itemStatusWorkflowStep - the itemStatusWorkflowStep to set

setItemStatusWorkflowSteps

public void setItemStatusWorkflowSteps(List<WorkflowStep> itemStatusWorkflowSteps)

Sets the itemStatusWorkflowSteps.

Parameters:

itemStatusWorkflowSteps - the itemStatusWorkflowSteps to set

getSortFields

public org.apache.lucene.search.SortField[] getSortFields(String searchSortOrderName)

Overrides:

getSortFields in class BaseSearchEvaluator

getAnalyzer

public BasicAnalyzer getAnalyzer(ExecutionErrorAccumulator eea,
 Language language)

Overrides:

getAnalyzer in class BaseEvaluator

executeSearch

protected EntityInstancePKHolder executeSearch(ExecutionErrorAccumulator eea)

Overrides:

executeSearch in class BaseSearchEvaluator