Class: NSSortDescriptor

Inherits:
NSObject show all

Overview

An instance of NSSortDescriptor describes a basis for ordering objects by specifying the property to use to compare the objects, the method to use to compare the properties, and whether the comparison should be ascending or descending. Instances of NSSortDescriptor are immutable.

Class Method Summary (collapse)

Instance Method Summary (collapse)

Methods inherited from NSObject

#!, #!=, #!~, #, #==, #===, #=~, #Rational, #__callee__, #__method__, #__send__, #__type__, `, alloc, allocWithZone:, #autoContentAccessingProxy, autoload, autoload?, autorelease_pool, #awakeAfterUsingCoder:, binding, block_given?, caller, cancelPreviousPerformRequestsWithTarget:, cancelPreviousPerformRequestsWithTarget:selector:object:, catch, class, classFallbacksForKeyedArchiver, #classForCoder, #classForKeyedArchiver, classForKeyedUnarchiver, #clone, conformsToProtocol:, #copy, copyWithZone:, #dealloc, #define_singleton_method, description, display, #doesNotRecognizeSelector:, #dup, #enum_for, #eql?, #equal?, #extend, fail, #finalize, format, #forwardInvocation:, #forwardingTargetForSelector:, framework, #freeze, #frozen?, getpass, gets, global_variables, #init, initialize, #initialize_clone, #initialize_copy, #initialize_dup, #inspect, instanceMethodForSelector:, instanceMethodSignatureForSelector:, #instance_eval, #instance_exec, #instance_of?, #instance_variable_defined?, #instance_variable_get, #instance_variable_set, #instance_variables, instancesRespondToSelector:, isSubclassOfClass:, #is_a?, iterator?, #kind_of?, lambda, load, load_bridge_support_file, load_plist, local_variables, loop, #method, #methodForSelector:, #methodSignatureForSelector:, #methods, #mutableCopy, mutableCopyWithZone:, new, #nil?, open, p, #performSelector:onThread:withObject:waitUntilDone:, #performSelector:onThread:withObject:waitUntilDone:modes:, #performSelector:withObject:afterDelay:, #performSelector:withObject:afterDelay:inModes:, #performSelectorInBackground:withObject:, #performSelectorOnMainThread:withObject:waitUntilDone:, #performSelectorOnMainThread:withObject:waitUntilDone:modes:, print, printf, #private_methods, proc, #protected_methods, #public_method, #public_methods, #public_send, putc, puts, raise, rand, readline, readlines, #replacementObjectForCoder:, #replacementObjectForKeyedArchiver:, require, resolveClassMethod:, resolveInstanceMethod:, #respond_to?, #respond_to_missing?, select, #send, setVersion:, #singleton_methods, sprintf, srand, superclass, #taint, #tainted?, #tap, test, throw, #to_plist, #to_s, trace_var, trap, #trust, #untaint, untrace_var, #untrust, #untrusted?, version

Constructor Details

This class inherits a constructor from NSObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class NSObject

Class Method Details

+ (Object) sortDescriptorWithKey(key, ascending:ascending)

Creates and returns an NSSortDescriptor with the specified key and ordering.

Parameters:

  • key (String)

    The property key to use when performing a comparison. In the comparison, the property is accessed using key-value coding (see Key-Value Coding Programming Guide).

  • ascending (Boolean)

    YES if the receiver specifies sorting in ascending order, otherwise NO.

Returns:

+ (Object) sortDescriptorWithKey(key, ascending:ascending, comparator:cmptr)

Creates and returns an NSSortDescriptor object initialized to do with the given ordering and comparator block.

Parameters:

  • key (String)

    The property key to use when performing a comparison. In the comparison, the property is accessed using key-value coding (see Key-Value Coding Programming Guide).

  • ascending (Boolean)

    YES if the receiver specifies sorting in ascending order, otherwise NO.

  • cmptr (NSComparator)

    A comparator block.

Returns:

+ (Object) sortDescriptorWithKey(key, ascending:ascending, selector:selector)

Creates an NSSortDescriptor with the specified ordering and comparison selector.

Parameters:

  • key (String)

    The property key to use when performing a comparison. In the comparison, the property is accessed using key-value coding (see Key-Value Coding Programming Guide).

  • ascending (Boolean)

    YES if the receiver specifies sorting in ascending order, otherwise NO.

  • selector (Symbol)

    The method to use when comparing the properties of objects, for example caseInsensitiveCompare: or localizedCompare:. The selector must specify a method implemented by the value of the property identified by keyPath. The selector used for the comparison is passed a single parameter, the object to compare against self, and must return the appropriate NSComparisonResult constant. The selector must have the same method signature as:- (NSComparisonResult)localizedCompare:(NSString *)aString

Returns:

  • (Object)

    An NSSortDescriptor object initialized with the property key path specified by keyPath, sort order specified by ascending, and the selector specified by selector.

Instance Method Details

- (Boolean) ascending

Returns a Boolean value that indicates whether the receiver specifies sorting in ascending order.

Returns:

  • (Boolean)

    YES if the receiver specifies sorting in ascending order, otherwise NO.

- (NSComparator) comparator

Creates and returns an NSComparator for the sort descriptor.

Returns:

  • (NSComparator)

    An NSComparator object representing the sort descriptor.

- (NSComparisonResult) compareObject(object1, toObject:object2)

Returns an NSComparisonResult value that indicates the ordering of two given objects. The ordering is determined by comparing, using the selector specified selector, the values of the properties specified by key of object1 and object2.

Parameters:

  • object1 (Object)

    The object to compare with object2. This object must have a property accessible using the key-path specified by key.This value must not be nil. If the value is nil, the behavior is undefined and may change in future versions of OS X.

  • object2 (Object)

    The object to compare with object1. This object must have a property accessible using the key-path specified by key.This value must not be nil. If the value is nil, the behavior is undefined and may change in future versions of OS X.

Returns:

  • (NSComparisonResult)

    NSOrderedAscending if object1 is less than object2, NSOrderedDescending if object1 is greater than object2, or NSOrderedSame if object1 is equal to object2.

- (Object) initWithKey(keyPath, ascending:ascending)

Returns an NSSortDescriptor object initialized with a given property key path and sort order, and with the default comparison selector.

Parameters:

  • keyPath (String)

    The property key to use when performing a comparison. In the comparison, the property is accessed using key-value coding (see Key-Value Coding Programming Guide).

  • ascending (Boolean)

    YES if the receiver specifies sorting in ascending order, otherwise NO.

Returns:

  • (Object)

    An NSSortDescriptor object initialized with the property key path specified by keyPath, sort order specified by ascending, and the default comparison selector (compare:).

- (Object) initWithKey(key, ascending:ascending, comparator:cmptr)

Returns an NSSortDescriptor object initialized to do with the given ordering and comparator block.

Parameters:

  • key (String)

    The property key to use when performing a comparison. In the comparison, the property is accessed using key-value coding (see Key-Value Coding Programming Guide).

  • ascending (Boolean)

    YES if the receiver specifies sorting in ascending order, otherwise NO.

  • cmptr (NSComparator)

    A comparator block.

Returns:

- (Object) initWithKey(keyPath, ascending:ascending, selector:selector)

Returns an NSSortDescriptor object initialized with a given property key path, sort order, and comparison selector.

Parameters:

  • keyPath (String)

    The property key to use when performing a comparison. In the comparison, the property is accessed using key-value coding (see Key-Value Coding Programming Guide).

  • ascending (Boolean)

    YES if the receiver specifies sorting in ascending order, otherwise NO.

  • selector (Symbol)

    The method to use when comparing the properties of objects, for example caseInsensitiveCompare: or localizedCompare:. The selector must specify a method implemented by the value of the property identified by keyPath. The selector used for the comparison is passed a single parameter, the object to compare against self, and must return the appropriate NSComparisonResult constant. The selector must have the same method signature as:- (NSComparisonResult)localizedCompare:(NSString *)aString

Returns:

  • (Object)

    An NSSortDescriptor object initialized with the property key path specified by keyPath, sort order specified by ascending, and the selector specified by selector.

- (String) key

Returns the receiver’s property key path. This key path specifies the property that is compared during sorting.

Returns:

  • (String)

    The receiver’s property key path.

- (Object) reversedSortDescriptor

Returns a copy of the receiver with the sort order reversed.

Returns:

  • (Object)

    A copy of the receiver with the sort order reversed

- (Symbol) selector

Returns the selector the receiver specifies to use when comparing objects.

Returns:

  • (Symbol)

    The selector the receiver specifies to use when comparing objects.