layout | title | category | tags | excerpt |
---|---|---|---|---|
post |
NSPredicate |
Cocoa |
popular |
NSPredicate is a Foundation class that specifies how data should be fetched or filtered. Its query language, which is like a cross between a SQL WHERE clause and a regular expression, provides an expressive, natural language interface to define logical conditions on which a collection is searched. |
NSPredicate
is a Foundation class that specifies how data should be fetched or filtered. Its query language, which is like a cross between a SQL WHERE
clause and a regular expression, provides an expressive, natural language interface to define logical conditions on which a collection is searched.
It's easier to show NSPredicate
in use, rather than talk about it in the abstract, so we're going to revisit the example data set used in the NSSortDescriptor
article:
firstName |
lastName |
age |
---|---|---|
Alice | Smith | 24 |
Bob | Jones | 27 |
Charlie | Smith | 33 |
Quentin | Alberts | 31 |
@interface Person : NSObject
@property NSString *firstName;
@property NSString *lastName;
@property NSNumber *age;
@end
@implementation Person
- (NSString *)description {
return [NSString stringWithFormat:@"%@ %@", self.firstName, self.lastName];
}
@end
#pragma mark -
NSArray *firstNames = @[ @"Alice", @"Bob", @"Charlie", @"Quentin" ];
NSArray *lastNames = @[ @"Smith", @"Jones", @"Smith", @"Alberts" ];
NSArray *ages = @[ @24, @27, @33, @31 ];
NSMutableArray *people = [NSMutableArray array];
[firstNames enumerateObjectsUsingBlock:^(id obj, NSUInteger idx, BOOL *stop) {
Person *person = [[Person alloc] init];
person.firstName = firstNames[idx];
person.lastName = lastNames[idx];
person.age = ages[idx];
[people addObject:person];
}];
NSPredicate *bobPredicate = [NSPredicate predicateWithFormat:@"firstName = 'Bob'"];
NSPredicate *smithPredicate = [NSPredicate predicateWithFormat:@"lastName = %@", @"Smith"];
NSPredicate *thirtiesPredicate = [NSPredicate predicateWithFormat:@"age >= 30"];
// ["Bob Jones"]
NSLog(@"Bobs: %@", [people filteredArrayUsingPredicate:bobPredicate]);
// ["Alice Smith", "Charlie Smith"]
NSLog(@"Smiths: %@", [people filteredArrayUsingPredicate:smithPredicate]);
// ["Charlie Smith", "Quentin Alberts"]
NSLog(@"30's: %@", [people filteredArrayUsingPredicate:thirtiesPredicate]);
class Person: NSObject {
let firstName: String
let lastName: String
let age: Int
init(firstName: String, lastName: String, age: Int) {
self.firstName = firstName
self.lastName = lastName
self.age = age
}
override var description: String {
return "\(firstName) \(lastName)"
}
}
let alice = Person(firstName: "Alice", lastName: "Smith", age: 24)
let bob = Person(firstName: "Bob", lastName: "Jones", age: 27)
let charlie = Person(firstName: "Charlie", lastName: "Smith", age: 33)
let quentin = Person(firstName: "Quentin", lastName: "Alberts", age: 31)
let people = [alice, bob, charlie, quentin]
let bobPredicate = NSPredicate(format: "firstName = 'Bob'")
let smithPredicate = NSPredicate(format: "lastName = %@", "Smith")
let thirtiesPredicate = NSPredicate(format: "age >= 30")
(people as NSArray).filteredArrayUsingPredicate(bobPredicate)
// ["Bob Jones"]
(people as NSArray).filteredArrayUsingPredicate(smithPredicate)
// ["Alice Smith", "Charlie Smith"]
(people as NSArray).filteredArrayUsingPredicate(thirtiesPredicate)
// ["Charlie Smith", "Quentin Alberts"]
Foundation provides methods to filter NSArray
/ NSMutableArray
& NSSet
/ NSMutableSet
with predicates.
Immutable collections, NSArray
& NSSet
, have the methods filteredArrayUsingPredicate:
and filteredSetUsingPredicate:
which return an immutable collection by evaluating a predicate on the receiver.
Mutable collections, NSMutableArray
& NSMutableSet
have the method filterUsingPredicate:
, which removes any objects that evaluate to FALSE
when running the predicate on the receiver.
NSDictionary
can use predicates by filtering its keys or values (both NSArray
objects). NSOrderedSet
can either create new ordered sets from a filtered NSArray
or NSSet
, or alternatively, NSMutableSet
can simply removeObjectsInArray:
, passing objects filtered with the negated predicate.
NSFetchRequest
has a predicate
property, which specifies the logical conditions under which managed objects should be retrieved. The same rules apply, except that predicates are evaluated by the persistent store coordinator within a managed object context, rather than collections being filtered in-memory.
%@
is a var arg substitution for an object value—often a string, number, or date.%K
is a var arg substitution for a key path.
NSPredicate *ageIs33Predicate = [NSPredicate predicateWithFormat:@"%K = %@", @"age", @33];
// ["Charlie Smith"]
NSLog(@"Age 33: %@", [people filteredArrayUsingPredicate:ageIs33Predicate]);
let ageIs33Predicate = NSPredicate(format: "%K = %@", "age", "33")
(people as NSArray).filteredArrayUsingPredicate(ageIs33Predicate)
// ["Charlie Smith"]
$VARIABLE_NAME
is a value that can be substituted withNSPredicate -predicateWithSubstitutionVariables:
.
NSPredicate *namesBeginningWithLetterPredicate = [NSPredicate predicateWithFormat:@"(firstName BEGINSWITH[cd] $letter) OR (lastName BEGINSWITH[cd] $letter)"];
// ["Alice Smith", "Quentin Alberts"]
NSLog(@"'A' Names: %@", [people filteredArrayUsingPredicate:[namesBeginningWithLetterPredicate predicateWithSubstitutionVariables:@{@"letter": @"A"}]]);
let namesBeginningWithLetterPredicate = NSPredicate(format: "(firstName BEGINSWITH[cd] $letter) OR (lastName BEGINSWITH[cd] $letter)")
(people as NSArray).filteredArrayUsingPredicate(namesBeginningWithLetterPredicate.predicateWithSubstitutionVariables(["letter": "A"]))
// ["Alice Smith", "Quentin Alberts"]
=
,==
: The left-hand expression is equal to the right-hand expression.>=
,=>
: The left-hand expression is greater than or equal to the right-hand expression.<=
,=<
: The left-hand expression is less than or equal to the right-hand expression.>
: The left-hand expression is greater than the right-hand expression.<
: The left-hand expression is less than the right-hand expression.!=
,<>
: The left-hand expression is not equal to the right-hand expression.BETWEEN
: The left-hand expression is between, or equal to either of, the values specified in the right-hand side. The right-hand side is a two value array (an array is required to specify order) giving upper and lower bounds. For example,1 BETWEEN { 0 , 33 }
, or$INPUT BETWEEN { $LOWER, $UPPER }
.
AND
,&&
: LogicalAND
.OR
,||
: LogicalOR
.NOT
,!
: LogicalNOT
.
String comparisons are by default case and diacritic sensitive. You can modify an operator using the key characters c and d within square braces to specify case and diacritic insensitivity respectively, for example firstName BEGINSWITH[cd] $FIRST_NAME.
BEGINSWITH
: The left-hand expression begins with the right-hand expression.CONTAINS
: The left-hand expression contains the right-hand expression.ENDSWITH
: The left-hand expression ends with the right-hand expression.LIKE
: The left hand expression equals the right-hand expression:?
and*
are allowed as wildcard characters, where?
matches 1 character and*
matches 0 or more characters.MATCHES
: The left hand expression equals the right hand expression using a regex-style comparison according to ICU v3 (for more details see the ICU User Guide for Regular Expressions).
ANY
,SOME
: Specifies any of the elements in the following expression. For example,ANY children.age < 18
.ALL
: Specifies all of the elements in the following expression. For example,ALL children.age < 18
.NONE
: Specifies none of the elements in the following expression. For example,NONE children.age < 18
. This is logically equivalent toNOT (ANY ...)
.IN
: Equivalent to an SQLIN
operation, the left-hand side must appear in the collection specified by the right-hand side. For example,name IN { 'Ben', 'Melissa', 'Nick' }
.
array[index]
: Specifies the element at the specified index inarray
.array[FIRST]
: Specifies the first element inarray
.array[LAST]
: Specifies the last element inarray
.array[SIZE]
: Specifies the size ofarray
.
TRUEPREDICATE
: A predicate that always evaluates toTRUE
.FALSEPREDICATE
: A predicate that always evaluates toFALSE
.
We saw that AND
& OR
can be used in predicate format strings to create compound predicates. However, the same can be accomplished using an NSCompoundPredicate
.
For example, the following predicates are equivalent:
[NSCompoundPredicate andPredicateWithSubpredicates:@[[NSPredicate predicateWithFormat:@"age > 25"], [NSPredicate predicateWithFormat:@"firstName = %@", @"Quentin"]]];
[NSPredicate predicateWithFormat:@"(age > 25) AND (firstName = %@)", @"Quentin"];
NSCompoundPredicate(type: .AndPredicateType, subpredicates: [NSPredicate(format: "age > 25"), NSPredicate(format: "firstName = %@", "Quentin")])
NSPredicate(format: "(age > 25) AND (firstName = %@)", "Quentin")
While the syntax string literal is certainly easier to type, there are occasions where you may need to combine existing predicates. In these cases, NSCompoundPredicate -andPredicateWithSubpredicates:
& -orPredicateWithSubpredicates:
is the way to go.
Similarly, if after reading last week's article you now find yourself with more NSExpression
objects than you know what to do with, NSComparisonPredicate
can help you out.
Like NSCompoundPredicate
, NSComparisonPredicate
constructs an NSPredicate
from subcomponents—in this case, NSExpression
s on the left and right hand sides.
Analyzing its class constructor provides a glimpse into the way NSPredicate
format strings are parsed:
+ (NSPredicate *)predicateWithLeftExpression:(NSExpression *)lhs
rightExpression:(NSExpression *)rhs
modifier:(NSComparisonPredicateModifier)modifier
type:(NSPredicateOperatorType)type
options:(NSUInteger)options
lhs
: The left hand expression.rhs
: The right hand expression.modifier
: The modifier to apply. (ANY
orALL
)type
: The predicate operator type.options
: The options to apply. For no options, pass0
.