SearchContextImpl (Apache CXF JavaDoc 3.1.0 API)

java.lang.Object
- org.apache.cxf.jaxrs.ext.search.SearchContextImpl

All Implemented Interfaces:: SearchContext

public class SearchContextImpl
extends Object
implements SearchContext

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CUSTOM_SEARCH_PARSER_CLASS_PROPERTY`
`static String`	`CUSTOM_SEARCH_PARSER_PROPERTY`
`static String`	`CUSTOM_SEARCH_QUERY_PARAM_NAME`
`static String`	`SEARCH_QUERY`
`static String`	`SHORT_SEARCH_QUERY`

Constructor Summary

Constructors
Constructor and Description

SearchContextImpl(Message message)

Constructors
Constructor and Description
`SearchContextImpl(Message message)`

Method Summary

Methods
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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SEARCH_QUERY
```
public static final String SEARCH_QUERY
```
    See Also:
    Constant Field Values
  - SHORT_SEARCH_QUERY
```
public static final String SHORT_SEARCH_QUERY
```
    See Also:
    Constant Field Values
  - CUSTOM_SEARCH_PARSER_PROPERTY
```
public static final String CUSTOM_SEARCH_PARSER_PROPERTY
```
    See Also:
    Constant Field Values
  - CUSTOM_SEARCH_PARSER_CLASS_PROPERTY
```
public static final String CUSTOM_SEARCH_PARSER_CLASS_PROPERTY
```
    See Also:
    Constant Field Values
  - CUSTOM_SEARCH_QUERY_PARAM_NAME
```
public static final String CUSTOM_SEARCH_QUERY_PARAM_NAME
```
    See Also:
    Constant Field Values
- Constructor Detail
  - SearchContextImpl
```
public SearchContextImpl(Message message)
```
- Method Detail
  - getCondition
```
public <T> SearchCondition<T> getCondition(Class<T> cls)
```
    Description copied from interface: SearchContext
    
    Returns the typed search condition representing the search expression which is extracted from the request URI
    
    Specified by:
    
    getCondition in interface SearchContext
    
    Parameters:
    cls - the type of the bean(s) the new search condition will attempt to match
    
    Returns:
    the search condition
  - getCondition
```
public <T> SearchCondition<T> getCondition(Class<T> cls,
                                  Map<String,String> beanProperties)
```
    Description copied from interface: SearchContext
    
    Returns the typed search condition representing the search expression which is extracted from the request URI
    
    Specified by:
    
    getCondition in interface SearchContext
    
    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
```
public <T> SearchCondition<T> getCondition(Class<T> cls,
                                  Map<String,String> beanProperties,
                                  Map<String,String> parserProperties)
```
    Description copied from interface: SearchContext
    
    Returns the typed search condition representing the search expression which is extracted from the request URI
    
    Specified by:
    
    getCondition in interface SearchContext
    
    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
```
public <T> SearchCondition<T> getCondition(String expression,
                                  Class<T> cls)
```
    Description copied from interface: SearchContext
    
    Returns the typed search condition representing the provided search expression
    
    Specified by:
    
    getCondition in interface SearchContext
    
    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
```
public <T> SearchCondition<T> getCondition(String expression,
                                  Class<T> cls,
                                  Map<String,String> beanProperties)
```
    Description copied from interface: SearchContext
    
    Returns the typed search condition representing the provided search expression
    
    Specified by:
    
    getCondition in interface SearchContext
    
    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
```
public <T> SearchCondition<T> getCondition(String expression,
                                  Class<T> cls,
                                  Map<String,String> beanProperties,
                                  Map<String,String> parserProperties)
```
    Description copied from interface: SearchContext
    
    Returns the typed search condition representing the provided search expression
    
    Specified by:
    
    getCondition in interface SearchContext
    
    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
```
public String getSearchExpression()
```
    Description copied from interface: SearchContext
    
    Returns the search expression
    
    Specified by:
    
    getSearchExpression in interface SearchContext
    
    Returns:
    the expression which is extracted from the request URI, can be null

Class SearchContextImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SEARCH_QUERY

SHORT_SEARCH_QUERY

CUSTOM_SEARCH_PARSER_PROPERTY

CUSTOM_SEARCH_PARSER_CLASS_PROPERTY

CUSTOM_SEARCH_QUERY_PARAM_NAME

Constructor Detail

SearchContextImpl

Method Detail

getCondition

getCondition

getCondition

getCondition

getCondition

getCondition

getSearchExpression