FactualRowFilter


Represents single or groups of filter predicates.

Superclass: NSObject
Declared In: FactualQuery.h

Discussion

You can associate an arbitrary number for row filters to Factual Query. Row filters can either be a simple field name predicate value triple, or an AND or OR predicate than contains one or more row filters. All top level row filters are ANDed together during query execution time (including the full text and geo filters - see Query).

A simple filter can be constructed as follows: FactualRowFilter* simpleFilter = [FactualRowFilter fieldName:@"name" equalTo:@"John Bolton"]; An AND might be constructed as follows: FactualRowFilter* andFilter = [FactualRowFilter andFilter: [FactualRowFilter fieldName:@"name" equalTo:@"John Bolton"], [FactualRowFilter orFilter: [FactualRowFilter fieldName:@"profession" equalTo:@"Singer"], [FactualRowFilter fieldName:@"profession" equalTo:@"SongWriter"]]];

which basically bolis down to: name="JohnBolton" AND (profession="Singer" OR profession="SongWriter")



Methods

+fieldName:equalTo:
+fieldName:notEqualTo:
+fieldName:greaterThan:
+fieldName:lessThan:
+fieldName:greaterThanOrEqualTo:
+fieldName:lessThanOrEqualTo:
+fieldName:In:
+fieldName:InArray:
+fieldName:beginsWith:
+orFilter:
+orFilterWithArray:
+andFilter:
+andFilterWithArray:

fieldName:equalTo:


+(FactualRowFilter*) fieldName:(NSString*) fieldName equalTo:(id) value; 
Discussion

construct an equalTo filter


fieldName:notEqualTo:


+(FactualRowFilter*) fieldName:(NSString*) fieldName 
        notEqualTo:(id) value; 
Discussion

construct a notEqualTo filter


fieldName:greaterThan:


+(FactualRowFilter*) fieldName:(NSString*) fieldName 
        greaterThan:(id) value; 
Discussion

construct a greater than filter


fieldName:lessThan:


+(FactualRowFilter*) fieldName:(NSString*) fieldName 
        lessThan:(id) value; 
Discussion

construct a less than filter


fieldName:greaterThanOrEqualTo:


+(FactualRowFilter*) fieldName:(NSString*) fieldName 
        greaterThanOrEqualTo:(id) value; 
Discussion

construct a greater than or equal to filter


fieldName:lessThanOrEqualTo:


+(FactualRowFilter*) fieldName:(NSString*) fieldName 
        lessThanOrEqualTo:(id) value; 
Discussion

construct a less than or equal to filter


fieldName:In:


+(FactualRowFilter*) fieldName:(NSString*) fieldName In:(id) value,... NS_REQUIRES_NIL_TERMINATION; 
Discussion

construct an OR filter using the IN predicate


fieldName:InArray:


+(FactualRowFilter*) fieldName:(NSString*) fieldName InArray:(NSArray*) values; 
Discussion

construct an OR filter using the IN predicate with an array of values


fieldName:beginsWith:


+(FactualRowFilter*) fieldName:(NSString*) fieldName 
        beginsWith:(NSString*) value; 
Discussion

construct a prefix match text filter (on a particular field)


orFilter:


+(FactualRowFilter*) orFilter:(FactualRowFilter*)rowFilter,... NS_REQUIRES_NIL_TERMINATION; 
Discussion

construct an OR filter consisting of one or more nested filters followed by a nil


orFilterWithArray:


Throws:
  • NSException if NSArray value is nil or not of type FactualRowFilter
+(FactualRowFilter*) orFilterWithArray:(NSArray*)rowFilters; 
Discussion

construct an OR filter consisting of an array of nested filters followed by a nil


andFilter:


+(FactualRowFilter*) andFilter:(FactualRowFilter*)rowFilter,... NS_REQUIRES_NIL_TERMINATION; 
Discussion

construct an AND filter consisting of one or more nested filters followed by a nil


andFilterWithArray:


Throws:
  • NSException if NSArray value is nil or not of type FactualRowFilter
+(FactualRowFilter*) andFilterWithArray:(NSArray*)rowFilters; 
Discussion

construct an AND filter consisting of an array of nested filters followed by a nil

Last Updated: Friday, January 28, 2011