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.

Version:

$Id$

Author:

Rich Stepanski

Constructor Summary

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

java.util.List<java.lang.String>	getContent() Returns List of field names for query.
DataFilterExpression	getFilter() Returns DataRecordFilter for this query.
int	getNumberOfRecords() Returns number of records for query.
java.util.List<DataFilterSort>	getSorts() Returns List of DataRecordFilterSort sorts for this query.
int	getStartRow() Returns start row for query or -1 if not set.
Cog	toCog() Returns the complete internal state of this object in the form of a Cog.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, 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 -

fieldNames -

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 - - Filter defining queries.

fieldNames - - Field names to query.

sorts - - Any sorts to apply to query.

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 - - Filter defining queries.

fieldNames - - Field names to query, cannot be null.

sorts - - Any sorts to apply to query, if null no sorts are used.

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 DataRecordFilter for this query.

getContent

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

Returns List of field names for query.

Returns:

getSorts

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

Returns List of DataRecordFilterSort sorts for this query.

Returns:

getStartRow

public int getStartRow()

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

Returns:

getNumberOfRecords

public int getNumberOfRecords()

Returns number of records for query.

Returns:

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