Package net.sf.basedb.core

Class AnnotationInRestriction

java.lang.Object

net.sf.basedb.core.AnnotationRestriction

net.sf.basedb.core.AnnotationInRestriction

All Implemented Interfaces:

QueryElement, Restriction

public class AnnotationInRestriction
extends AnnotationRestriction

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: 2019-03-12 08:29:06 +0100 (tis, 12 mars 2019) $

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.basedb.core.AnnotationRestriction

AnnotationRestriction.Options

Field Summary

Fields

Modifier and Type	Field	Description
private final List<?>	values

Fields inherited from class net.sf.basedb.core.AnnotationRestriction

alias, annotationTypeId, options, valueType

Constructor Summary

Constructors

Constructor	Description
AnnotationInRestriction(String alias, AnnotationType annotationType, boolean includePrimary, boolean includeInherited, Object... values)	Deprecated. In 3.11, use AnnotationInRestriction(String, AnnotationType, AnnotationRestriction.Options, Object...) instead
AnnotationInRestriction(String alias, AnnotationType annotationType, AnnotationRestriction.Options options, Object... values)	Create a new annotation restriction.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)	This restriction is equal to another AnnotationInRestriction if they have the same annotation type, list of values and inheritance setting.
(package private) String	getRestrictionSql(Query query, DbControl dc)	Get an SQL fragment that includes the actual restriction.
int	hashCode()
(package private) void	setRestrictionParameters(NativeQuery<?> query)	Set the value for all parameters defined in the SQL fragment returned by AnnotationRestriction.getRestrictionSql(Query, DbControl).

Methods inherited from class net.sf.basedb.core.AnnotationRestriction

getChildren, maybeEquals, notAmongSelected, toQl

Methods inherited from class java.lang.Object

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

Field Details

values

private final List<?> values

Constructor Details

AnnotationInRestriction

@Deprecated
public AnnotationInRestriction(String alias,
 AnnotationType annotationType,
 boolean includePrimary,
 boolean includeInherited,
 Object... values)
                        throws InvalidDataException

Deprecated.

In 3.11, use AnnotationInRestriction(String, AnnotationType, AnnotationRestriction.Options, Object...) instead

Throws:

InvalidDataException

Since:

3.5

AnnotationInRestriction

public AnnotationInRestriction(String alias,
 AnnotationType annotationType,
 AnnotationRestriction.Options options,
 Object... values)
                        throws InvalidDataException

Create a new annotation restriction. At least one of includePrimary and includeInheriting must be true.

Parameters:

alias - The alias to use in the restriction.

annotationType - The annotation type to use in the query

options - Options that specify which annotations to consider when searching

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.

Since:

3.11

Method Details

getRestrictionSql

String getRestrictionSql(Query query,
 DbControl dc)
                  throws BaseException

Description copied from class: AnnotationRestriction

Get an SQL fragment that includes the actual restriction. Use 'v.value' to access the annotation value. Avoid including literal values originating from a user, especially strings, since it may lead to security holes unless the values are checked for dangerous characters. Use a parameter placeholder instead. A parameter placeholder is a colon (:) followed by a name. Example:

v.value = :theValue

The setRestrictionParameters method is called to allow the subclass to set the value of the parameters specified in the SQL fragment.

Specified by:

getRestrictionSql in class AnnotationRestriction

Parameters:

query - The query object we are about to execute

Returns:

An SQL fragment, or null if no additional restriction is required

Throws:

BaseException

See Also:

• AnnotationRestriction.setRestrictionParameters(NativeQuery)

setRestrictionParameters

void setRestrictionParameters(NativeQuery<?> query)

Description copied from class: AnnotationRestriction

Set the value for all parameters defined in the SQL fragment returned by AnnotationRestriction.getRestrictionSql(Query, DbControl).

Specified by:

setRestrictionParameters in class AnnotationRestriction

Parameters:

query - The Hibernate SQLQuery object which is used to query the database

equals

public boolean equals(Object other)

This restriction is equal to another AnnotationInRestriction if they have the same annotation type, list of values and inheritance setting.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class AnnotationRestriction