com.esri.gpt.catalog.search
Class SearchFilterKeyword

java.lang.Object
  com.esri.gpt.catalog.search.SearchFilterKeyword

All Implemented Interfaces:

ISearchFilter, ISearchFilterKeyword, Serializable

public class SearchFilterKeyword
extends Object
implements ISearchFilter, ISearchFilterKeyword

Class representing keyword filter in search.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.esri.gpt.catalog.search.ISearchFilterKeyword

ISearchFilterKeyword.KeySearchTextOptions

Constructor Summary

SearchFilterKeyword()
Instantiates a new search filter keyword.

Method Summary

boolean	equals(Object obj) Checks if two objects are equal.
SearchParameterMap	getParams() Gets parameters.
ISearchFilterKeyword.KeySearchTextOptions	getSearchOptionAsEnum() Gets search option as enum.
String	getSearchText() Gets the search text.
String	getSelectedSearchOption() Gets the selected search option.
int	hashCode() Creates hash code from the content of the object.
boolean	isEquals(Object obj) Checks if object in argument is equal to this
void	reset() Reset.
void	setParams(SearchParameterMap parameterMap) Sets parameters.
void	setSearchOptionAsEnum(ISearchFilterKeyword.KeySearchTextOptions option) Sets search option as enum.
void	setSearchText(String text) Sets the search text.
void	setSelectedSearchOption(String selectedSearchOption) Sets the selected search option.
String	toString() Creates string representation of the object.
void	validate() Tests values and if invalid value is found throws exception.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchFilterKeyword

public SearchFilterKeyword()

Instantiates a new search filter keyword.

Method Detail

getSearchText

public String getSearchText()

Gets the search text.

Specified by:

getSearchText in interface ISearchFilterKeyword

Returns:

the search text (Trimmed, Never Null)

setSearchText

public void setSearchText(String text)

Sets the search text.

Specified by:

setSearchText in interface ISearchFilterKeyword

Parameters:

text - the new search text

getSearchOptionAsEnum

public ISearchFilterKeyword.KeySearchTextOptions getSearchOptionAsEnum()

Gets search option as enum.

Specified by:

getSearchOptionAsEnum in interface ISearchFilterKeyword

Returns:

search option as enum

setSearchOptionAsEnum

public void setSearchOptionAsEnum(ISearchFilterKeyword.KeySearchTextOptions option)

Sets search option as enum.

Specified by:

setSearchOptionAsEnum in interface ISearchFilterKeyword

Parameters:

option - search option as enum

getSelectedSearchOption

public String getSelectedSearchOption()

Gets the selected search option.

Returns:

the selected search option (Trimmed, Never Null, set to "exact" as default)

setSelectedSearchOption

public void setSelectedSearchOption(String selectedSearchOption)

Sets the selected search option.

Parameters:

selectedSearchOption - the new selected search option.

Throws:

IllegalArgumentException - if searchOption is not in KeySearchTextOptions

reset

public void reset()

Reset.

Specified by:

reset in interface ISearchFilter

validate

public void validate()
              throws SearchException

Tests values and if invalid value is found throws exception.

Specified by:

validate in interface ISearchFilter

Throws:

SearchException - the search exception

See Also:

ISearchFilter.validate()

getParams

public SearchParameterMap getParams()

Gets parameters.

Specified by:

getParams in interface ISearchFilter

Returns:

the map of search parameters

See Also:

ISearchFilter.getParams()

setParams

public void setParams(SearchParameterMap parameterMap)

Sets parameters.

Specified by:

setParams in interface ISearchFilter

Parameters:

parameterMap - the map of search parameters

equals

public boolean equals(Object obj)

Checks if two objects are equal.

Overrides:

equals in class Object

Parameters:

obj - object to compare

Returns:

true if both object are equal

isEquals

public boolean isEquals(Object obj)

Checks if object in argument is equal to this

Specified by:

isEquals in interface ISearchFilter

Parameters:

obj -

Returns:

true if equal, false otherwise

hashCode

public int hashCode()

Creates hash code from the content of the object.

Overrides:

hashCode in class Object

Returns:

hash code

toString

public String toString()

Creates string representation of the object.

Overrides:

toString in class Object

Returns:

string representation