API 0.9.5
CPCompoundPredicate Class Reference

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

#import <CPCompoundPredicate.h>

Inheritance diagram for CPCompoundPredicate:

List of all members.

Instance Methods

(CPCompoundPredicateType- compoundPredicateType
(void) - encodeWithCoder:
(BOOL) - evaluateWithObject:
(BOOL) - evaluateWithObject:substitutionVariables:
(id) - initWithCoder:
(id) - initWithType:subpredicates:
(CPString- predicateFormat
(CPPredicate- predicateWithSubstitutionVariables:
(CPArray- subpredicates

Class Methods

(CPPredicate+ andPredicateWithSubpredicates:
(CPPredicate+ notPredicateWithSubpredicate:
(CPPredicate+ orPredicateWithSubpredicates:

Detailed Description

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

A predicate to directly compare the left and right hand sides.

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

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.

Definition at line 2 of file CPCompoundPredicate.h.


Method Documentation

+ (CPPredicate) andPredicateWithSubpredicates: (CPArray subpredicates

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

Parameters:
subpredicatesAn array of CPPredicate objects.
Returns:
A new predicate formed by AND-ing the predicates specified by subpredicates.

Definition at line 96 of file CPCompoundPredicate.j.

- (CPCompoundPredicateType) compoundPredicateType

Returns the predicate type for the receiver.

Returns:
The predicate type for the receiver.

Definition at line 116 of file CPCompoundPredicate.j.

- (void) encodeWithCoder: (CPCoder coder

Definition at line 245 of file CPCompoundPredicate.j.

- (BOOL) evaluateWithObject: (id)  object

Returns a Boolean value that indicates whether a given object matches the conditions specified by the receiver.

Parameters:
objectThe object against which to evaluate the receiver.
Returns:
YES if object matches the conditions specified by the receiver, otherwise NO.

Reimplemented from CPPredicate.

Definition at line 190 of file CPCompoundPredicate.j.

- (BOOL) evaluateWithObject: (id)  object
substitutionVariables: (CPDictionary variables 

Returns a Boolean value that indicates whether a given object matches the conditions specified by the receiver after substituting in the values in a given variables dictionary.

Parameters:
objectThe object against which to evaluate the receiver.
variablesThe substitution variables dictionary. The dictionary must contain key-value pairs for all variables in the receiver.
Returns:
YES if object matches the conditions specified by the receiver after substituting in the values in variables for any replacement tokens, otherwise NO.

Reimplemented from CPPredicate.

Definition at line 195 of file CPCompoundPredicate.j.

- (id) initWithCoder: (CPCoder coder

Definition at line 233 of file CPCompoundPredicate.j.

- (id) initWithType: (CPCompoundPredicateType type
subpredicates: (CPArray predicates 

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

Parameters:
typeThe type of the new predicate.
Returns:
The receiver initialized with its type set to type and subpredicates array to subpredicates.

Definition at line 68 of file CPCompoundPredicate.j.

+ (CPPredicate) notPredicateWithSubpredicate: (CPPredicate predicate

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

Parameters:
subpredicatesAn array of CPPredicate objects.
Returns:
A new predicate formed by NOT-ing the predicates specified by subpredicates.

Definition at line 86 of file CPCompoundPredicate.j.

+ (CPPredicate) orPredicateWithSubpredicates: (CPArray predicates

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

Parameters:
subpredicatesAn array of CPPredicate objects.
Returns:
A new predicate formed by OR-ing the predicates specified by subpredicates.

Definition at line 106 of file CPCompoundPredicate.j.

- (CPString) predicateFormat

Returns the receiver’s format string.

Returns:
The receiver’s format string.

Reimplemented from CPPredicate.

Definition at line 147 of file CPCompoundPredicate.j.

- (CPPredicate) predicateWithSubstitutionVariables: (CPDictionary variables

Returns a copy of the receiver with the receiver’s variables substituted by values specified in a given substitution variables dictionary.

Parameters:
variablesThe substitution variables dictionary. The dictionary must contain key-value pairs for all variables in the receiver.
Returns:
A copy of the receiver with the receiver’s variables substituted by values specified in variables.

Reimplemented from CPPredicate.

Definition at line 130 of file CPCompoundPredicate.j.

- (CPArray) subpredicates

Returns the array of the receiver’s subpredicates.

Returns:
The array of the receiver’s subpredicates.

Definition at line 125 of file CPCompoundPredicate.j.


The documentation for this class was generated from the following files:
 All Classes Files Functions Variables Defines