Package net.sf.basedb.core.query

Class ReturnClassFilter

java.lang.Object

net.sf.basedb.core.query.ReturnClassFilter

All Implemented Interfaces:

Filter<EntityQuery>

public class ReturnClassFilter
extends Object
implements Filter<EntityQuery>

Filter implementation that checks if the items returned by a EntityQuery are compatible with the specified class. Intended to be used with a conditiona restriction or expression as created by Restrictions.conditionalRestriction(Filter, Restriction, Restriction, boolean) and Expressions.conditionalExpression(Filter, Expression, Expression)

Since:

3.7

Author:

nicklas

Field Summary

Fields

Modifier and Type	Field	Description
private Class<?>	returnClass

Constructor Summary

Constructors

Constructor	Description
ReturnClassFilter(Class<?> returnClass)	Creates a filter that matches the specified item class.

Method Summary

Modifier and Type	Method	Description
boolean	evaluate(EntityQuery query)	Returns TRUE if the EntityQuery.getItemType() returns an item type whose Item.getItemClass() is compatible with the specified class.

Methods inherited from class java.lang.Object

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

Field Details

returnClass

private final Class<?> returnClass

Constructor Details

ReturnClassFilter

public ReturnClassFilter(Class<?> returnClass)

Creates a filter that matches the specified item class.

Method Details

evaluate

public boolean evaluate(EntityQuery query)

Returns TRUE if the EntityQuery.getItemType() returns an item type whose Item.getItemClass() is compatible with the specified class.

Specified by:

evaluate in interface Filter<EntityQuery>

Parameters:

query - The object to evaluate

Returns:

TRUE if the object passes the filter, FALSE otherwise