public static interface CqQuery.DisplayField
Modifier and Type | Interface and Description |
---|---|
static class |
CqQuery.DisplayField.Aggregation
Supported display field aggregate functions.
|
static class |
CqQuery.DisplayField.FieldType
The value types for result set rows
|
static class |
CqQuery.DisplayField.Function
The functions that can be applied to a DisplayField of type DATE_TIME
|
static class |
CqQuery.DisplayField.SortType
Supported DisplayField sort options
|
Modifier and Type | Method and Description |
---|---|
CqQuery.DisplayField.Aggregation |
getAggregation()
Returns the aggregate function that is applied to the field path of
each selected record to compute the value for the result set.
|
String |
getDescription()
Returns the description of the field from the schema.
|
CqQuery.DisplayField.FieldType |
getFieldType()
Returns the FieldType of the display field.
|
CqQuery.DisplayField.Function |
getFunction()
Returns the simple scalar function that is to be applied to this
DisplayField (e.g.
|
boolean |
getIsGroupBy()
Returns whether or not the field is in a group-by clause.
|
boolean |
getIsLegalForFilter()
Returns whether or not this field can be used in a query filter.
|
boolean |
getIsVisible()
Returns whether or not this display field occupies a column in the
result set.
|
String |
getLabel()
Returns the label for the column of the result set that contains
values from this display field.
|
CqFieldDefinition[] |
getPath()
Returns the field path that describes the data source for this
display field.
|
String |
getPathName()
Returns the character image of the field path that is the data source
for this display field.
|
long |
getSortOrder()
Returns the sort order for fields participating in the sort (SortType
not equal NO_SORT).
|
CqQuery.DisplayField.SortType |
getSortType()
Returns a code indicating how this field path participates in the
sorting of result set records: ascending, descending or not at all.
|
void |
setAggregation(CqQuery.DisplayField.Aggregation aggregation)
Sets the aggregate function for this display field.
|
void |
setFunction(CqQuery.DisplayField.Function function)
Sets the simple scalar function that is to be applied to this
DisplayField before inclusion in the result set.
|
void |
setIsGroupBy(boolean isGroupBy)
Sets whether or not this field is in the group-by clause when
aggregation functions are used.
|
void |
setIsVisible(boolean isVisible)
Sets whether or not this display field occupies a column in the
result set
|
void |
setLabel(String label)
Sets the label for the column of the result set that contains values
from this display field.
|
void |
setPath(CqFieldDefinition... arg)
Sets the field path that describes the data source for this display
field.
|
void |
setSortOrder(long sortOrder)
Sets the sort order position for this display field.
|
void |
setSortType(CqQuery.DisplayField.SortType sortType)
Sets the SortType code for this display field.
|
CqQuery.DisplayField.Aggregation getAggregation()
String getDescription()
CqQuery.DisplayField.FieldType getFieldType()
CqQuery.DisplayField.Function getFunction()
boolean getIsGroupBy()
boolean getIsLegalForFilter()
boolean getIsVisible()
String getLabel()
CqFieldDefinition[] getPath()
String getPathName()
long getSortOrder()
CqQuery.DisplayField.SortType getSortType()
void setAggregation(CqQuery.DisplayField.Aggregation aggregation)
aggregation
- An Aggregation type code. Must not be null.void setFunction(CqQuery.DisplayField.Function function)
function
- The Function enumerator specifying the function.void setIsGroupBy(boolean isGroupBy)
isGroupBy
- If true, this field is in the group-by
clause.void setIsVisible(boolean isVisible)
isVisible
- true if this display field is to be included
in the result set; false otherwise.void setLabel(String label)
label
- A String containing the label for the display field
column. Must not be null.void setPath(CqFieldDefinition... arg)
arg
- An non-empty array of CqFieldDefinition objects specifying
a property path as described in the documentation for
getPath()
. Must not be null.void setSortOrder(long sortOrder)
sortOrder
- A non-negative integer.void setSortType(CqQuery.DisplayField.SortType sortType)
sortType
- A SortType code. Must not be null.Copyright © IBM 2018. All rights reserved.