net.sf.basedb.core.query
Class Annotations

java.lang.Object
  net.sf.basedb.core.query.Annotations

public class Annotations
extends Object

A factory class to create restrictions based on annotation values.

Version:

2.0

Author:

Nicklas

Constructor Summary

Annotations()

Method Summary

static Restriction	between(String alias, AnnotationType annotationType, Object lowValue, Object highValue, boolean includeInheriting) Create a restriction that searches for annotations between two given values on the root or a joined entity of a query.
static Restriction	eq(String alias, AnnotationType annotationType, Object value, boolean includeInheriting) Create a restriction that searches for annotations equal to a given value on the root or a joined entity of a query.
static Restriction	gt(String alias, AnnotationType annotationType, Object value, boolean includeInheriting) Create a restriction that searches for annotations greater than a given value on the root or a joined entity of a query.
static Restriction	gteq(String alias, AnnotationType annotationType, Object value, boolean includeInheriting) Create a restriction that searches for annotations greater than or equal to a given value on the root or a joined entity of a query.
static Restriction	in(String alias, AnnotationType annotationType, boolean includeInheriting, Object... values) Create a restriction that searches for annotations on the root or a joined entity equal to any value in a list of given values.
static Restriction	like(String alias, AnnotationType annotationType, Object value, boolean includeInheriting) Create a restriction that searches for annotations matching a given value on the root or a joined entity of a query.
static Restriction	lt(String alias, AnnotationType annotationType, Object value, boolean includeInheriting) Create a restriction that searches for annotations less than a given value on the root or a joined entity of a query.
static Restriction	lteq(String alias, AnnotationType annotationType, Object value, boolean includeInheriting) Create a restriction that searches for annotations less than or equal to a given value on the root or a joined entity of a query.
static Restriction	neq(String alias, AnnotationType annotationType, Object value, boolean includeInheriting) Create a restriction that searches for annotations not equal to a given value on the root or a joined entity of a query.

Methods inherited from class java.lang.Object

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

Constructor Detail

Annotations

public Annotations()

Method Detail

eq

public static Restriction eq(String alias,
                             AnnotationType annotationType,
                             Object value,
                             boolean includeInheriting)
                      throws InvalidDataException

Create a restriction that searches for annotations equal to a given value on the root or a joined entity of a query.

Parameters:

alias - The alias of the joined entity or null to use the root element

annotationType - The annotation type to search. Can not be null.

value - The value to search for. Can not be null.

includeInheriting - If items inheriting the annotation should be returned by the query or not

Returns:

A restriction on annotations.

Throws:

InvalidDataException - If annotationType or value are null.

Since:

2.4

neq

public static Restriction neq(String alias,
                              AnnotationType annotationType,
                              Object value,
                              boolean includeInheriting)
                       throws InvalidDataException

Create a restriction that searches for annotations not equal to a given value on the root or a joined entity of a query.

Parameters:

alias - The alias of the joined entity or null to use the root element

annotationType - The annotation type to search. Can not be null.

value - The value to search for. Can not be null.

includeInheriting - If items inheriting the annotation should be returned by the query or not

Returns:

A restrictions to use for annotations.

Throws:

InvalidDataException - If annotationType or value are null.

Since:

2.4

lt

public static Restriction lt(String alias,
                             AnnotationType annotationType,
                             Object value,
                             boolean includeInheriting)
                      throws InvalidDataException

Create a restriction that searches for annotations less than a given value on the root or a joined entity of a query.

Parameters:

alias - The alias of the joined entity or null to use the root element

annotationType - The annotation type to search. Can not be null.

value - The value to search for. Can not be null.

includeInheriting - If items inheriting the annotation should be returned by the query or not

Returns:

A restriction on annotations.

Throws:

InvalidDataException - If annotationType parameter or value parameter are null.

Since:

2.4

lteq

public static Restriction lteq(String alias,
                               AnnotationType annotationType,
                               Object value,
                               boolean includeInheriting)
                        throws InvalidDataException

Create a restriction that searches for annotations less than or equal to a given value on the root or a joined entity of a query.

Parameters:

alias - The alias of the joined entity or null to use the root element

annotationType - The annotation type to search. Can not be null.

value - The value to search for. Can not be null.

includeInheriting - If items inheriting the annotation should be returned by the query or not

Returns:

A restriction on annotations.

Throws:

InvalidDataException - If annotationType parameter or value parameter are null.

Since:

2.4

gt

public static Restriction gt(String alias,
                             AnnotationType annotationType,
                             Object value,
                             boolean includeInheriting)
                      throws InvalidDataException

Create a restriction that searches for annotations greater than a given value on the root or a joined entity of a query.

Parameters:

alias - The alias of the joined entity or null to use the root element

annotationType - The annotation type to search. Can not be null.

value - The value to search for. Can not be null.

includeInheriting - If items inheriting the annotation should be returned by the query or not

Returns:

A restriction on annotations.

Throws:

InvalidDataException - If annotationType parameter or value parameter are null.

Since:

2.4

gteq

public static Restriction gteq(String alias,
                               AnnotationType annotationType,
                               Object value,
                               boolean includeInheriting)
                        throws InvalidDataException

Create a restriction that searches for annotations greater than or equal to a given value on the root or a joined entity of a query.

Parameters:

alias - The alias of the joined entity or null to use the root element

annotationType - The annotation type to search. Can not be null.

value - The value to search for. Can not be null.

includeInheriting - If items inheriting the annotation should be returned by the query or not

Returns:

A restriction on on annotations.

Throws:

InvalidDataException - If annotationType parameter or value parameter are null.

Since:

2.4

like

public static Restriction like(String alias,
                               AnnotationType annotationType,
                               Object value,
                               boolean includeInheriting)
                        throws InvalidDataException

Create a restriction that searches for annotations matching a given value on the root or a joined entity of a query.

Parameters:

alias - The alias of the joined entity or null to use the root element

annotationType - The annotation type to search. Can not be null.

value - The value to search for. Can not be null.

includeInheriting - If items inheriting the annotation should be returned by the query or not

Returns:

A restriction on annotations.

Throws:

InvalidDataException - If annotationType parameter or value parameter are null.

Since:

2.4

between

public static Restriction between(String alias,
                                  AnnotationType annotationType,
                                  Object lowValue,
                                  Object highValue,
                                  boolean includeInheriting)
                           throws InvalidDataException

Create a restriction that searches for annotations between two given values on the root or a joined entity of a query. The low/high values are included.

Parameters:

alias - The alias of the joined entity or null to use the root element

annotationType - The annotation type to search. Can not be null.

lowValue - The lower bound. Can not be null.

highValue - The higher bound. Can not be null.

includeInheriting - If items inheriting the annotation should be returned by the query or not

Returns:

A restriction on annotations.

Throws:

InvalidDataException - If any of the required parameters are null.

Since:

2.4, 3.0 (specified that low/high values are included)

in

public static Restriction in(String alias,
                             AnnotationType annotationType,
                             boolean includeInheriting,
                             Object... values)
                      throws InvalidDataException

Create a restriction that searches for annotations on the root or a joined entity equal to any value in a list of given values.

Parameters:

alias - The alias of the joined entity or null to use the root element

annotationType - The annotation type to search. Can not be null.

includeInheriting - If items inheriting the annotation should be returned by the query or not

values - An array of values. Can not be null.

Returns:

A restriction on annotations.

Throws:

InvalidDataException - If annotationType parameter or values parameter are null

Since:

2.4