org.proteios.core.query
Class Annotations

java.lang.Object
  org.proteios.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(AnnotationType annotationType, Object lowValue, Object highValue, boolean includeInheriting) Create a restriction that searches for annotations between two given values.
static Restriction	eq(AnnotationType annotationType, Object value, boolean includeInheriting) Create a restriction that searches for annotations equal to a given value.
static Restriction	gt(AnnotationType annotationType, Object value, boolean includeInheriting) Create a restriction that searches for annotations greater than a given value.
static Restriction	gteq(AnnotationType annotationType, Object value, boolean includeInheriting) Create a restriction that searches for annotations greater than or equal to a given value.
static Restriction	in(AnnotationType annotationType, boolean includeInheriting, Object... values) Create a restriction that searches for annotations equal to any value in a list of given values.
static Restriction	like(AnnotationType annotationType, Object value, boolean includeInheriting) Create a restriction that searches for annotations matching a given value.
static Restriction	lt(AnnotationType annotationType, Object value, boolean includeInheriting) Create a restriction that searches for annotations less than a given value.
static Restriction	lteq(AnnotationType annotationType, Object value, boolean includeInheriting) Create a restriction that searches for annotations less than or equal to a given value.
static Restriction	neq(AnnotationType annotationType, Object value, boolean includeInheriting) Create a restriction that searches for annotations not equal to a given value.

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(AnnotationType annotationType,
                             Object value,
                             boolean includeInheriting)
                      throws InvalidDataException

Create a restriction that searches for annotations equal to a given value.

Parameters:

annotationType - The annotation type to search

value - The value to search for

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

Throws:

InvalidDataException

neq

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

Create a restriction that searches for annotations not equal to a given value.

Parameters:

annotationType - The annotation type to search

value - The value to search for

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

Throws:

InvalidDataException

lt

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

Create a restriction that searches for annotations less than a given value.

Parameters:

annotationType - The annotation type to search

value - The value to search for

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

Throws:

InvalidDataException

lteq

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

Create a restriction that searches for annotations less than or equal to a given value.

Parameters:

annotationType - The annotation type to search

value - The value to search for

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

Throws:

InvalidDataException

gt

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

Create a restriction that searches for annotations greater than a given value.

Parameters:

annotationType - The annotation type to search

value - The value to search for

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

Throws:

InvalidDataException

gteq

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

Create a restriction that searches for annotations greater than or equal to a given value.

Parameters:

annotationType - The annotation type to search

value - The value to search for

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

Throws:

InvalidDataException

like

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

Create a restriction that searches for annotations matching a given value.

Parameters:

annotationType - The annotation type to search

value - The value to search for

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

Throws:

InvalidDataException

between

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

Create a restriction that searches for annotations between two given values. If the end values are included or excluded depends on the database.

Parameters:

annotationType - The annotation type to search

lowValue - The lower bound

highValue - The higher bound

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

Throws:

InvalidDataException

in

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

Create a restriction that searches for annotations equal to any value in a list of given values.

Parameters:

annotationType - The annotation type to search

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

values - An array of values

Throws:

InvalidDataException