org.hippoecm.hst.content.beans.query.builder

Class FieldConstraintBuilder

java.lang.Object

org.hippoecm.hst.content.beans.query.builder.ConstraintBuilder

org.hippoecm.hst.content.beans.query.builder.FieldConstraintBuilder

public class FieldConstraintBuilder
extends ConstraintBuilder

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FieldConstraintBuilder(String fieldName)

Method Summary

Modifier and Type	Method and Description
Constraint	between(Calendar start, Calendar end, DateTools.Resolution dateResolution) Adds a FAST DATE RANGE constraint that the Calendar value for fieldAttributeName is between start and end (boundaries included) BASED ON the granularity resolution.
Constraint	between(Object value1, Object value2) Adds a constraint that the value fieldAttributeName is between value1 and value2 (boundaries included).
Constraint	contains(String value) Adds a fulltext search to this Filter.
Constraint	equalTo(Calendar value, DateTools.Resolution dateResolution) Adds a constraint that the Calendar value for fieldAttributeName rounded to its resolution is equal to the rounded value for calendar.
Constraint	equalTo(Object value) Adds a constraint that the value fieldAttributeName is equal to value
Constraint	equalToCaseInsensitive(String value) Case insensitive testing of fieldAttributeName for some value.
Constraint	exists() Add a constraint that the result does have the property fieldAttributeName, regardless its value
Constraint	greaterOrEqualThan(Calendar value, DateTools.Resolution dateResolution) note: supported resolutions are DateTools.Resolution.YEAR, DateTools.Resolution.MONTH, DateTools.Resolution.DAY or DateTools.Resolution.HOUR
Constraint	greaterOrEqualThan(Object value) Adds a constraint that the value fieldAttributeName is greater than or equal to value
Constraint	greaterThan(Calendar value, DateTools.Resolution dateResolution) note: supported resolutions are DateTools.Resolution.YEAR, DateTools.Resolution.MONTH, DateTools.Resolution.DAY or DateTools.Resolution.HOUR
Constraint	greaterThan(Object value) Adds a constraint that the value fieldAttributeName is greater than value
Constraint	jcrExpression(String value) Adds the xpath jcrExpression as constraint.
Constraint	lessOrEqualThan(Calendar value, DateTools.Resolution dateResolution) note: supported resolutions are DateTools.Resolution.YEAR, DateTools.Resolution.MONTH, DateTools.Resolution.DAY or DateTools.Resolution.HOUR
Constraint	lessOrEqualThan(Object value) Adds a constraint that the value fieldAttributeName is less than or equal to value
Constraint	lessThan(Calendar value, DateTools.Resolution dateResolution) note: supported resolutions are DateTools.Resolution.YEAR, DateTools.Resolution.MONTH, DateTools.Resolution.DAY or DateTools.Resolution.HOUR
Constraint	lessThan(Object value) Adds a constraint that the value fieldAttributeName is less than value
Constraint	like(String value) This function is based on the LIKE predicate found in SQL.
Constraint	notBetween(Calendar start, Calendar end, DateTools.Resolution dateResolution) note: supported resolutions are DateTools.Resolution.YEAR, DateTools.Resolution.MONTH, DateTools.Resolution.DAY or DateTools.Resolution.HOUR
Constraint	notBetween(Object value1, Object value2) Adds a constraint that the value fieldAttributeName is NOT between value1 and value2, including NOT value1 and value2
Constraint	notContains(String value) The negated version of ConstraintBuilder.contains(String)
Constraint	notEqualTo(Calendar value, DateTools.Resolution dateResolution) Case insensitive testing of fieldAttributeName for some value.
Constraint	notEqualTo(Object value) Adds a constraint that the value fieldAttributeName is NOT equal to value
Constraint	notEqualToCaseInsensitive(String value) note: supported resolutions are DateTools.Resolution.YEAR, DateTools.Resolution.MONTH, DateTools.Resolution.DAY or DateTools.Resolution.HOUR
Constraint	notExists() Add a constraint that the result does NOT have the property fieldAttributeName
Constraint	notLike(String value)

Methods inherited from class org.hippoecm.hst.content.beans.query.builder.ConstraintBuilder

and, constraint, or

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldConstraintBuilder

protected FieldConstraintBuilder(String fieldName)

Method Detail

equalTo

public Constraint equalTo(Object value)

Description copied from class: ConstraintBuilder

Adds a constraint that the value fieldAttributeName is equal to value

Specified by:

equalTo in class ConstraintBuilder

Parameters:

value - object that must be of type String, Boolean, Long, Double, Calendar or Date. If the parameter value is null, this ConstraintBuilder is ignored (unless another constraint method is invoked without null value.

Returns:

this Constraint

equalTo

public Constraint equalTo(Calendar value,
                          DateTools.Resolution dateResolution)

Description copied from class: ConstraintBuilder

Adds a constraint that the Calendar value for fieldAttributeName rounded to its resolution is equal to the rounded value for calendar. Thus assume the Resolution is equal to Resolution.DAY, then all nodes/documents where the property fieldAttributeName as a Calendar value with the same date rounded to days (eg 20130128) has the same value as calendar rounded to days, will match.

supported resolutions are DateTools.Resolution.YEAR, DateTools.Resolution.MONTH, DateTools.Resolution.DAY or DateTools.Resolution.HOUR

Specified by:

equalTo in class ConstraintBuilder

Parameters:

value - The Calendar value constraint that the results should be equal to. If the parameter value is null, this ConstraintBuilder is ignored (unless another constraint method is invoked without null value.

dateResolution - the resolution to use to compare dates. The higher the Resolution (year is highest) the better the performance. supported resolutions are DateTools.Resolution.YEAR, DateTools.Resolution.MONTH, DateTools.Resolution.DAY or DateTools.Resolution.HOUR

Returns:

this Constraint

equalToCaseInsensitive

public Constraint equalToCaseInsensitive(String value)

Description copied from class: ConstraintBuilder

Case insensitive testing of fieldAttributeName for some value.

Specified by:

equalToCaseInsensitive in class ConstraintBuilder

Parameters:

value - object that must be of type String, Boolean, Long, Double, Calendar or Date. If the parameter value is null, this ConstraintBuilder is ignored (unless another constraint method is invoked without null value.

Returns:

this Constraint

See Also:

same as equalTo(Object) only now the equality is checked case insensitive and the value can only be of type String

notEqualTo

public Constraint notEqualTo(Object value)

Description copied from class: ConstraintBuilder

Adds a constraint that the value fieldAttributeName is NOT equal to value

Specified by:

notEqualTo in class ConstraintBuilder

Parameters:

value - object that must be of type String, Boolean, Long, Double, Calendar or Date. If the parameter value is null, this ConstraintBuilder is ignored (unless another constraint method is invoked without null value.

Returns:

this Constraint

notEqualTo

public Constraint notEqualTo(Calendar value,
                             DateTools.Resolution dateResolution)

Description copied from class: ConstraintBuilder

Case insensitive testing of fieldAttributeName for some value.

Specified by:

notEqualTo in class ConstraintBuilder

Returns:

this Constraint

See Also:

same as notEqualTo(Object) only now the inequality is checked case insensitive and the value can only be of type {@link Calendar}

notEqualToCaseInsensitive

public Constraint notEqualToCaseInsensitive(String value)

Description copied from class: ConstraintBuilder

note: supported resolutions are DateTools.Resolution.YEAR, DateTools.Resolution.MONTH, DateTools.Resolution.DAY or DateTools.Resolution.HOUR

Specified by:

notEqualToCaseInsensitive in class ConstraintBuilder

Parameters:

value - object that must be of type String, Boolean, Long, Double, Calendar or Date. If the parameter value is null, this ConstraintBuilder is ignored (unless another constraint method is invoked without null value.

Returns:

this Constraint

See Also:

equalTo(java.util.Calendar, DateTools.Resolution) only now negated

greaterOrEqualThan

public Constraint greaterOrEqualThan(Object value)

Description copied from class: ConstraintBuilder

Adds a constraint that the value fieldAttributeName is greater than or equal to value

note that for range queries on calendar/date instances where the granularity of, say Day, is enough, you should use ConstraintBuilder.greaterOrEqualThan(java.util.Calendar, DateTools.Resolution) with the highest resolution that is acceptable for your use case, as this performs much better, OR make sure that your application runs with a default resolution set to for example 'day'

Specified by:

greaterOrEqualThan in class ConstraintBuilder

Parameters:

value - object that must be of type String, Boolean, Long, Double, Calendar or Date. If the parameter value is null, this ConstraintBuilder is ignored (unless another constraint method is invoked without null value.

Returns:

this Constraint

greaterOrEqualThan

public Constraint greaterOrEqualThan(Calendar value,
                                     DateTools.Resolution dateResolution)

Description copied from class: ConstraintBuilder

note: supported resolutions are DateTools.Resolution.YEAR, DateTools.Resolution.MONTH, DateTools.Resolution.DAY or DateTools.Resolution.HOUR

Specified by:

greaterOrEqualThan in class ConstraintBuilder

Parameters:

value - Calendar object. If the parameter value is null, this ConstraintBuilder is ignored (unless another constraint method is invoked without null value.

dateResolution - the resolution to use to compare dates. The higher the Resolution (year is highest) the better the performance. supported resolutions are DateTools.Resolution.YEAR, DateTools.Resolution.MONTH, DateTools.Resolution.DAY or DateTools.Resolution.HOUR

Returns:

this Constraint

See Also:

between(java.util.Calendar, java.util.Calendar, DateTools.Resolution) but now no upper bound

greaterThan

public Constraint greaterThan(Object value)

Description copied from class: ConstraintBuilder

Adds a constraint that the value fieldAttributeName is greater than value

note that for range queries on calendar/date instances where the granularity of, say Day, is enough, you should use ConstraintBuilder.greaterThan(java.util.Calendar, org.hippoecm.repository.util.DateTools.Resolution) with the highest resolution that is acceptable for your use case, as this performs much better, OR make sure that your application runs with a default resolution set to for example 'day'

Specified by:

greaterThan in class ConstraintBuilder

Parameters:

value - object that must be of type String, Boolean, Long, Double, Calendar or Date. If the parameter value is null, this ConstraintBuilder is ignored (unless another constraint method is invoked without null value.

Returns:

this Constraint

greaterThan

public Constraint greaterThan(Calendar value,
                              DateTools.Resolution dateResolution)

Description copied from class: ConstraintBuilder

note: supported resolutions are DateTools.Resolution.YEAR, DateTools.Resolution.MONTH, DateTools.Resolution.DAY or DateTools.Resolution.HOUR

Specified by:

greaterThan in class ConstraintBuilder

Parameters:

value - Calendar object. If the parameter value is null, this ConstraintBuilder is ignored (unless another constraint method is invoked without null value.

dateResolution - the resolution to use to compare dates. The higher the Resolution (year is highest) the better the performance. supported resolutions are DateTools.Resolution.YEAR, DateTools.Resolution.MONTH, DateTools.Resolution.DAY or DateTools.Resolution.HOUR

Returns:

this Constraint

See Also:

between(java.util.Calendar, java.util.Calendar, DateTools.Resolution) but now no upper bound and lower bound not included

lessOrEqualThan

public Constraint lessOrEqualThan(Object value)

Description copied from class: ConstraintBuilder

Adds a constraint that the value fieldAttributeName is less than or equal to value

note that for range queries on calendar/date instances where the granularity of, say Day, is enough, you should use ConstraintBuilder.lessOrEqualThan(java.util.Calendar, org.hippoecm.repository.util.DateTools.Resolution) with the highest resolution that is acceptable for your use case, as this performs much better, OR make sure that your application runs with a default resolution set to for example 'day'

Specified by:

lessOrEqualThan in class ConstraintBuilder

Parameters:

value - object that must be of type String, Boolean, Long, Double, Calendar or Date. If the parameter value is null, this ConstraintBuilder is ignored (unless another constraint method is invoked without null value.

Returns:

this Constraint

lessOrEqualThan

public Constraint lessOrEqualThan(Calendar value,
                                  DateTools.Resolution dateResolution)

Description copied from class: ConstraintBuilder

note: supported resolutions are DateTools.Resolution.YEAR, DateTools.Resolution.MONTH, DateTools.Resolution.DAY or DateTools.Resolution.HOUR

Specified by:

lessOrEqualThan in class ConstraintBuilder

Returns:

this Constraint

See Also:

between(java.util.Calendar, java.util.Calendar, DateTools.Resolution) but now no lower bound

lessThan

public Constraint lessThan(Object value)

Description copied from class: ConstraintBuilder

Adds a constraint that the value fieldAttributeName is less than value

note that for range queries on calendar/date instances where the granularity of, say Day, is enough, you should use ConstraintBuilder.lessThan(java.util.Calendar, org.hippoecm.repository.util.DateTools.Resolution) with the highest resolution that is acceptable for your use case, as this performs much better, OR make sure that your application runs with a default resolution set to for example 'day'

Specified by:

lessThan in class ConstraintBuilder

Parameters:

value - object that must be of type String, Boolean, Long, Double, Calendar or Date

Returns:

this Constraint

lessThan

public Constraint lessThan(Calendar value,
                           DateTools.Resolution dateResolution)

Description copied from class: ConstraintBuilder

note: supported resolutions are DateTools.Resolution.YEAR, DateTools.Resolution.MONTH, DateTools.Resolution.DAY or DateTools.Resolution.HOUR

Specified by:

lessThan in class ConstraintBuilder

Parameters:

value - Calendar object. If the parameter value is null, this ConstraintBuilder is ignored (unless another constraint method is invoked without null value.

dateResolution - the resolution to use to compare dates. The higher the Resolution (year is highest) the better the performance. supported resolutions are DateTools.Resolution.YEAR, DateTools.Resolution.MONTH, DateTools.Resolution.DAY or DateTools.Resolution.HOUR

Returns:

this Constraint

See Also:

between(java.util.Calendar, java.util.Calendar, DateTools.Resolution) but now no lower bound and upper bound not included

contains

public Constraint contains(String value)

Description copied from class: ConstraintBuilder

Adds a fulltext search to this Filter. A fulltext search is a search on the indexed text of the scope. When the scope is just a ., the search will be done on the entire document. When the scope is for example @myproject:title, the free text search is done on this property only. You can also point to properties of child nodes, for example a scope like myproject:paragraph/@myproject:header

Specified by:

contains in class ConstraintBuilder

Parameters:

value - the text to search on. If the parameter fullTextSearch is null, this ConstraintBuilder is ignored (unless another constraint method is invoked without null value.

Returns:

this Constraint

notContains

public Constraint notContains(String value)

Description copied from class: ConstraintBuilder

The negated version of ConstraintBuilder.contains(String)

Specified by:

notContains in class ConstraintBuilder

Parameters:

value - the text to search on. If the parameter fullTextSearch is null, this ConstraintBuilder is ignored (unless another constraint method is invoked without null value.

Returns:

this Constraint

See Also:

ConstraintBuilder.contains(String)

between

public Constraint between(Object value1,
                          Object value2)

Description copied from class: ConstraintBuilder

Adds a constraint that the value fieldAttributeName is between value1 and value2 (boundaries included).

note that for range queries on calendar/date instances where the granularity of, say Day, is enough, you should use ConstraintBuilder.between(java.util.Calendar, java.util.Calendar, DateTools.Resolution) with the highest resolution that is acceptable for your use case, as this performs much better, OR make sure that your application runs with a default resolution set to for example 'day'

Specified by:

between in class ConstraintBuilder

Parameters:

value1 - object that must be of type String, Boolean, Long, Double, Calendar or Date. If the parameter value1 is null, this ConstraintBuilder is ignored (unless another constraint method is invoked without null value.

value2 - object that must be of type String, Boolean, Long, Double, Calendar or Date. If the parameter value2 is null, this ConstraintBuilder is ignored (unless another constraint method is invoked without null value.

Returns:

this Constraint

between

public Constraint between(Calendar start,
                          Calendar end,
                          DateTools.Resolution dateResolution)

Description copied from class: ConstraintBuilder

Adds a FAST DATE RANGE constraint that the Calendar value for fieldAttributeName is between start and end (boundaries included) BASED ON the granularity resolution. Thus suppose the Resolution is Resolution.DAY, then results with the same DAY as value for fieldAttributeName will be included. The higher the Resolution (year is highest) the better the performance!

Specified by:

between in class ConstraintBuilder

Parameters:

start - the date to start from (including). If the parameter start is null, this ConstraintBuilder is ignored (unless another constraint method is invoked without null value.

end - the date to end (including). If the parameter end is null, this ConstraintBuilder is ignored (unless another constraint method is invoked without null value.

dateResolution - the resolution to use to compare dates. The higher the Resolution (year is highest) the better the performance. supported resolutions are DateTools.Resolution.YEAR, DateTools.Resolution.MONTH, DateTools.Resolution.DAY or DateTools.Resolution.HOUR

Returns:

this Constraint

notBetween

public Constraint notBetween(Object value1,
                             Object value2)

Description copied from class: ConstraintBuilder

Adds a constraint that the value fieldAttributeName is NOT between value1 and value2, including NOT value1 and value2

note that for range queries on calendar/date instances where the granularity of, say Day, is enough, you should use ConstraintBuilder.notBetween(java.util.Calendar, java.util.Calendar, DateTools.Resolution) with the highest resolution that is acceptable for your use case, as this performs much better, OR make sure that your application runs with a default resolution set to for example 'day'

Specified by:

notBetween in class ConstraintBuilder

Parameters:

value1 - object that must be of type String, Boolean, Long, Double, Calendar or Date. If the parameter value1 is null, this ConstraintBuilder is ignored (unless another constraint method is invoked without null value.

value2 - object that must be of type String, Boolean, Long, Double, Calendar or Date. If the parameter value2 is null, this ConstraintBuilder is ignored (unless another constraint method is invoked without null value.

Returns:

this Constraint

notBetween

public Constraint notBetween(Calendar start,
                             Calendar end,
                             DateTools.Resolution dateResolution)

Description copied from class: ConstraintBuilder

note: supported resolutions are DateTools.Resolution.YEAR, DateTools.Resolution.MONTH, DateTools.Resolution.DAY or DateTools.Resolution.HOUR

Specified by:

notBetween in class ConstraintBuilder

Parameters:

start - the date to start from (including). If the parameter start is null, this ConstraintBuilder is ignored (unless another constraint method is invoked without null value.

end - the date to end (including). If the parameter end is null, this ConstraintBuilder is ignored (unless another constraint method is invoked without null value.

dateResolution - the resolution to use to compare dates. The higher the Resolution (year is highest) the better the performance. supported resolutions are DateTools.Resolution.YEAR, DateTools.Resolution.MONTH, DateTools.Resolution.DAY or DateTools.Resolution.HOUR

Returns:

this Constraint

See Also:

between(String, java.util.Calendar, java.util.Calendar, DateTools.Resolution) but now negated

like

public Constraint like(String value)

Description copied from class: ConstraintBuilder

This function is based on the LIKE predicate found in SQL. This method maps to jcr:like as jcr:like($property as attribute(), $pattern as xs:string). Also see JCR spec 1.0 6.6.5.1 jcr:like

usage: For example, the query “Find all documents whose myproject:title property starts with hip”, is expressed as: addLike("myproject:title","hip%"). The % after hip is the wildcard.

This method is particularly helpful in key kind of fields, where the key values contain chars on which Lucene text indexing tokenizes. For example, "give me all the documents that have a key that start with JIRA key HSTTW0-23" can be expressed as addLike("myproject:key","HSTTW0-23%"). This results in documents having key HSTTW0-2345, HSTTW0-2357, etc.

DO NOT USE '%' AS A PREFIX. Thus do not use a query like addLike("myproject:key","%HSTTW0-23%"). Note the prefix '%'. Prefix wildcards blow up in memory and CPU as they cannot be efficiently done in Lucene.

Specified by:

like in class ConstraintBuilder

Parameters:

value - object that must be of type String. If the parameter start is null, this ConstraintBuilder is ignored (unless another constraint method is invoked without null value.

Returns:

this Constraint

notLike

public Constraint notLike(String value)

Specified by:

notLike in class ConstraintBuilder

Parameters:

value - object that must be of type String. If the parameter start is null, this ConstraintBuilder is ignored (unless another constraint method is invoked without null value.

Returns:

this Constraint

See Also:

only now inverted

exists

public Constraint exists()

Description copied from class: ConstraintBuilder

Add a constraint that the result does have the property fieldAttributeName, regardless its value

Specified by:

exists in class ConstraintBuilder

Returns:

this Constraint

notExists

public Constraint notExists()

Description copied from class: ConstraintBuilder

Add a constraint that the result does NOT have the property fieldAttributeName

Specified by:

notExists in class ConstraintBuilder

Returns:

this Constraint

jcrExpression

public Constraint jcrExpression(String value)

Description copied from class: ConstraintBuilder

Adds the xpath jcrExpression as constraint. See jsr-170 spec for the xpath format

Specified by:

jcrExpression in class ConstraintBuilder

Parameters:

value - the jcrExpression to include in this

Returns:

this Constraint