com.tridion.smarttarget.entitymodel.query.location.criteria

Class SearchCriterion

java.lang.Object

com.tridion.smarttarget.entitymodel.query.location.criteria.Criterion

com.tridion.smarttarget.entitymodel.query.location.criteria.SearchCriterion

All Implemented Interfaces:

Serializable

public class SearchCriterion
extends Criterion

Class that models search criteria, i.e. those criteria that have a string representation of the form /$s=searchPhrase[;t=profile][;p=pass], where [...] denotes an optional string.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.tridion.smarttarget.entitymodel.query.location.criteria.Criterion

Criterion.Operator

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAMETER_SEPARATOR The string that separates parameters in the string representation of search criteria.
static String	PASS_PARAMETER Prefix that announces the search pass ID in the string representation of search criteria.
static String	PROFILE_PARAMETER Prefix that announces the search profile ID in the string representation of search criteria.
static String	SEARCH_PREFIX Prefix that announces the search phrase in the string representation of search criteria.

Fields inherited from class com.tridion.smarttarget.entitymodel.query.location.criteria.Criterion

NEGATION

Constructor Summary

Constructors

Constructor and Description
SearchCriterion(String phrase) Creates SearchCriterion with the given search phrase and with a profile or pass ID.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getPassId() Returns the search pass ID, if any.
String	getProfile() Returns the search profile ID, if any.
String	getSearchPhrase() Returns the search phrase.
int	hashCode()
SearchCriterion	setPassId(String passIdParam) Sets the search pass ID.
SearchCriterion	setProfile(String profileIdParam) Sets the search profile ID.
SearchCriterion	setSearchPhrase(String phraseParam) Sets the search phrase for this criterion.
void	toLocation(StringBuilder builder) Appends the string representation of this criterion to the given StringBuilder.

Methods inherited from class com.tridion.smarttarget.entitymodel.query.location.criteria.Criterion

getAttributeName, toLocation, toString

Methods inherited from class java.lang.Object

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

Field Detail

SEARCH_PREFIX

public static final String SEARCH_PREFIX

Prefix that announces the search phrase in the string representation of search criteria.

See Also:

Constant Field Values

PROFILE_PARAMETER

public static final String PROFILE_PARAMETER

Prefix that announces the search profile ID in the string representation of search criteria.

See Also:

Constant Field Values

PASS_PARAMETER

public static final String PASS_PARAMETER

Prefix that announces the search pass ID in the string representation of search criteria.

See Also:

Constant Field Values

PARAMETER_SEPARATOR

public static final String PARAMETER_SEPARATOR

The string that separates parameters in the string representation of search criteria.

See Also:

Constant Field Values

Constructor Detail

SearchCriterion

public SearchCriterion(String phrase)

Creates SearchCriterion with the given search phrase and with a profile or pass ID.

Parameters:

phrase - The search phrase.

Method Detail

setSearchPhrase

public SearchCriterion setSearchPhrase(String phraseParam)

Sets the search phrase for this criterion.

Parameters:

phraseParam - The (new) search phrase for this criterion.

Returns:

This SearchCriterion instance; useful for chained manipulations.

Throws:

IllegalArgumentException - If phrase is null.

See Also:

getSearchPhrase()

getSearchPhrase

public String getSearchPhrase()

Returns the search phrase.

Returns:

Returns the search phrase set in this SearchCriterion.

See Also:

setSearchPhrase(String)

setProfile

public SearchCriterion setProfile(String profileIdParam)

Sets the search profile ID.

Parameters:

profileIdParam - The (new) search profile ID for this criterion; may be null.

Returns:

This SearchCriterion instance; useful for chained manipulations.

See Also:

getProfile()

getProfile

public String getProfile()

Returns the search profile ID, if any.

Returns:

Returns the search profile ID set in this SearchCriterion , if any; null otherwise.

See Also:

setProfile(String)

setPassId

public SearchCriterion setPassId(String passIdParam)

Sets the search pass ID.

Parameters:

passIdParam - The (new) search pass ID for this criterion; may be null.

Returns:

This SearchCriterion instance; useful for chained manipulations.

See Also:

getPassId()

getPassId

public String getPassId()

Returns the search pass ID, if any.

Returns:

Returns the search pass ID set in this SearchCriterion, if any; null otherwise.

See Also:

setPassId(String)

toLocation

public void toLocation(StringBuilder builder)

Appends the string representation of this criterion to the given StringBuilder.

The general contract of this method is that if the StringBuilder contains a valid location ending in a forward slash string prior to invocation of this method, then its contents must also form a valid location string upon completion of this method.

Important: this method will not itself insert a leading slash!

Specified by:

toLocation in class Criterion

Parameters:

builder - The StringBuilder to which the string representation of this criterion is to be appended.

hashCode

public int hashCode()

Overrides:

hashCode in class Criterion

equals

public boolean equals(Object o)

Overrides:

equals in class Criterion