HstQueryBuilder (Hippo Site Toolkit 4.1.0 API)

java.lang.Object
- org.hippoecm.hst.content.beans.query.builder.HstQueryBuilder

public abstract class HstQueryBuilder
extends Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class HstQueryBuilder.Order

Nested Classes
Modifier and Type	Class and Description
`static class`	`HstQueryBuilder.Order`

Constructor Summary

Constructors
Modifier Constructor and Description

protected HstQueryBuilder()

Constructors
Modifier	Constructor and Description
`protected`	`HstQueryBuilder()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`HstQuery`	`build()`
`abstract HstQuery`	`build(HstQueryManager queryManager)`
`static HstQueryBuilder`	`create(HippoBean... scopeBeans)` Static method to create an initial `HstQueryBuilder` instance for `scopeBeans`.
`static HstQueryBuilder`	`create(javax.jcr.Node... scopeNodes)` Static method to create an initial `HstQueryBuilder` instance for `scopeNodes`.
`protected List<javax.jcr.Node>`	`excludeScopes()`
`HstQueryBuilder`	`excludeScopes(HippoBean... excludeScopeBeans)`
`HstQueryBuilder`	`excludeScopes(javax.jcr.Node... excludeScopeNodes)`
`HstQueryBuilder`	`limit(int limit)` Sets the limit of search results.
`HstQueryBuilder`	`offset(int offset)` Sets the offset to start searching from.
`HstQueryBuilder`	`ofPrimaryTypes(Class<? extends HippoBean>... primaryNodeTypeClazzes)`
`HstQueryBuilder`	`ofPrimaryTypes(String... primaryNodeTypes)`
`HstQueryBuilder`	`ofTypes(Class<? extends HippoBean>... ofTypeClazzes)`
`HstQueryBuilder`	`ofTypes(String... ofTypeClazzes)`
`HstQueryBuilder`	`orderBy(HstQueryBuilder.Order order, String... fieldNames)`
`HstQueryBuilder`	`orderByAscending(String... fieldNames)`
`HstQueryBuilder`	`orderByAscendingCaseInsensitive(String... fieldNames)`
`HstQueryBuilder`	`orderByCaseInsensitive(HstQueryBuilder.Order order, String... fieldNames)`
`HstQueryBuilder`	`orderByDescending(String... fieldNames)`
`HstQueryBuilder`	`orderByDescendingCaseInsensitive(String... fieldNames)`
`protected Constraint`	`where()`
`HstQueryBuilder`	`where(Constraint constraint)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HstQueryBuilder
```
protected HstQueryBuilder()
```
- Method Detail
  - create
```
public static HstQueryBuilder create(HippoBean... scopeBeans)
                              throws RuntimeQueryException
```
    Static method to create an initial HstQueryBuilder instance for scopeBeans.
    
    Parameters:
    
    scopeBeans - Array of the scopes for the HstQuery returned by build(). Note at least 1 non-null-value must be supplied
    
    Returns:
    
    HstQueryBuilder instance
    
    Throws:
    
    RuntimeQueryException - if there is not at least 1 non-null-value in scopeBeans
  - create
```
public static HstQueryBuilder create(javax.jcr.Node... scopeNodes)
                              throws RuntimeQueryException
```
    Static method to create an initial HstQueryBuilder instance for scopeNodes.
    
    Parameters:
    
    scopeNodes - Array of the scopes for the HstQuery returned by build(). Note at least 1 non-null-value must be supplied
    
    Returns:
    
    HstQueryBuilder instance
    
    Throws:
    
    RuntimeQueryException - if there is not at least 1 non-null-value in scopeNodes
  - build
```
public HstQuery build()
               throws RuntimeQueryException
```
    Returns:
    
    The HstQuery for this HstQueryBuilder where the backing HstQueryManager is taken from HstRequestContext.getQueryManager()
    
    Throws:
    
    RuntimeQueryException - in case the #build results in a QueryException or FilterException
  - build
```
public abstract HstQuery build(HstQueryManager queryManager)
                        throws RuntimeQueryException
```
    Returns:
    
    The HstQuery for this HstQueryBuilder where the backing HstQueryManager is provided by the argument queryManager
    
    Throws:
    
    RuntimeQueryException - in case the #build results in a QueryException or FilterException
  - ofTypes
```
public HstQueryBuilder ofTypes(Class<? extends HippoBean>... ofTypeClazzes)
```
    Parameters:
    
    ofTypeClazzes - the result most return documents only of types where subtypes are included. If ofTypeClazzes is null the parameter is ignored
    
    Returns:
    
    this HstQueryBuilder instance
  - ofTypes
```
public HstQueryBuilder ofTypes(String... ofTypeClazzes)
```
    Parameters:
    
    ofTypeClazzes - the result most return documents only of types where subtypes are included. If ofTypeClazzes is null the parameter is ignored
    
    Returns:
    
    this HstQueryBuilder instance
  - ofPrimaryTypes
```
public HstQueryBuilder ofPrimaryTypes(String... primaryNodeTypes)
```
    Parameters:
    
    primaryNodeTypes - the result most return documents only of primaryNodeTypeNames where subtypes are not included. If primaryNodeTypes is null the parameter is ignored
    
    Returns:
    
    this HstQueryBuilder instance
  - ofPrimaryTypes
```
public HstQueryBuilder ofPrimaryTypes(Class<? extends HippoBean>... primaryNodeTypeClazzes)
```
    Parameters:
    
    primaryNodeTypeClazzes - the result most return documents only of primaryNodeTypeNames where subtypes are not included. If primaryNodeTypes is null the parameter is ignored
    
    Returns:
    
    this HstQueryBuilder instance
  - excludeScopes
```
public HstQueryBuilder excludeScopes(javax.jcr.Node... excludeScopeNodes)
```
  - excludeScopes
```
public HstQueryBuilder excludeScopes(HippoBean... excludeScopeBeans)
```
  - excludeScopes
```
protected List<javax.jcr.Node> excludeScopes()
```
  - where
```
public HstQueryBuilder where(Constraint constraint)
```
  - where
```
protected Constraint where()
```
  - orderBy
```
public HstQueryBuilder orderBy(HstQueryBuilder.Order order,
                               String... fieldNames)
```
    Parameters:
    
    order - the HstQueryBuilder.Order in which the results should be ordered. If null, the order is ascending
    
    fieldNames - the fieldNames to order on in sortOrder sort order. The fieldNames argument can be null in which case it is just ignored. A field name in the array that is empty is skipped.
    
    Returns:
    
    this HstQueryBuilder instance
  - orderByCaseInsensitive
```
public HstQueryBuilder orderByCaseInsensitive(HstQueryBuilder.Order order,
                                              String... fieldNames)
```
    Parameters:
    
    order - the HstQueryBuilder.Order in which the results should be ordered. If null, the order is ascending
    
    fieldNames - the fieldNames to order on case insensitive in sortOrder sort order. The fieldNames argument can be null in which case it is just ignored. A field name in the array that is empty is skipped.
    
    Returns:
    
    this HstQueryBuilder instance
  - orderByAscending
```
public HstQueryBuilder orderByAscending(String... fieldNames)
```
    Parameters:
    
    fieldNames - the fieldNames to order on in ascending sort order. The fieldNames argument can be null in which case it is just ignored. A field name in the array that is empty is skipped.
    
    Returns:
    
    this HstQueryBuilder instance
  - orderByAscendingCaseInsensitive
```
public HstQueryBuilder orderByAscendingCaseInsensitive(String... fieldNames)
```
    Parameters:
    
    fieldNames - the fieldNames to order on case insensitive in sort order. The fieldNames argument can be null in which case it is just ignored. A field name in the array that is empty is skipped.
    
    Returns:
    
    this HstQueryBuilder instance
  - orderByDescending
```
public HstQueryBuilder orderByDescending(String... fieldNames)
```
    Parameters:
    
    fieldNames - the fieldNames to order on in descending sort order. The fieldNames argument can be null in which case it is just ignored. A field name in the array that is empty is skipped.
    
    Returns:
    
    this HstQueryBuilder instance
  - orderByDescendingCaseInsensitive
```
public HstQueryBuilder orderByDescendingCaseInsensitive(String... fieldNames)
```
    Parameters:
    
    fieldNames - the fieldNames to order on case insensitive in descending sort order. The fieldNames argument can be null in which case it is just ignored. A field name in the array that is empty is skipped.
    
    Returns:
    
    this HstQueryBuilder instance
  - offset
```
public HstQueryBuilder offset(int offset)
```
    Sets the offset to start searching from. Default offset is -1 which means it is ignored. A negative offset will be ignored
    
    Parameters:
    
    offset - the offset to use, negative values will be ignored
  - limit
```
public HstQueryBuilder limit(int limit)
```
    Sets the limit of search results. Note that setting this value very high might influence performance negatively
    
    Parameters:
    
    limit - the limit to use, negative values will be ignored

Class HstQueryBuilder

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HstQueryBuilder

Method Detail

create

create

build

build

ofTypes

ofTypes

ofPrimaryTypes

ofPrimaryTypes

excludeScopes

excludeScopes

excludeScopes

where

where

orderBy

orderByCaseInsensitive

orderByAscending

orderByAscendingCaseInsensitive

orderByDescending

orderByDescendingCaseInsensitive

offset

limit