Inherits from | |
Conforms to | |
Framework | /System/Library/Frameworks/Foundation.framework |
Availability | Available in Mac OS X v10.4 and later. |
Companion guide | |
Declared in | NSComparisonPredicate.h |
Related sample code |
NSComparisonPredicate
is a subclass of NSPredicate
used to compare expressions.
Comparison predicates are predicates used to compare the results of two expressions. Comparison predicates take an operator, a left expression, and a right expression, and return as a BOOL
the result of invoking the operator with the results of evaluating the expressions. Expressions are represented by instances of the NSExpression
class.
+ predicateWithLeftExpression:rightExpression:customSelector:
+ predicateWithLeftExpression:rightExpression:modifier:type:options:
– initWithLeftExpression:rightExpression:customSelector:
– initWithLeftExpression:rightExpression:modifier:type:options:
– comparisonPredicateModifier
– customSelector
– leftExpression
– options
– predicateOperatorType
– rightExpression
Returns a new predicate formed by combining the left and right expressions using a given selector.
+ (NSPredicate *)predicateWithLeftExpression:(NSExpression *)lhs rightExpression:(NSExpression *)rhs customSelector:(SEL)selector
The left hand side expression.
The right hand side expression.
The selector to use for comparison. The method defined by the selector must take a single argument and return a BOOL
value.
A new predicate formed by combining the left and right expressions using selector
.
NSComparisonPredicate.h
Creates and returns a predicate of a given type formed by combining given left and right expressions using a given modifier and options.
+ (NSPredicate *)predicateWithLeftExpression:(NSExpression *)lhs rightExpression:(NSExpression *)rhs modifier:(NSComparisonPredicateModifier)modifier type:(NSPredicateOperatorType)type options:(NSUInteger)options
The left hand expression.
The right hand expression.
The modifier to apply.
The predicate operator type.
The options to apply (see NSComparisonPredicate Options).
A new predicate of type type formed by combining the given left and right expressions using the modifier and options.
NSComparisonPredicate.h
Returns the comparison predicate modifier for the receiver.
- (NSComparisonPredicateModifier)comparisonPredicateModifier
The comparison predicate modifier for the receiver.
The default value is NSDirectPredicateModifier
.
NSComparisonPredicate.h
Returns the selector for the receiver.
- (SEL)customSelector
The selector for the receiver, or NULL
if there is none.
NSComparisonPredicate.h
Initializes a predicate formed by combining given left and right expressions using a given selector.
- (id)initWithLeftExpression:(NSExpression *)lhs rightExpression:(NSExpression *)rhs customSelector:(SEL)selector
The left hand expression.
The right hand expression.
The selector to use. The method defined by the selector must take a single argument and return a BOOL
value.
The receiver, initialized by combining the left and right expressions using selector.
NSComparisonPredicate.h
Initializes a predicate to a given type formed by combining given left and right expressions using a given modifier and options.
- (id)initWithLeftExpression:(NSExpression *)lhs rightExpression:(NSExpression *)rhs modifier:(NSComparisonPredicateModifier)modifier type:(NSPredicateOperatorType)type options:(NSUInteger)options
The left hand expression.
The right hand expression.
The modifier to apply.
The predicate operator type.
The options to apply (see NSComparisonPredicate Options).
The receiver, initialized to a predicate of type type formed by combining the left and right expressions using the modifier and options.
NSComparisonPredicate.h
Returns the left expression for the receiver.
- (NSExpression *)leftExpression
The left expression for the receiver, or nil
if there is none.
NSComparisonPredicate.h
Returns the options that are set for the receiver.
- (NSUInteger)options
The options that are set for the receiver.
NSComparisonPredicate.h
Returns the predicate type for the receiver.
- (NSPredicateOperatorType)predicateOperatorType
The predicate type for the receiver.
NSComparisonPredicate.h
Returns the right expression for the receiver.
- (NSExpression *)rightExpression
The right expression for the receiver, or nil
if there is none.
NSComparisonPredicate.h
These constants describe the possible types of modifier for NSComparisonPredicate
.
typedef enum { NSDirectPredicateModifier = 0, NSAllPredicateModifier, NSAnyPredicateModifier, } NSComparisonPredicateModifier;
NSDirectPredicateModifier
A predicate to compare directly the left and right hand sides.
Available in Mac OS X v10.4 and later.
Declared in NSComparisonPredicate.h
.
NSAllPredicateModifier
A predicate to compare all entries in the destination of a to-many relationship.
The left hand side must be a collection. The corresponding predicate compares each value in the left hand side with the right hand side, and returns NO
when it finds the first mismatch—or YES
if all match.
Available in Mac OS X v10.4 and later.
Declared in NSComparisonPredicate.h
.
NSAnyPredicateModifier
A predicate to match with any entry in the destination of a to-many relationship.
The left hand side must be a collection. The corresponding predicate compares each value in the left hand side against the right hand side and returns YES
when it finds the first match—or NO
if no match is found
Available in Mac OS X v10.4 and later.
Declared in NSComparisonPredicate.h
.
NSComparisonPredicate.h
These constants describe the possible types of string comparison for NSComparisonPredicate
.
enum { NSCaseInsensitivePredicateOption = 0x01, NSDiacriticInsensitivePredicateOption = 0x02, };
NSCaseInsensitivePredicateOption
A case-insensitive predicate.
Available in Mac OS X v10.4 and later.
Declared in NSComparisonPredicate.h
.
NSDiacriticInsensitivePredicateOption
A diacritic-insensitive predicate.
Available in Mac OS X v10.4 and later.
Declared in NSComparisonPredicate.h
.
NSComparisonPredicate.h
Defines the type of comparison for NSComparisonPredicate
.
typedef enum { NSLessThanPredicateOperatorType = 0, NSLessThanOrEqualToPredicateOperatorType, NSGreaterThanPredicateOperatorType, NSGreaterThanOrEqualToPredicateOperatorType, NSEqualToPredicateOperatorType, NSNotEqualToPredicateOperatorType, NSMatchesPredicateOperatorType, NSLikePredicateOperatorType, NSBeginsWithPredicateOperatorType, NSEndsWithPredicateOperatorType, NSInPredicateOperatorType, NSCustomSelectorPredicateOperatorType, NSContainsPredicateOperatorType, NSBetweenPredicateOperatorType } NSPredicateOperatorType;
NSLessThanPredicateOperatorType
A less-than predicate.
Available in Mac OS X v10.4 and later.
Declared in NSComparisonPredicate.h
.
NSLessThanOrEqualToPredicateOperatorType
A less-than-or-equal-to predicate.
Available in Mac OS X v10.4 and later.
Declared in NSComparisonPredicate.h
.
NSGreaterThanPredicateOperatorType
A greater-than predicate.
Available in Mac OS X v10.4 and later.
Declared in NSComparisonPredicate.h
.
NSGreaterThanOrEqualToPredicateOperatorType
A greater-than-or-equal-to predicate.
Available in Mac OS X v10.4 and later.
Declared in NSComparisonPredicate.h
.
NSEqualToPredicateOperatorType
An equal-to predicate.
Available in Mac OS X v10.4 and later.
Declared in NSComparisonPredicate.h
.
NSNotEqualToPredicateOperatorType
A not-equal-to predicate.
Available in Mac OS X v10.4 and later.
Declared in NSComparisonPredicate.h
.
NSMatchesPredicateOperatorType
A full regular expression matching predicate.
Available in Mac OS X v10.4 and later.
Declared in NSComparisonPredicate.h
.
NSLikePredicateOperatorType
A simple subset of the matches predicate, similar in behavior to SQL LIKE
.
Available in Mac OS X v10.4 and later.
Declared in NSComparisonPredicate.h
.
NSBeginsWithPredicateOperatorType
A begins-with predicate.
Available in Mac OS X v10.4 and later.
Declared in NSComparisonPredicate.h
.
NSEndsWithPredicateOperatorType
An ends-with predicate.
Available in Mac OS X v10.4 and later.
Declared in NSComparisonPredicate.h
.
NSInPredicateOperatorType
A predicate to determine if the left hand side is in the right hand side.
For strings, returns YES
if the left hand side is a substring of the right hand side . For collections, returns YES
if the left hand side is in the right hand side .
Available in Mac OS X v10.4 and later.
Declared in NSComparisonPredicate.h
.
NSCustomSelectorPredicateOperatorType
Predicate that uses a custom selector that takes a single argument and returns a BOOL
value.
The selector is invoked on the left hand side with the right hand side.
Available in Mac OS X v10.4 and later.
Declared in NSComparisonPredicate.h
.
NSContainsPredicateOperatorType
A predicate to determine if the left hand side contains the right hand side.
Returns YES
if [lhs contains rhs]
; the left hand side must be an NSExpression
object that evaluates to a collection
Available in Mac OS X v10.5 and later.
Declared in NSComparisonPredicate.h
.
NSBetweenPredicateOperatorType
A predicate to determine if the right hand side lies between bounds specified by the left hand side.
Returns YES
if [lhs between rhs]
; the right hand side must be an array in which the first element sets the lower bound and the second element the upper, inclusive. Comparison is performed using compare: or the class-appropriate equivalent.
Available in Mac OS X v10.5 and later.
Declared in NSComparisonPredicate.h
.
NSComparisonPredicate.h
© 2007 Apple Inc. All Rights Reserved. (Last updated: 2007-04-30)