atg.commerce.search.refinement.admin

Class QueryRefinementConfigurationContainer

java.lang.Object

atg.commerce.search.refinement.admin.QueryRefinementConfigurationContainer

All Implemented Interfaces:

RefinementConfigurationContainer

public class QueryRefinementConfigurationContainer
extends java.lang.Object
implements RefinementConfigurationContainer

An implementation of the RefinementConfigurationContainer interface that uses a query to find a particular refinement configuration item. As an example, the "global" refinement configuration can be found by setting the item descriptor to the refineConfig item descriptor, and the query to (isGlobal = TRUE).

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Constructor Summary

Constructors

Constructor and Description
QueryRefinementConfigurationContainer(RepositoryItemDescriptor pItemDescriptor, Query pQuery, java.lang.String pMappingValue, java.lang.String pName) Create a new refinement configuration container whose item lives in the given item descriptor, and is retrieved by the given query.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object pObject) Test to see if the item descriptor and query matches.
RepositoryItemDescriptor	getItemDescriptor() Gets the item descriptor of the repository item.
java.lang.String	getMappingValue() Get the mapping value for the refinement configuration.
java.lang.String	getName()
Query	getQuery() Get the query used to find the repository item.
RepositoryItem	getRefinementConfigurationItem() Issue the query against the repository item, and return the first item from the result set.
int	hashCode() Return the hashCode of this container.
void	setName(java.lang.String pName)
java.lang.String	toString() Return a string representation of the item descriptor and query.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

QueryRefinementConfigurationContainer

public QueryRefinementConfigurationContainer(RepositoryItemDescriptor pItemDescriptor,
                                     Query pQuery,
                                     java.lang.String pMappingValue,
                                     java.lang.String pName)

Create a new refinement configuration container whose item lives in the given item descriptor, and is retrieved by the given query.

Method Detail

getItemDescriptor

public RepositoryItemDescriptor getItemDescriptor()

Gets the item descriptor of the repository item.

getQuery

public Query getQuery()

Get the query used to find the repository item.

getMappingValue

public java.lang.String getMappingValue()

Get the mapping value for the refinement configuration.

Specified by:

getMappingValue in interface RefinementConfigurationContainer

setName

public void setName(java.lang.String pName)

Specified by:

setName in interface RefinementConfigurationContainer

getName

public java.lang.String getName()

Specified by:

getName in interface RefinementConfigurationContainer

getRefinementConfigurationItem

public RepositoryItem getRefinementConfigurationItem()
                                              throws RepositoryException

Issue the query against the repository item, and return the first item from the result set.

Specified by:

getRefinementConfigurationItem in interface RefinementConfigurationContainer

Throws:

RepositoryException

equals

public boolean equals(java.lang.Object pObject)

Test to see if the item descriptor and query matches.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Return the hashCode of this container.

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Return a string representation of the item descriptor and query.

Overrides:

toString in class java.lang.Object