com.partnersoft.io

Class DataRecordQuery

java.lang.Object

com.partnersoft.io.DataRecordQuery

All Implemented Interfaces:

Coggable, Immutable

public class DataRecordQuery
extends java.lang.Object
implements Immutable, Coggable

Abstraction of a query. Contains filtering , sorting, and field information.

Copyright 2009 Partner Software, Inc.

Author:

Rich Stepanski

Constructor Summary

Constructors

Constructor and Description
DataRecordQuery(Cog cog) Creates a new DataRecordQuery from the passed cog.
DataRecordQuery(DataFilterExpression filter, java.util.List<java.lang.String> fieldNames) Creates a new DataRecordQuery
DataRecordQuery(DataFilterExpression filter, java.util.List<java.lang.String> fieldNames, java.util.List<DataFilterSort> sorts) Creates a new DataRecordQuery.
DataRecordQuery(DataFilterExpression filter, java.util.List<java.lang.String> fieldNames, java.util.List<DataFilterSort> sorts, int startRow, int numberOfRecords) Creates a new DataRecordQuery.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
boolean	equalsIgnoreRows(DataRecordQuery other) Returns true if the passed DataRecordQuery's DataFilterExpression, DataFilterSorts and field lists are the same.
java.util.List<java.lang.String>	getContent() Deprecated. Use getFields() instead
java.util.List<java.lang.String>	getFields() Returns a copy List of field names.
DataFilterExpression	getFilter() Returns DataFilterExpression for this query, which may be null
int	getNumberOfRecords() Returns number of records for query.
java.util.List<DataFilterSort>	getSorts() Returns copy List of DataFilterSorts
int	getStartRow() Returns start row for query or -1 if not set.
int	hashCode()
Cog	toCog() Returns the complete internal state of this object in the form of a Cog.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DataRecordQuery

public DataRecordQuery(DataFilterExpression filter,
               java.util.List<java.lang.String> fieldNames)

Creates a new DataRecordQuery

Parameters:

filter - - DataFilterExpression to filter query

fieldNames - - List of field names

DataRecordQuery

public DataRecordQuery(Cog cog)

Creates a new DataRecordQuery from the passed cog.

Parameters:

cog -

DataRecordQuery

public DataRecordQuery(DataFilterExpression filter,
               java.util.List<java.lang.String> fieldNames,
               java.util.List<DataFilterSort> sorts)

Creates a new DataRecordQuery.

Parameters:

filter - - DataFilterExpression to filter query

fieldNames - - List of field names to query.

sorts - - DataFilterSorts to apply.

DataRecordQuery

public DataRecordQuery(DataFilterExpression filter,
               java.util.List<java.lang.String> fieldNames,
               java.util.List<DataFilterSort> sorts,
               int startRow,
               int numberOfRecords)

Creates a new DataRecordQuery.

Parameters:

filter - - DataFilterExpression to filter query

fieldNames - - List of field names to query.

sorts - - DataFilterSorts to apply.

startRow - - First row to begin query at, if -1 first row is start row.

numberOfRecords - - Number of records to have in query, if -1 all records are returned.

Method Detail

getFilter

public DataFilterExpression getFilter()

Returns DataFilterExpression for this query, which may be null

Returns:

DataFilterExpression

getContent

public java.util.List<java.lang.String> getContent()

Deprecated. Use getFields() instead

Returns a copy List of field names.

Returns:

copy List of field names.

getFields

public java.util.List<java.lang.String> getFields()

Returns a copy List of field names.

Returns:

copy List of field names.

getSorts

public java.util.List<DataFilterSort> getSorts()

Returns copy List of DataFilterSorts

Returns:

copy List of DataFilterSorts

getStartRow

public int getStartRow()

Returns start row for query or -1 if not set.

Returns:

start row

getNumberOfRecords

public int getNumberOfRecords()

Returns number of records for query.

Returns:

number of records for query.

equalsIgnoreRows

public boolean equalsIgnoreRows(DataRecordQuery other)

Returns true if the passed DataRecordQuery's DataFilterExpression, DataFilterSorts and field lists are the same.

This ignores start row and number of records.

Parameters:

other - - DataRecordQuery to compare against.

Returns:

true if passed DataRecordQuery matches this in everything but start row and number of records.

toCog

public Cog toCog()

Description copied from interface: Coggable

Returns the complete internal state of this object in the form of a Cog.

Specified by:

toCog in interface Coggable

Returns:

Cog representing the internal state of this object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object