com.hybris.cockpitng.search.data

Class SimpleSearchQueryData

java.lang.Object

com.hybris.cockpitng.search.data.SimpleSearchQueryData

All Implemented Interfaces:

IdentifiableSearchQuery, SearchQueryData

public class SimpleSearchQueryData
extends Object
implements SearchQueryData

DTO for simple search query data

Constructor Summary

Constructors

Constructor and Description
SimpleSearchQueryData(String typeCode)
SimpleSearchQueryData(String typeCode, Collection<SearchAttributeDescriptor> attributes, String textQuery)
SimpleSearchQueryData(String searchQueryText, List<SearchAttributeDescriptor> attributes, String typeCode, SortData sortData, int pageSize)

Method Summary

Modifier and Type	Method and Description
Set<SearchAttributeDescriptor>	getAttributes() Returns set of current search attributes - SearchAttributeDescriptor
String	getAttributeValue(SearchAttributeDescriptor attribute) Returns value for a given attribute i.e.
List<SearchQueryCondition>	getConditions()
ValueComparisonOperator	getGlobalComparisonOperator() Returns global operator i.e.
int	getPageSize() Returns current page size
String	getQueryId()
String	getSearchQueryText()
String	getSearchType() Returns current search type
SortData	getSortData() Returns sort information
ValueComparisonOperator	getValueComparisonOperator(SearchAttributeDescriptor attribute) Returns search operator for given attribute i.e.
boolean	isIncludeSubtypes() Whether subtypes should be taken into account in search resulsts
boolean	isTokenizable()
void	setAttributes(Collection<SearchAttributeDescriptor> attributes)
void	setPageSize(int pageSize)
void	setSearchQueryText(String searchQueryText)
void	setSortData(SortData sortData) Sets given sort data information
void	setValueComparisonOperator(ValueComparisonOperator operator)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hybris.cockpitng.search.data.SearchQueryData

getSelectedFacets

Constructor Detail

SimpleSearchQueryData

public SimpleSearchQueryData(String typeCode)

SimpleSearchQueryData

public SimpleSearchQueryData(String typeCode,
                             Collection<SearchAttributeDescriptor> attributes,
                             String textQuery)

SimpleSearchQueryData

public SimpleSearchQueryData(String searchQueryText,
                             List<SearchAttributeDescriptor> attributes,
                             String typeCode,
                             SortData sortData,
                             int pageSize)

Method Detail

getSearchQueryText

public String getSearchQueryText()

Specified by:

getSearchQueryText in interface SearchQueryData

Returns:

the searchQueryText

setSearchQueryText

public void setSearchQueryText(String searchQueryText)

Parameters:

searchQueryText - the searchQueryText to set

getAttributes

public Set<SearchAttributeDescriptor> getAttributes()

Description copied from interface: SearchQueryData

Returns set of current search attributes - SearchAttributeDescriptor

Specified by:

getAttributes in interface SearchQueryData

Returns:

the attributes

setAttributes

public void setAttributes(Collection<SearchAttributeDescriptor> attributes)

Parameters:

attributes - the attributes to set

getSearchType

public String getSearchType()

Description copied from interface: SearchQueryData

Returns current search type

Specified by:

getSearchType in interface SearchQueryData

Returns:

search type

isIncludeSubtypes

public boolean isIncludeSubtypes()

Description copied from interface: SearchQueryData

Whether subtypes should be taken into account in search resulsts

Specified by:

isIncludeSubtypes in interface SearchQueryData

Returns:

if true all subtypes should be taken into accoutn in search results

getPageSize

public int getPageSize()

Description copied from interface: SearchQueryData

Returns current page size

Specified by:

getPageSize in interface SearchQueryData

Returns:

current page size

setPageSize

public void setPageSize(int pageSize)

Parameters:

pageSize - the pageSize to set

getSortData

public SortData getSortData()

Description copied from interface: SearchQueryData

Returns sort information

Specified by:

getSortData in interface SearchQueryData

Returns:

sort information

setSortData

public void setSortData(SortData sortData)

Description copied from interface: SearchQueryData

Sets given sort data information

Specified by:

setSortData in interface SearchQueryData

Parameters:

sortData - the sort data to set

getValueComparisonOperator

public ValueComparisonOperator getValueComparisonOperator(SearchAttributeDescriptor attribute)

Description copied from interface: SearchQueryData

Returns search operator for given attribute i.e. SearchAttributeDescriptor

Specified by:

getValueComparisonOperator in interface SearchQueryData

Parameters:

attribute - given search attribute

Returns:

appropriate search operator

getAttributeValue

public String getAttributeValue(SearchAttributeDescriptor attribute)

Description copied from interface: SearchQueryData

Returns value for a given attribute i.e. SearchAttributeDescriptor

Specified by:

getAttributeValue in interface SearchQueryData

Parameters:

attribute - given search attribute

Returns:

appropriate search operator

setValueComparisonOperator

public void setValueComparisonOperator(ValueComparisonOperator operator)

Parameters:

operator - the operator to set

isTokenizable

public boolean isTokenizable()

Specified by:

isTokenizable in interface SearchQueryData

Returns:

whether condition value should be tokenized based on special characters and converted to multiple conditions

getConditions

public List<SearchQueryCondition> getConditions()

Specified by:

getConditions in interface SearchQueryData

Returns:

condition collection

getGlobalComparisonOperator

public ValueComparisonOperator getGlobalComparisonOperator()

Description copied from interface: SearchQueryData

Returns global operator i.e. how conditions are connected are ther OR-ed or AND-ed

Specified by:

getGlobalComparisonOperator in interface SearchQueryData

Returns:

global operator

getQueryId

public String getQueryId()

Specified by:

getQueryId in interface IdentifiableSearchQuery

Returns:

identifier of a query. Queries with same identifiers are assumed to perform same request to data source