|
3.0.1: 2011-11-10 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sf.basedb.core.AnnotationRestriction
net.sf.basedb.core.AnnotationBetweenRestriction
public class AnnotationBetweenRestriction
Restricts a query using annotation values between a low and high value.
Annotations
Field Summary | |
---|---|
private Object |
highValue
|
private Object |
lowValue
|
Fields inherited from class net.sf.basedb.core.AnnotationRestriction |
---|
alias, annotationTypeId, includeInheriting, valueType |
Constructor Summary | |
---|---|
AnnotationBetweenRestriction(String alias,
AnnotationType annotationType,
Object lowValue,
Object highValue,
boolean includeInheriting)
Create a new annotation restriction. |
|
AnnotationBetweenRestriction(String alias,
int annotationTypeId,
Type valueType,
Object lowValue,
Object highValue,
boolean includeInheriting)
Create a new annotation restriction. |
Method Summary | |
---|---|
boolean |
equals(Object other)
This restriction is equal to another AnnotationBetweenRestriction if they have the same annotation type, upper and lower bound 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(SQLQuery query)
Set the value for all parameters defined in the SQL fragment returned by AnnotationRestriction.getRestrictionSql(Query, DbControl) . |
String |
toString()
|
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, wait, wait, wait |
Field Detail |
---|
private final Object lowValue
private final Object highValue
Constructor Detail |
---|
public AnnotationBetweenRestriction(String alias, AnnotationType annotationType, Object lowValue, Object highValue, boolean includeInheriting) throws InvalidDataException
alias
- The alias of a joined item where the annotations are
located or null to use the root entity of the queryannotationType
- The annotation type to use in the querylowValue
- The low value to use in the query, it must be of the
correct value type for the annotation as defined by the
AnnotationType.getValueType()
propertyhighValue
- The high value to use in the query, it must be of the
correct value type for the annotation as defined by the
AnnotationType.getValueType()
propertyincludeInheriting
- If items inherting the annotation should be returned
by the query or not
InvalidDataException
- If any of the parameters are null
or not follow the rules above.public AnnotationBetweenRestriction(String alias, int annotationTypeId, Type valueType, Object lowValue, Object highValue, boolean includeInheriting) throws InvalidDataException
alias
- The alias of a joined item where the annotations are
located or null to use the root entity of the queryannotationTypeId
- The id of the annotation type to use in the queryvalueType
- The type of values for annotationslowValue
- The low value to use in the query, it must be of the
correct value type for the annotation as defined by the
valueType propertyhighValue
- The high value to use in the query, it must be of the
correct value type for the annotation as defined by the
valueType propertyincludeInheriting
- If items inherting the annotation should be returned
by the query or not
InvalidDataException
- If any of the parameters are null
or not follow the rules above.Method Detail |
---|
String getRestrictionSql(Query query, DbControl dc) throws BaseException
AnnotationRestriction
v.value = :theValue ThesetRestrictionParameters
method is called to allow the subclass to set the value of the parameters specified in the SQL fragment.
getRestrictionSql
in class AnnotationRestriction
query
- The query object we are about to execute
BaseException
AnnotationRestriction.setRestrictionParameters(SQLQuery)
void setRestrictionParameters(SQLQuery query)
AnnotationRestriction
AnnotationRestriction.getRestrictionSql(Query, DbControl)
.
setRestrictionParameters
in class AnnotationRestriction
query
- The Hibernate SQLQuery
object which is
used to query the databasepublic boolean equals(Object other)
equals
in class Object
public int hashCode()
hashCode
in class AnnotationRestriction
public String toString()
toString
in class Object
|
3.0.1: 2011-11-10 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |