FactualQuery |
Encapsulates all the parameters supported by the Factual Query API
Superclass: NSObject
Declared In: FactualQuery.h
To query a Factual table, you must first construct a Query object and specify some basic row selection criteria. You can optionally construct an empty Query object, which will return to you the first (limit) number of rows using a table's default sort order. There are some restrictions on what combinations of filters are valid in certain circumstances. Read the property / method descriptions for more details
rowId |
@property ( nonatomic, copy) NSString* rowId;
filter the results by a specific row id. Setting a rowId filter invalidates all other filter criteria and returns either 0 or 1 records
offset |
@property ( nonatomic, assign) NSUInteger offset;
used to specify the offset (number of records to skip) when paginating a large record set.
limit |
@property ( nonatomic, assign) NSUInteger limit;
used to limit the number of returned records in a single response. This system will return the lessor of either the limit value or the max limit value associated with the user's API Key. paginating a large record set.
primarySortCriteria |
@property ( nonatomic, retain) FactualSortCriteria* primarySortCriteria;
set the primary sort criteria for the query in context. This parameter is ignored in the case of full-text (see below) or geo (see below queries).
secondarySortCriteria |
@property ( nonatomic, retain) FactualSortCriteria* secondarySortCriteria;
set the secondary sort criteria for the query in context. Same restrictions as the pimrary sort criteria
rowFilters |
@property ( nonatomic, readonly) NSMutableArray* rowFilters;
row filter that are going to be applied to this query
fullTextTerms |
@property( nonatomic, readonly) NSMutableArray* fullTextTerms;
text query terms used to perform a full-text query
Last Updated: Friday, January 28, 2011