public class QuerySpec extends Object
Modifier and Type | Class and Description |
---|---|
static class |
QuerySpec.Style
This enumerated type defines the style used for returning
the results.
|
static class |
QuerySpec.Truncate
This enumerated type defines where truncation should
occur if the collection size is greater than the
maximum number of items specified.
|
Constructor and Description |
---|
QuerySpec()
The default constructor.
|
Modifier and Type | Method and Description |
---|---|
String |
getCollection()
This method returns the name of the collection.
|
int |
getMaxItems()
This method returns the maximum number of items
that should be included in the query result,
or 0 if unrestricted.
|
String |
getParent()
This method returns the name of the parent collection.
|
Predicate |
getPredicate()
This method returns the optional predicate.
|
Map<String,Object> |
getProperties()
This method returns the additional properties.
|
QuerySpec.Style |
getStyle()
This method returns the style that should be used
for returning the result.
|
QuerySpec.Truncate |
getTruncate()
This method returns which part of the collection
should be truncated if the collection contains
more items than can be returned in the query result.
|
void |
setCollection(String name)
This method sets the name of the collection.
|
void |
setMaxItems(int maxItems)
This method sets the maximum number of items
that should be included in the query result,
or 0 if unrestricted.
|
void |
setParent(String name)
This method sets the name of the parent collection.
|
void |
setPredicate(Predicate pred)
This method sets the optional predicate.
|
void |
setProperties(Map<String,Object> props)
This method sets the additional properties.
|
void |
setStyle(QuerySpec.Style style)
This method sets the style that should be used
for returning the result.
|
void |
setTruncate(QuerySpec.Truncate truncate)
This method sets which part of the collection
should be truncated if the collection contains
more items than can be returned in the query result.
|
String |
toString() |
public String getCollection()
public void setCollection(String name)
name
- The collection namepublic Predicate getPredicate()
public void setPredicate(Predicate pred)
pred
- The predicatepublic String getParent()
public void setParent(String name)
name
- The parent collection namepublic int getMaxItems()
public void setMaxItems(int maxItems)
maxItems
- The maximum number of items, or 0 if unrestrictedpublic QuerySpec.Truncate getTruncate()
public void setTruncate(QuerySpec.Truncate truncate)
truncate
- The truncation locationpublic QuerySpec.Style getStyle()
public void setStyle(QuerySpec.Style style)
style
- The stylepublic Map<String,Object> getProperties()
public void setProperties(Map<String,Object> props)
props
- The propertiesCopyright © 2013-2015 JBoss by Red Hat. All Rights Reserved.