NSCompoundPredicate Class Reference

Overview

NSCompoundPredicate is a subclass of NSPredicate used to represent logical “gate” operations (AND/OR/NOT) and comparison operations.

Comparison operations are based on two expressions, as represented by instances of the NSExpression class. Expressions are created for constant values, key paths, and so on.

On Mac OS X v10.5 and later and on iPhone OS, NSCompoundPredicate allows you to create an AND or OR compound predicate (but not a NOT compound predicate) using an array with 0, 1, or more elements. A compound predicate with 0 elements evaluates to TRUE, and a compound predicate with a single sub-predicate evaluates to the truth of its sole subpredicate.

Tasks

Constructors

• + andPredicateWithSubpredicates:
• + notPredicateWithSubpredicate:
• + orPredicateWithSubpredicates:
• – initWithType:subpredicates:

Getting Information About a Compound Predicate

• – compoundPredicateType
• – subpredicates

Class Methods

andPredicateWithSubpredicates:

Returns a new predicate formed by AND-ing the predicates in a given array.

+ (NSPredicate *)andPredicateWithSubpredicates:(NSArray *)subpredicates

Parameters

subpredicates

An array of NSPredicate objects.

Return Value

A new predicate formed by AND-ing the predicates specified by subpredicates.

Availability

• Available in Mac OS X v10.4 and later.

Related Sample Code

• iSpend
• PhotoSearch
• Spotlighter
• SpotlightFortunes

Declared In

NSCompoundPredicate.h

notPredicateWithSubpredicate:

Returns a new predicate formed by NOT-ing a given predicate.

+ (NSPredicate *)notPredicateWithSubpredicate:(NSPredicate *)predicate

Parameters

predicate

A predicate.

Return Value

A new predicate formed by NOT-ing the predicate specified by predicate.

Availability

• Available in Mac OS X v10.4 and later.

Declared In

NSCompoundPredicate.h

orPredicateWithSubpredicates:

Returns a new predicate formed by OR-ing the predicates in a given array.

+ (NSPredicate *)orPredicateWithSubpredicates:(NSArray *)subpredicates

Parameters

subpredicates

An array of NSPredicate objects.

Return Value

A new predicate formed by OR-ing the predicates specified by subpredicates.

Availability

• Available in Mac OS X v10.4 and later.

Related Sample Code

• iSpend
• Spotlighter

Declared In

NSCompoundPredicate.h

Instance Methods

compoundPredicateType

Returns the predicate type for the receiver.

- (NSCompoundPredicateType)compoundPredicateType

Return Value

The predicate type for the receiver.

Availability

• Available in Mac OS X v10.4 and later.

Declared In

NSCompoundPredicate.h

initWithType:subpredicates:

Returns the receiver initialized to a given type using predicates from a given array.

- (id)initWithType:(NSCompoundPredicateType)type subpredicates:(NSArray *)subpredicates

Parameters

type

The type of the new predicate.

subpredicates

An array of NSPredicate objects.

Return Value

The receiver initialized with its type set to type and subpredicates array to subpredicates.

Availability

• Available in Mac OS X v10.4 and later.

Declared In

NSCompoundPredicate.h

subpredicates

Returns the array of the receiver’s subpredicates.

- (NSArray *)subpredicates

Return Value

The array of the receiver’s subpredicates.

Availability

• Available in Mac OS X v10.4 and later.

Declared In

NSCompoundPredicate.h

Constants

Compound Predicate Types

These constants describe the possible types of NSCompoundPredicate.

typedef enum {
   NSNotPredicateType = 0,
   NSAndPredicateType,
   NSOrPredicateType,
} NSCompoundPredicateType;

Constants

NSNotPredicateType

A logical NOT predicate.

Available in Mac OS X v10.4 and later.

Declared in NSCompoundPredicate.h.

NSAndPredicateType

A logical AND predicate.

Available in Mac OS X v10.4 and later.

Declared in NSCompoundPredicate.h.

NSOrPredicateType

A logical OR predicate.

Available in Mac OS X v10.4 and later.

Declared in NSCompoundPredicate.h.

Declared In

NSCompoundPredicate.h

---