|
DataViewCriteria
|
addAnd()
Adds an AND operator to the query.
|
|
DataViewCriteria
|
addBetween(String column, String lower, String higher)
Include records where column is between and includes the two constraints. The values will be cast to the correct type. The behavior depends on the type of data being operated on. Dates without a time value will be treated as midnight, so between 11-12-2008 and 11-13-2008 will return all entries on 11-12-2008. To include those for 11-13-2008 you would use 11-12-2008 and 11-14-2008 or 11-12-2008 and 11-13-2008 23:59. For string comparisons, between 'A' and 'C' would include 'A', 'B', and 'C' but not 'D'. For numbers, the end points are also inclusive: between 1 and 5 will return 1,2,3,4 and 5 but not 6.
|
|
DataViewCriteria
|
addBetweenDates(String column, Date lowerDate, Date higherDate)
Include records where column is between the two dates. Dates without a time value will be treated as midnight, so between 11-12-2008 and 11-13-2008 will return all entries on 11-12-2008. To include those for 11-13-2008 you would use 11-12-2008 and 11-14-2008 or 11-12-2008 and 11-13-2008 23:59.
|
|
DataViewCriteria
|
addEqual(String column, String value)
Include records where column equals value. The value will be cast to the correct type.
|
|
|
addFilter(DataViewFilter filter)
The method will take all the query parameters and paging information from argument and add it to this filter. It throws exception on columns that don't exist in the underlying storage.
|
|
DataViewCriteria
|
addGreaterThan(String column, String value)
Include records where column is greater than the value. The values will be cast to the correct type.
|
|
DataViewCriteria
|
addGreaterThanDate(String column, Date date)
Include records where column is greater than the date.
|
|
DataViewCriteria
|
addGreaterThanEqualTo(String column, String value)
Include records where column is greater than or equal to the value. The values will be cast to the correct type.
|
|
DataViewCriteria
|
addGreaterThanEqualToDate(String column, Date date)
Include records where column is greater than or equal to the date.
|
|
DataViewCriteria
|
addGreaterThanGeoDistance(String latColumn, String lonColumn, double latitude, double longitude, double distance, String unit)
Returns rows where the geo distance from the given lat/lon is greater than or equal to the provided distance.
|
|
DataViewCriteria
|
addIn(String columnName, String[] arrayOfIds)
Adds an 'IN' clause to the query
|
|
DataViewCriteria
|
addIsNull(String column)
Include records where column specified is null
|
|
DataViewCriteria
|
addLessThan(String column, String value)
Include records where column is less than the value. The values will be cast to the correct type.
|
|
DataViewCriteria
|
addLessThanDate(String column, Date date)
Include records where column is less than the date.
|
|
DataViewCriteria
|
addLessThanEqualTo(String column, String value)
Include records where column is less than or equal to the value. The values will be cast to the correct type.
|
|
DataViewCriteria
|
addLessThanEqualToDate(String column, Date date)
Include records where column is less than or equal to the date.
|
|
DataViewCriteria
|
addLessThanGeoDistance(String latColumn, String lonColumn, double latitude, double longitude, double distance, String unit)
Returns rows where the geo distance from the given lat/lon is less than or equal to the provided distance.
|
|
DataViewCriteria
|
addLike(String column, String value)
Include records where column is like the value. The value will be cast to the correct type.
|
|
DataViewCriteria
|
addNotEqual(String column, String value)
Include records where column is not equal to the value. The value will be cast to the correct type.
|
|
DataViewCriteria
|
addNotIn(String columnName, String[] arrayOfIds)
Adds an 'NOT IN' clause to the query
|
|
DataViewCriteria
|
addNotLike(String column, String value)
Include records where column is not like the value. The value will be cast to the correct type.
|
|
DataViewCriteria
|
addNotNull(String column)
Include records where column specified is not null
|
|
DataViewCriteria
|
addOr()
Adds an OR operator to the query.
|
|
|
avg(String column, String resultAlias)
calculates the avg of the specified column using the specified resultAlias
|
|
DataViewCriteria
|
beginGroup()
Begins a group of statements.
|
|
GroupConcat
|
concat(String column)
Concatenates the values of the specified column when used with a group by clause. By default, the max length will be 1024 characters. Use the resulting GroupConcat object for additional configuration. The alias in GroupConcat should be unique in the field list. To increase the size of the max length, contact support.
|
|
|
count(String column, String resultAlias)
calculates the count of the specified column using the specified resultAlias
|
|
|
countDistinct(String column, String resultAlias)
calculates the distinct count of the specified column using the specified resultAlias
|
|
|
dateDiff(String leftDateColumn, String rightDateColumn, String resultAlias)
Returns the difference in days between the value of the two date columns.
|
|
|
dateDiffCompare(String dateColumn, String resultAlias, Date compareDate)
Returns the difference in days between the value of the date column and the compare date. If compareDate is null, the current date is used.
|
|
|
day(String column, String resultAlias)
returns the day portion of the specified date column as a number 1-31 using the specified resultAlias
|
|
|
dayOfWeek(String column, String resultAlias)
returns the weekday index of the specified date column as a number 1-7 (Sunday=1, Monday=2,...,Saturday=7) using the specified resultAlias
|
|
|
dayOfYear(String column, String resultAlias)
returns the day of the year of the specified date column as a number 1-366 using the specified resultAlias
|
|
|
enableDecrypt(boolean enabled)
Decrypts values of encrypted columns. This has a performance impact, especially for large lists.
|
|
DataViewCriteria
|
enableFastPaging(int pageNumber, int pageSize)
Sets firstResult based on the page size and page number (if greater than 0) and enables paging (if countLimit greater than 0). This will force inquiry to determine if there are additional rows beyond this page but will not inspect the entire database. See DataViewList.getPagingInfo().
|
|
DataViewCriteria
|
enablePaging(int pageNumber, int pageSize)
Sets firstResult based on the page size and page number and enables paging. This will force inquiry into the total number of records that match the filter and can be a performance hit on tables with a large amount of rows. Consider using enableFastPaging on larger datasets. See DataViewList.getPagingInfo().
|
|
DataViewCriteria
|
endGroup()
Ends a group of statements.
|
|
|
explain(boolean includeIndexes)
This method is only for development purposes to describe the indexes that will be utilized in the given query. The output is rendered in the debug messages of Pal Builder. This method is used for development purposes and ignored in deployed pals.
|
|
|
geoDistance(String latColumn, String lonColumn, String resultAlias, double latitude, double longitude, String unit)
Returns the calculated distance between the location given and the geo-coordinates in the dataset rows.
|
|
String
|
getQuery()
Returns the query statement that will be generated for the underlying storage by the filter. This method is primarily used for development purposes.
|
|
|
groupByColumn(String column)
Add column to group by
|
|
|
groupByColumns(String[] columns)
Add columns to group by
|
|
boolean
|
hasColumn(String column)
Returns true if the specified column exists for queries.
|
|
|
havingAnd()
Adds an 'and' statement to the having clause
|
|
|
havingBeginGroup()
Adds begin group to having statement
|
|
|
havingBetween(String column, Object lowValue, Object highValue)
Performs a 'having clause' on the specified derived column
|
|
|
havingEndGroup()
Adds end group to having statement
|
|
|
havingEqual(String column, Object value)
Performs a 'having clause' on the specified derived column
|
|
|
havingGreaterThan(String column, Object value)
Performs a 'having clause' on the specified derived column
|
|
|
havingLessThan(String column, Object value)
Performs a 'having clause' on the specified derived column
|
|
|
havingOr()
Adds an 'or' statement to the having clause
|
|
|
hour(String column, String resultAlias)
returns the hour of the specified date column as a number 0-23 using the specified resultAlias
|
|
boolean
|
isDecryptEnabled()
Returns true if decryption is enabled.
|
|
|
max(String column, String resultAlias)
calculates the max of the specified column using the specified resultAlias
|
|
|
min(String column, String resultAlias)
calculates the min of the specified column using the specified resultAlias
|
|
|
minute(String column, String resultAlias)
returns the minute of the specified date column as a number 0-59 using the specified resultAlias
|
|
|
month(String column, String resultAlias)
returns the month portion of the specified date column as a number 1-12 using the specified resultAlias
|
|
|
quarter(String column, String resultAlias)
returns the quarter of the specified date column as a number 1-4 using the specified resultAlias
|
|
|
reset()
Resets the filter (equivalent of creating a new filter).
|
|
|
second(String column, String resultAlias)
returns the second of the specified date column as a number 0-59 using the specified resultAlias
|
|
|
selectColumn(String column)
Explicitly select the specified column.
|
|
|
selectColumns(String[] columns)
Explicitly select the specified columns.
|
|
|
setDateFormat(String pattern)
Sets the date pattern for date strings used in criteria.
|
|
DataViewCriteria
|
setFirstRecord(int firstRecord)
Set the first record to return.
|
|
DataViewCriteria
|
setMaxPageSize()
Set the page size to the maximum allowed by the key.
|
|
DataViewCriteria
|
setPageSize(int size)
Set the page size (max 1000 or limit controlled by the activation key, min 1, default 100). See also setMaxPageSize.
|
|
DataViewCriteria
|
setQueryTimeout(int timeout)
Sets the timeout for the query. By default this is 10 seconds and the maximum is defined by the cloud configuration.
|
|
DataViewCriteria
|
sortAscending(String column)
Sorts the results in ascending order on the given column.
|
|
DataViewFilter
|
sortAscending(String column)
Sorts the results in ascending order on the given column.
|
|
DataViewFilter
|
sortDescending(String column)
Sorts the results in descending order on the given column.
|
|
DataViewCriteria
|
sortDescending(String column)
Sorts the results in descending order on the given column.
|
|
|
standardDeviation(String column, String resultAlias)
calculates the population standard deviation of the specified column using the specified resultAlias
|
|
|
sum(String column, String resultAlias)
calculates the sum of the specified column using the specified resultAlias
|
|
|
timeDiff(String leftDateColumn, String rightDateColumn, String resultAlias, String unit)
Returns the difference in unit between the value of the two datetime columns.
|
|
|
timeDiffCompare(String dateColumn, String resultAlias, Date compareDate, String unit)
Returns the difference in unit between the value of the datetime column and the compare datetime. If compareDate is null, the current datetime is used.
|
|
String
|
toString()
Returns a description of this object.
|
|
|
week(String column, String resultAlias)
returns the week number of the specified date column as a number 0-52 using the specified resultAlias
|
|
|
weekOfYear(String column, String resultAlias)
returns the week of the year of the specified date column as a number 0-53 using the specified resultAlias
|
|
|
weekday(String column, String resultAlias)
returns the weekday of the specified date column as a number 0-6 (0 = Monday, 1 = Tuesday, ... 6 = Sunday) using the specified resultAlias
|
|
|
year(String column, String resultAlias)
returns the year portion of the specified date column using the specified resultAlias
|
Method Detail
DataViewCriteria addAnd()
Adds an AND operator to the query.
Returns:
DataViewCriteria
Since:
10-11-2010
DataViewCriteria addBetween(String column, String lower, String higher)
Include records where column is between and includes the two constraints. The values will be cast to the correct type. The behavior depends on the type of data being operated on. Dates without a time value will be treated as midnight, so between 11-12-2008 and 11-13-2008 will return all entries on 11-12-2008. To include those for 11-13-2008 you would use 11-12-2008 and 11-14-2008 or 11-12-2008 and 11-13-2008 23:59. For string comparisons, between 'A' and 'C' would include 'A', 'B', and 'C' but not 'D'. For numbers, the end points are also inclusive: between 1 and 5 will return 1,2,3,4 and 5 but not 6.
Parameters:
-
String
column
Required parameter.
-
String
lower
Required parameter.
-
String
higher
Required parameter.
Returns:
DataViewCriteria
Since:
10-11-2010
DataViewCriteria addBetweenDates(String column, Date lowerDate, Date higherDate)
Include records where column is between the two dates. Dates without a time value will be treated as midnight, so between 11-12-2008 and 11-13-2008 will return all entries on 11-12-2008. To include those for 11-13-2008 you would use 11-12-2008 and 11-14-2008 or 11-12-2008 and 11-13-2008 23:59.
Parameters:
-
String
column
Required parameter.
-
Date
lowerDate
Required parameter.
-
Date
higherDate
Required parameter.
Returns:
DataViewCriteria
Since:
06-09-2011
DataViewCriteria addEqual(String column, String value)
Include records where column equals value. The value will be cast to the correct type.
Parameters:
-
String
column
Required parameter.
-
String
value
Required parameter.
Returns:
DataViewCriteria
Since:
10-11-2010
addFilter(DataViewFilter filter)
The method will take all the query parameters and paging information from argument and add it to this filter. It throws exception on columns that don't exist in the underlying storage.
Parameters:
Since:
08-09-2022
DataViewCriteria addGreaterThan(String column, String value)
Include records where column is greater than the value. The values will be cast to the correct type.
Parameters:
-
String
column
Required parameter.
-
String
value
Required parameter.
Returns:
DataViewCriteria
Since:
10-11-2010
DataViewCriteria addGreaterThanDate(String column, Date date)
Include records where column is greater than the date.
Parameters:
-
String
column
Required parameter.
-
Date
date
Required parameter.
Returns:
DataViewCriteria
Since:
06-09-2011
DataViewCriteria addGreaterThanEqualTo(String column, String value)
Include records where column is greater than or equal to the value. The values will be cast to the correct type.
Parameters:
-
String
column
Required parameter.
-
String
value
Required parameter.
Returns:
DataViewCriteria
Since:
10-11-2010
DataViewCriteria addGreaterThanEqualToDate(String column, Date date)
Include records where column is greater than or equal to the date.
Parameters:
-
String
column
Required parameter.
-
Date
date
Required parameter.
Returns:
DataViewCriteria
Since:
06-09-2011
DataViewCriteria addGreaterThanGeoDistance(String latColumn, String lonColumn, double latitude, double longitude, double distance, String unit)
Returns rows where the geo distance from the given lat/lon is greater than or equal to the provided distance.
Parameters:
-
String
latColumn
- latitude column name.
-
String
lonColumn
- longitude column name.
-
double
latitude
- from latitude location.
-
double
longitude
- from longitude location.
-
double
distance
- distance in units.
-
String
unit
- Unit of distance (km=kilometers, m=miles).
Allowed values: km, m.
Returns:
DataViewCriteria
Since:
05-21-2025
DataViewCriteria addIn(String columnName, String[] arrayOfIds)
Adds an 'IN' clause to the query
Parameters:
-
String
columnName
Required parameter.
-
String[]
arrayOfIds
Required parameter.
Returns:
DataViewCriteria
Since:
07-05-2023
DataViewCriteria addIsNull(String column)
Include records where column specified is null
Parameters:
-
String
column
Required parameter.
Returns:
DataViewCriteria
Since:
10-11-2010
DataViewCriteria addLessThan(String column, String value)
Include records where column is less than the value. The values will be cast to the correct type.
Parameters:
-
String
column
Required parameter.
-
String
value
Required parameter.
Returns:
DataViewCriteria
Since:
10-11-2010
DataViewCriteria addLessThanDate(String column, Date date)
Include records where column is less than the date.
Parameters:
-
String
column
Required parameter.
-
Date
date
Required parameter.
Returns:
DataViewCriteria
Since:
06-09-2011
DataViewCriteria addLessThanEqualTo(String column, String value)
Include records where column is less than or equal to the value. The values will be cast to the correct type.
Parameters:
-
String
column
Required parameter.
-
String
value
Required parameter.
Returns:
DataViewCriteria
Since:
10-11-2010
DataViewCriteria addLessThanEqualToDate(String column, Date date)
Include records where column is less than or equal to the date.
Parameters:
-
String
column
Required parameter.
-
Date
date
Required parameter.
Returns:
DataViewCriteria
Since:
06-09-2011
DataViewCriteria addLessThanGeoDistance(String latColumn, String lonColumn, double latitude, double longitude, double distance, String unit)
Returns rows where the geo distance from the given lat/lon is less than or equal to the provided distance.
Parameters:
-
String
latColumn
- latitude column name.
-
String
lonColumn
- longitude column name.
-
double
latitude
- from latitude location.
-
double
longitude
- from longitude location.
-
double
distance
- distance in units.
-
String
unit
- Unit of distance (km=kilometers, m=miles).
Allowed values: km, m.
Returns:
DataViewCriteria
Since:
05-21-2025
DataViewCriteria addLike(String column, String value)
Include records where column is like the value. The value will be cast to the correct type.
Parameters:
-
String
column
Required parameter.
-
String
value
Required parameter.
Returns:
DataViewCriteria
Since:
10-11-2010
DataViewCriteria addNotEqual(String column, String value)
Include records where column is not equal to the value. The value will be cast to the correct type.
Parameters:
-
String
column
Required parameter.
-
String
value
Required parameter.
Returns:
DataViewCriteria
Since:
10-11-2010
DataViewCriteria addNotIn(String columnName, String[] arrayOfIds)
Adds an 'NOT IN' clause to the query
Parameters:
-
String
columnName
Required parameter.
-
String[]
arrayOfIds
Required parameter.
Returns:
DataViewCriteria
Since:
07-05-2023
DataViewCriteria addNotLike(String column, String value)
Include records where column is not like the value. The value will be cast to the correct type.
Parameters:
-
String
column
Required parameter.
-
String
value
Required parameter.
Returns:
DataViewCriteria
Since:
10-11-2010
DataViewCriteria addNotNull(String column)
Include records where column specified is not null
Parameters:
-
String
column
Required parameter.
Returns:
DataViewCriteria
Since:
10-11-2010
DataViewCriteria addOr()
Adds an OR operator to the query.
Returns:
DataViewCriteria
Since:
10-11-2010
avg(String column, String resultAlias)
calculates the avg of the specified column using the specified resultAlias
Parameters:
-
String
column
-
String
resultAlias
Since:
06-26-2008
DataViewCriteria beginGroup()
Begins a group of statements.
Returns:
DataViewCriteria
Since:
10-11-2010
GroupConcat concat(String column)
Concatenates the values of the specified column when used with a group by clause. By default, the max length will be 1024 characters. Use the resulting GroupConcat object for additional configuration. The alias in GroupConcat should be unique in the field list. To increase the size of the max length, contact support.
Parameters:
-
String
column
- column name.
Returns:
GroupConcat
Since:
07-05-2023
count(String column, String resultAlias)
calculates the count of the specified column using the specified resultAlias
Parameters:
-
String
column
-
String
resultAlias
Since:
06-26-2008
countDistinct(String column, String resultAlias)
calculates the distinct count of the specified column using the specified resultAlias
Parameters:
-
String
column
Required parameter.
-
String
resultAlias
Required parameter.
Since:
10-22-2019
dateDiff(String leftDateColumn, String rightDateColumn, String resultAlias)
Returns the difference in days between the value of the two date columns.
Parameters:
-
String
leftDateColumn
- left date column name.
-
String
rightDateColumn
- right date column name.
-
String
resultAlias
- result column name.
Since:
08-11-2010
dateDiffCompare(String dateColumn, String resultAlias, Date compareDate)
Returns the difference in days between the value of the date column and the compare date. If compareDate is null, the current date is used.
Parameters:
-
String
dateColumn
- date column name.
-
String
resultAlias
- result column name.
-
Date
compareDate
- date for comparison.
Since:
08-06-2015
day(String column, String resultAlias)
returns the day portion of the specified date column as a number 1-31 using the specified resultAlias
Parameters:
-
String
column
-
String
resultAlias
Since:
01-14-2009
dayOfWeek(String column, String resultAlias)
returns the weekday index of the specified date column as a number 1-7 (Sunday=1, Monday=2,...,Saturday=7) using the specified resultAlias
Parameters:
-
String
column
-
String
resultAlias
Since:
01-14-2009
dayOfYear(String column, String resultAlias)
returns the day of the year of the specified date column as a number 1-366 using the specified resultAlias
Parameters:
-
String
column
-
String
resultAlias
Since:
10-26-2009
enableDecrypt(boolean enabled)
Decrypts values of encrypted columns. This has a performance impact, especially for large lists.
Parameters:
Since:
07-14-2010
DataViewCriteria enableFastPaging(int pageNumber, int pageSize)
Sets firstResult based on the page size and page number (if greater than 0) and enables paging (if countLimit greater than 0). This will force inquiry to determine if there are additional rows beyond this page but will not inspect the entire database. See DataViewList.getPagingInfo().
Parameters:
-
int
pageNumber
Required parameter.
-
int
pageSize
Required parameter.
Returns:
DataViewCriteria
Since:
06-20-2024
DataViewCriteria enablePaging(int pageNumber, int pageSize)
Sets firstResult based on the page size and page number and enables paging. This will force inquiry into the total number of records that match the filter and can be a performance hit on tables with a large amount of rows. Consider using enableFastPaging on larger datasets. See DataViewList.getPagingInfo().
Parameters:
-
int
pageNumber
Required parameter.
-
int
pageSize
Required parameter.
Returns:
DataViewCriteria
Since:
01-03-2014
DataViewCriteria endGroup()
Ends a group of statements.
Returns:
DataViewCriteria
Since:
10-11-2010
explain(boolean includeIndexes)
This method is only for development purposes to describe the indexes that will be utilized in the given query. The output is rendered in the debug messages of Pal Builder. This method is used for development purposes and ignored in deployed pals.
Parameters:
Since:
12-04-2018
geoDistance(String latColumn, String lonColumn, String resultAlias, double latitude, double longitude, String unit)
Returns the calculated distance between the location given and the geo-coordinates in the dataset rows.
Parameters:
-
String
latColumn
- latitude column name.
-
String
lonColumn
- longitude column name.
-
String
resultAlias
- result column name.
-
double
latitude
- from latitude location.
-
double
longitude
- from longitude location.
-
String
unit
- Unit of distance (km=kilometers, m=miles).
Allowed values: km, m.
Since:
10-31-2024
String getQuery()
Returns the query statement that will be generated for the underlying storage by the filter. This method is primarily used for development purposes.
Returns:
String
Since:
05-02-2016
groupByColumn(String column)
Add column to group by
Parameters:
Since:
06-26-2008
groupByColumns(String[] columns)
Add columns to group by
Parameters:
Since:
06-26-2008
boolean hasColumn(String column)
Returns true if the specified column exists for queries.
Parameters:
-
String
column
Required parameter.
Returns:
boolean
Since:
11-26-2014
havingAnd()
Adds an 'and' statement to the having clause
Since:
10-31-2024
havingBeginGroup()
Adds begin group to having statement
Since:
10-31-2024
havingBetween(String column, Object lowValue, Object highValue)
Performs a 'having clause' on the specified derived column
Parameters:
-
String
column
Required parameter.
-
Object
lowValue
Required parameter.
-
Object
highValue
Required parameter.
Since:
10-31-2024
havingEndGroup()
Adds end group to having statement
Since:
10-31-2024
havingEqual(String column, Object value)
Performs a 'having clause' on the specified derived column
Parameters:
-
String
column
Required parameter.
-
Object
value
Required parameter.
Since:
10-31-2024
havingGreaterThan(String column, Object value)
Performs a 'having clause' on the specified derived column
Parameters:
-
String
column
Required parameter.
-
Object
value
Required parameter.
Since:
10-31-2024
havingLessThan(String column, Object value)
Performs a 'having clause' on the specified derived column
Parameters:
-
String
column
Required parameter.
-
Object
value
Required parameter.
Since:
10-31-2024
havingOr()
Adds an 'or' statement to the having clause
Since:
10-31-2024
hour(String column, String resultAlias)
returns the hour of the specified date column as a number 0-23 using the specified resultAlias
Parameters:
-
String
column
-
String
resultAlias
Since:
01-14-2009
boolean isDecryptEnabled()
Returns true if decryption is enabled.
Returns:
boolean
Since:
07-14-2010
max(String column, String resultAlias)
calculates the max of the specified column using the specified resultAlias
Parameters:
-
String
column
-
String
resultAlias
Since:
06-26-2008
min(String column, String resultAlias)
calculates the min of the specified column using the specified resultAlias
Parameters:
-
String
column
-
String
resultAlias
Since:
06-26-2008
minute(String column, String resultAlias)
returns the minute of the specified date column as a number 0-59 using the specified resultAlias
Parameters:
-
String
column
-
String
resultAlias
Since:
01-14-2009
month(String column, String resultAlias)
returns the month portion of the specified date column as a number 1-12 using the specified resultAlias
Parameters:
-
String
column
-
String
resultAlias
Since:
01-14-2009
quarter(String column, String resultAlias)
returns the quarter of the specified date column as a number 1-4 using the specified resultAlias
Parameters:
-
String
column
-
String
resultAlias
Since:
01-14-2009
reset()
Resets the filter (equivalent of creating a new filter).
Since:
06-04-2008
second(String column, String resultAlias)
returns the second of the specified date column as a number 0-59 using the specified resultAlias
Parameters:
-
String
column
-
String
resultAlias
Since:
01-14-2009
selectColumn(String column)
Explicitly select the specified column.
Parameters:
-
String
column
Required parameter.
Since:
06-04-2008
selectColumns(String[] columns)
Explicitly select the specified columns.
Parameters:
Since:
06-04-2008
setDateFormat(String pattern)
Sets the date pattern for date strings used in criteria.
Parameters:
Since:
06-09-2011
DataViewCriteria setFirstRecord(int firstRecord)
Set the first record to return.
Parameters:
Returns:
DataViewCriteria
Since:
10-11-2010
DataViewCriteria setMaxPageSize()
Set the page size to the maximum allowed by the key.
Returns:
DataViewCriteria
Since:
05-30-2013
DataViewCriteria setPageSize(int size)
Set the page size (max 1000 or limit controlled by the activation key, min 1, default 100). See also setMaxPageSize.
Parameters:
Returns:
DataViewCriteria
Since:
10-11-2010
DataViewCriteria setQueryTimeout(int timeout)
Sets the timeout for the query. By default this is 10 seconds and the maximum is defined by the cloud configuration.
Parameters:
-
int
timeout
Required parameter.
Returns:
DataViewCriteria
Since:
03-13-2018
DataViewCriteria sortAscending(String column)
Sorts the results in ascending order on the given column.
Parameters:
-
String
column
Required parameter.
Returns:
DataViewCriteria
Since:
06-04-2008
DataViewFilter sortAscending(String column)
Sorts the results in ascending order on the given column.
Parameters:
-
String
column
Required parameter.
Returns:
DataViewFilter
Since:
06-04-2008
DataViewFilter sortDescending(String column)
Sorts the results in descending order on the given column.
Parameters:
-
String
column
Required parameter.
Returns:
DataViewFilter
Since:
06-04-2008
DataViewCriteria sortDescending(String column)
Sorts the results in descending order on the given column.
Parameters:
-
String
column
Required parameter.
Returns:
DataViewCriteria
Since:
06-04-2008
standardDeviation(String column, String resultAlias)
calculates the population standard deviation of the specified column using the specified resultAlias
Parameters:
-
String
column
-
String
resultAlias
Since:
12-03-2009
sum(String column, String resultAlias)
calculates the sum of the specified column using the specified resultAlias
Parameters:
-
String
column
-
String
resultAlias
Since:
06-26-2008
timeDiff(String leftDateColumn, String rightDateColumn, String resultAlias, String unit)
Returns the difference in unit between the value of the two datetime columns.
Parameters:
-
String
leftDateColumn
- left date column name.
-
String
rightDateColumn
- right date column name.
-
String
resultAlias
- result column name.
-
String
unit
- Unit of time difference.
Allowed values: second, minute, hour, day, week, month, quarter, year.
Since:
08-11-2010
timeDiffCompare(String dateColumn, String resultAlias, Date compareDate, String unit)
Returns the difference in unit between the value of the datetime column and the compare datetime. If compareDate is null, the current datetime is used.
Parameters:
-
String
dateColumn
- date column name.
-
String
resultAlias
- result column name.
-
Date
compareDate
- date for comparison.
-
String
unit
- Unit of time difference.
Allowed values: second, minute, hour, day, week, month, quarter, year.
Since:
08-06-2015
String toString()
Returns a description of this object.
Returns:
String
Since:
06-04-2008
week(String column, String resultAlias)
returns the week number of the specified date column as a number 0-52 using the specified resultAlias
Parameters:
-
String
column
-
String
resultAlias
Since:
01-14-2009
weekOfYear(String column, String resultAlias)
returns the week of the year of the specified date column as a number 0-53 using the specified resultAlias
Parameters:
-
String
column
-
String
resultAlias
Since:
10-26-2009
weekday(String column, String resultAlias)
returns the weekday of the specified date column as a number 0-6 (0 = Monday, 1 = Tuesday, ... 6 = Sunday) using the specified resultAlias
Parameters:
-
String
column
-
String
resultAlias
Since:
10-26-2009
year(String column, String resultAlias)
returns the year portion of the specified date column using the specified resultAlias
Parameters:
-
String
column
-
String
resultAlias
Since:
01-14-2009