Apache CXF API

org.apache.cxf.jaxrs.ext.search.client
Class SearchConditionBuilder

java.lang.Object
  extended by org.apache.cxf.jaxrs.ext.search.client.SearchConditionBuilder
All Implemented Interfaces:
PartialCondition
Direct Known Subclasses:
FiqlSearchConditionBuilder

public abstract class SearchConditionBuilder
extends Object
implements PartialCondition

Builder of client-side search condition string using `fluent interface' style. It helps build create part of URL that will be parsed by server-side counterpart. It is factory of different implementations e.g. for FiqlSearchConditionBuilder, that has FiqlParser on server-side, one can use SearchConditionBuilder.instance("FIQL").

See FiqlSearchConditionBuilder for examples of usage.


Field Summary
static String DEFAULT_LANGUAGE
           
static String FIQL
           
 
Constructor Summary
SearchConditionBuilder()
           
 
Method Summary
static SearchConditionBuilder instance()
          Creates instance of builder.
static SearchConditionBuilder instance(Map<String,String> properties)
          Creates instance of builder with provided properties
static SearchConditionBuilder instance(String language)
          Creates instance of builder for specific language.
static SearchConditionBuilder instance(String language, Map<String,String> properties)
           
abstract  String query()
          Finalize condition construction and build search condition query.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.cxf.jaxrs.ext.search.client.PartialCondition
and, and, is, or, or
 

Field Detail

DEFAULT_LANGUAGE

public static final String DEFAULT_LANGUAGE
See Also:
Constant Field Values

FIQL

public static final String FIQL
See Also:
Constant Field Values
Constructor Detail

SearchConditionBuilder

public SearchConditionBuilder()
Method Detail

instance

public static SearchConditionBuilder instance()
Creates instance of builder.

Returns:
default implementation of builder.

instance

public static SearchConditionBuilder instance(Map<String,String> properties)
Creates instance of builder with provided properties

Parameters:
properties -
Returns:
default implementation of builder.

instance

public static SearchConditionBuilder instance(String language)
Creates instance of builder for specific language.

Parameters:
language - alias of language, case insensitive. If alias is unknown, default FIQL implementation is returned.
Returns:
implementation of expected or default builder.

instance

public static SearchConditionBuilder instance(String language,
                                              Map<String,String> properties)

query

public abstract String query()
Finalize condition construction and build search condition query.


Apache CXF API

Apache CXF