DataViewFilter extends DataViewCriteria

Method Summary
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	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	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.
DataViewCriteria	beginGroup() Begins a group of statements.
	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.
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.
boolean	hasColumn(String column) Returns true if the specified column exists for queries.
boolean	isDecryptEnabled() Returns true if decryption is enabled.
	reset() Resets the filter (equivalent of creating a new filter).
	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.
String	toString() Returns a description of this object.

Method Detail

DataViewCriteria addAnd()

Adds an AND operator to the query.

Returns: DataViewCriteria

Since: 10-11-2010

top

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

top

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

top

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

top

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:

DataViewFilter filter Required parameter.

Since: 08-09-2022

top

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

top

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

top

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

top

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

top

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

top

DataViewCriteria addIsNull(String column)

Include records where column specified is null

Parameters:

String column Required parameter.

Returns: DataViewCriteria

Since: 10-11-2010

top

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

top

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

top

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

top

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

top

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

top

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

top

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

top

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

top

DataViewCriteria addNotNull(String column)

Include records where column specified is not null

Parameters:

String column Required parameter.

Returns: DataViewCriteria

Since: 10-11-2010

top

DataViewCriteria addOr()

Adds an OR operator to the query.

Returns: DataViewCriteria

Since: 10-11-2010

top

DataViewCriteria beginGroup()

Begins a group of statements.

Returns: DataViewCriteria

Since: 10-11-2010

top

enableDecrypt(boolean enabled)

Decrypts values of encrypted columns. This has a performance impact, especially for large lists.

Parameters:

boolean enabled

Since: 07-14-2010

top

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

top

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

top

DataViewCriteria endGroup()

Ends a group of statements.

Returns: DataViewCriteria

Since: 10-11-2010

top

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: