org.proteios.core
Class AnnotationInRestriction

java.lang.Object
  org.proteios.core.AnnotationInRestriction

All Implemented Interfaces:

QueryElement, Restriction

public class AnnotationInRestriction
extends Object

Restricts a query using annotation values that exists in a set of given values.

Version:

2.0

Author:

Nicklas

See Also:

Annotations

Last modified

$Date: 2009-04-09 08:48:11 +0200 (Thu, 09 Apr 2009) $

Constructor Summary

AnnotationInRestriction(AnnotationType annotationType, boolean includeInheriting, Object... values)
Create a new annotation restriction.

Method Summary

String

toQl(Query query, DbControl dc) Create a query language string of the query element.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationInRestriction

public AnnotationInRestriction(AnnotationType annotationType,
                               boolean includeInheriting,
                               Object... values)
                        throws InvalidDataException

Create a new annotation restriction.

Parameters:

annotationType - The annotation type to use in the query

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

values - An array of values, each value must be of the correct value type for the annotation as defined by the AnnotationType.getValueType() property

Throws:

InvalidDataException - If any of the parameters are null or the array is empty or not follow the rules above.

Method Detail

toQl

public String toQl(Query query,
                   DbControl dc)
            throws BaseException

Description copied from interface: QueryElement

Create a query language string of the query element. Use the Query.getQueryType() method to find out which query language is wanted in case the element requires different syntax for different languages.

Specified by:

toQl in interface QueryElement

Parameters:

query - The query that is about to be executed

dc - The DbControl object used to execute the query

Throws:

BaseException - If there is any other error