org.opennms.web.rest.support

Class CriteriaBuilderSearchVisitor<T,Q>

java.lang.Object

org.apache.cxf.jaxrs.ext.search.visitor.AbstractSearchConditionVisitor<Q,CriteriaBuilder>

org.opennms.web.rest.support.CriteriaBuilderSearchVisitor<T,Q>

Type Parameters:

T - Entity object type (eg. OnmsNode)

Q - Query bean type. In some cases, this will be the same as the entity object type but for complex objects, a specific query bean or the CXF SearchBean may be used instead.

All Implemented Interfaces:

org.apache.cxf.jaxrs.ext.search.SearchConditionVisitor<Q,CriteriaBuilder>

public class CriteriaBuilderSearchVisitor<T,Q>
extends org.apache.cxf.jaxrs.ext.search.visitor.AbstractSearchConditionVisitor<Q,CriteriaBuilder>

This SearchConditionVisitor will convert CXF SearchCondition instances into a Criteria that is suitable for querying one of our DAO interfaces.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.cxf.jaxrs.ext.search.visitor.AbstractSearchConditionVisitor

org.apache.cxf.jaxrs.ext.search.visitor.AbstractSearchConditionVisitor.ClassValue

Field Summary

Fields

Modifier and Type	Field and Description
static Date	NULL_DATE_VALUE Use this value to represent null Date values.
static String	NULL_VALUE Use this value to represent null values.

Constructor Summary

Constructors

Constructor and Description
CriteriaBuilderSearchVisitor(CriteriaBuilder criteriaBuilder, Class<T> clazz) Constructor that just specifies the target class.
CriteriaBuilderSearchVisitor(CriteriaBuilder criteriaBuilder, Class<T> clazz, Map<String,CriteriaBehavior<?>> behaviors) Constructor that specifies the target class and a list of field aliases.

Method Summary

Modifier and Type	Method and Description
CriteriaBuilder	getQuery()
void	visit(org.apache.cxf.jaxrs.ext.search.SearchCondition<Q> sc)

Methods inherited from class org.apache.cxf.jaxrs.ext.search.visitor.AbstractSearchConditionVisitor

getFieldTypeConverter, getPrimitiveFieldClass, getPrimitiveFieldClass, getPrimitiveFieldClass, getRealPropertyName, isWildcardStringMatch, setFieldTypeConverter, setPrimitiveFieldTypeMap, setValidator, setWildcardStringMatch, validatePropertyValue, visitor

Methods inherited from class java.lang.Object

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

Field Detail

NULL_VALUE

public static final String NULL_VALUE

Use this value to represent null values. This will translate into a CriteriaBuilder.isNull(String) or CriteriaBuilder.isNotNull(String) call (depending on the operator).

See Also:

Constant Field Values

NULL_DATE_VALUE

public static final Date NULL_DATE_VALUE

Use this value to represent null Date values. This will translate into a CriteriaBuilder.isNull(String) or CriteriaBuilder.isNotNull(String) call (depending on the operator).

Constructor Detail

CriteriaBuilderSearchVisitor

public CriteriaBuilderSearchVisitor(CriteriaBuilder criteriaBuilder,
                                    Class<T> clazz)

Constructor that just specifies the target class.

CriteriaBuilderSearchVisitor

public CriteriaBuilderSearchVisitor(CriteriaBuilder criteriaBuilder,
                                    Class<T> clazz,
                                    Map<String,CriteriaBehavior<?>> behaviors)

Constructor that specifies the target class and a list of field aliases.

Method Detail

visit

public void visit(org.apache.cxf.jaxrs.ext.search.SearchCondition<Q> sc)

getQuery

public CriteriaBuilder getQuery()