org.apache.cxf.jaxrs.ext.search

Interface SearchContext

All Known Implementing Classes:

SearchContextImpl

public interface SearchContext

Represents the current search expression.

Method Summary

Modifier and Type	Method and Description
<T> SearchCondition<T>	getCondition(Class<T> cls) Returns the typed search condition representing the search expression which is extracted from the request URI
<T> SearchCondition<T>	getCondition(Class<T> cls, Map<String,String> beanProperties) Returns the typed search condition representing the search expression which is extracted from the request URI
<T> SearchCondition<T>	getCondition(Class<T> cls, Map<String,String> beanProperties, Map<String,String> parserProperties) Returns the typed search condition representing the search expression which is extracted from the request URI
<T> SearchCondition<T>	getCondition(String expression, Class<T> cls) Returns the typed search condition representing the provided search expression
<T> SearchCondition<T>	getCondition(String expression, Class<T> cls, Map<String,String> beanProperties) Returns the typed search condition representing the provided search expression
<T> SearchCondition<T>	getCondition(String expression, Class<T> cls, Map<String,String> beanProperties, Map<String,String> parserProperties) Returns the typed search condition representing the provided search expression
String	getSearchExpression() Returns the search expression

Method Detail

getCondition

<T> SearchCondition<T> getCondition(Class<T> cls)

Returns the typed search condition representing the search expression which is extracted from the request URI

Parameters:

cls - the type of the bean(s) the new search condition will attempt to match

Returns:

the search condition

getCondition

<T> SearchCondition<T> getCondition(Class<T> cls,
                                    Map<String,String> beanProperties)

Returns the typed search condition representing the search expression which is extracted from the request URI

Parameters:

cls - the type of the bean(s) the new search condition will attempt to match

beanProperties - mapping between search and bean properties

Returns:

the search condition

getCondition

<T> SearchCondition<T> getCondition(Class<T> cls,
                                    Map<String,String> beanProperties,
                                    Map<String,String> parserProperties)

Returns the typed search condition representing the search expression which is extracted from the request URI

Parameters:

cls - the type of the bean(s) the new search condition will attempt to match

beanProperties - mapping between search and bean properties

parserProperties - parser properties

Returns:

the search condition

getCondition

<T> SearchCondition<T> getCondition(String expression,
                                    Class<T> cls)

Returns the typed search condition representing the provided search expression

Parameters:

expression - the search expression

cls - the type of the bean(s) the new search condition will attempt to match

Returns:

the search condition

getCondition

<T> SearchCondition<T> getCondition(String expression,
                                    Class<T> cls,
                                    Map<String,String> beanProperties)

Returns the typed search condition representing the provided search expression

Parameters:

expression - the search expression

cls - the type of the bean(s) the new search condition will attempt to match

beanProperties - mapping between search and bean properties

Returns:

the search condition

getCondition

<T> SearchCondition<T> getCondition(String expression,
                                    Class<T> cls,
                                    Map<String,String> beanProperties,
                                    Map<String,String> parserProperties)

Returns the typed search condition representing the provided search expression

Parameters:

expression - the search expression

cls - the type of the bean(s) the new search condition will attempt to match

beanProperties - mapping between search and bean properties

parserProperties - parser properties

Returns:

the search condition

getSearchExpression

String getSearchExpression()

Returns the search expression

Returns:

the expression which is extracted from the request URI, can be null