Sirius.server.search.searchparameter

Class DefaultSearchParameter

java.lang.Object

Sirius.server.search.searchparameter.DefaultSearchParameter

All Implemented Interfaces:

Serializable, Comparable, SearchParameter

public class DefaultSearchParameter
extends Object
implements SearchParameter, Comparable, Serializable

DOCUMENT ME!

Version:

$Revision$, $Date$

Author:

schlob

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	description
protected boolean	isQueryResult
protected Object	key Creates a new instance of DefaultSearchParameter.
protected int	pos
protected Object	value

Fields inherited from interface Sirius.server.search.searchparameter.SearchParameter

CLASSIDS

Constructor Summary

Constructors

Constructor and Description
DefaultSearchParameter(Object key, Object value, boolean isQueryResult) Creates a new DefaultSearchParameter object.
DefaultSearchParameter(Object key, Object value, boolean isQueryResult, int pos) Creates a new DefaultSearchParameter object.
DefaultSearchParameter(Object key, Object value, boolean isQueryResult, int pos, String description) Creates a new DefaultSearchParameter object.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Object o) //////////////////////////////////////////////////////////////////// can be sorted by query position.
boolean	equals(Object o)
String	getDescription() DOCUMENT ME!
Object	getKey() DOCUMENT ME!
int	getQueryPosition() DOCUMENT ME!
Object	getValue() DOCUMENT ME!
boolean	isQueryResult() DOCUMENT ME!
void	setValue(Object parameter) DOCUMENT ME!
String	toString()
Collection	values() DOCUMENT ME!

Methods inherited from class java.lang.Object

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

Field Detail

key

protected Object key

Creates a new instance of DefaultSearchParameter.

value

protected Object value

isQueryResult

protected boolean isQueryResult

pos

protected int pos

description

protected String description

Constructor Detail

DefaultSearchParameter

public DefaultSearchParameter(Object key,
                              Object value,
                              boolean isQueryResult)

Creates a new DefaultSearchParameter object.

Parameters:

key - DOCUMENT ME!

value - DOCUMENT ME!

isQueryResult - DOCUMENT ME!

DefaultSearchParameter

public DefaultSearchParameter(Object key,
                              Object value,
                              boolean isQueryResult,
                              int pos)

Creates a new DefaultSearchParameter object.

Parameters:

key - DOCUMENT ME!

value - DOCUMENT ME!

isQueryResult - DOCUMENT ME!

pos - DOCUMENT ME!

DefaultSearchParameter

public DefaultSearchParameter(Object key,
                              Object value,
                              boolean isQueryResult,
                              int pos,
                              String description)

Creates a new DefaultSearchParameter object.

Parameters:

key - DOCUMENT ME!

value - DOCUMENT ME!

isQueryResult - DOCUMENT ME!

pos - DOCUMENT ME!

description - DOCUMENT ME!

Method Detail

getKey

public Object getKey()

Description copied from interface: SearchParameter

DOCUMENT ME!

Specified by:

getKey in interface SearchParameter

Returns:

DOCUMENT ME!

getValue

public Object getValue()

Description copied from interface: SearchParameter

DOCUMENT ME!

Specified by:

getValue in interface SearchParameter

Returns:

DOCUMENT ME!

isQueryResult

public boolean isQueryResult()

Description copied from interface: SearchParameter

DOCUMENT ME!

Specified by:

isQueryResult in interface SearchParameter

Returns:

DOCUMENT ME!

setValue

public void setValue(Object parameter)

Description copied from interface: SearchParameter

DOCUMENT ME!

Specified by:

setValue in interface SearchParameter

Parameters:

parameter - DOCUMENT ME!

values

public Collection values()
                  throws Exception

Description copied from interface: SearchParameter

DOCUMENT ME!

Specified by:

values in interface SearchParameter

Returns:

DOCUMENT ME!

Throws:

Exception - DOCUMENT ME!

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getQueryPosition

public int getQueryPosition()

Description copied from interface: SearchParameter

DOCUMENT ME!

Specified by:

getQueryPosition in interface SearchParameter

Returns:

DOCUMENT ME!

compareTo

public int compareTo(Object o)

//////////////////////////////////////////////////////////////////// can be sorted by query position.

Specified by:

compareTo in interface Comparable

Parameters:

o - DOCUMENT ME!

Returns:

DOCUMENT ME!

toString

public String toString()

Overrides:

toString in class Object

getDescription

public String getDescription()

Description copied from interface: SearchParameter

DOCUMENT ME!

Specified by:

getDescription in interface SearchParameter

Returns:

DOCUMENT ME!