mirror of
https://github.com/zhigang1992/RestKit.git
synced 2026-04-01 22:42:51 +08:00
990ab16a6b
Didn't add license to: NSString+InflectionSupport.h, NSString+InflectionSupport.m, RKParser.h
95 lines
2.4 KiB
Objective-C
95 lines
2.4 KiB
Objective-C
//
|
|
// RKSearchEngine.h
|
|
// Two Toasters
|
|
//
|
|
// Created by Blake Watters on 8/26/09.
|
|
// Copyright 2009 Two Toasters
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
//
|
|
|
|
#import <Foundation/Foundation.h>
|
|
|
|
/**
|
|
* Methods conforming to this protocol are searchable
|
|
* without specifying a list of properties to concatenate
|
|
*/
|
|
@protocol RKSearchable
|
|
|
|
/**
|
|
* Returns a string representation of searchable text the object exposes
|
|
*/
|
|
- (NSString*)searchableText;
|
|
|
|
@end
|
|
|
|
typedef enum _RKSearchMode {
|
|
RKSearchModeAnd,
|
|
RKSearchModeOr
|
|
} RKSearchMode;
|
|
|
|
@interface RKSearchEngine : NSObject {
|
|
RKSearchMode _mode;
|
|
BOOL _tokenizeQuery;
|
|
BOOL _stripWhitespace;
|
|
BOOL _caseSensitive;
|
|
}
|
|
|
|
/**
|
|
* The type of searching to perform. Can be either RKSearchModeAnd or RKSearchModeOr.
|
|
*
|
|
* Defaults to RKSearchModeOr
|
|
*/
|
|
@property (nonatomic, assign) RKSearchMode mode;
|
|
|
|
/**
|
|
* Whether or not to split the search query at whitespace boundaries or consider the string
|
|
* as a single term
|
|
*
|
|
* Defaults to YES
|
|
*/
|
|
@property (nonatomic, assign) BOOL tokenizeQuery;
|
|
|
|
/**
|
|
* Whether or not to strip the whitespace off of the search terms before searching. This can
|
|
* prevent search misses when the terms have leading/trailing whitespace
|
|
*
|
|
* Defaults to YES
|
|
*/
|
|
@property (nonatomic, assign) BOOL stripWhitespace;
|
|
|
|
/**
|
|
* Whether or not to perform a case-sensitive search
|
|
*
|
|
* Defaults to NO
|
|
*/
|
|
@property (nonatomic, assign) BOOL caseSensitive;
|
|
|
|
/**
|
|
* Construct a new search engine
|
|
*/
|
|
+ (id)searchEngine;
|
|
|
|
/**
|
|
* Search for a string in a collection of RKSearchable objects
|
|
*/
|
|
- (NSArray*)searchFor:(NSString*)searchText inCollection:(NSArray*)collection;
|
|
|
|
/**
|
|
* Search for a string in a collection of objects by specifying an array of
|
|
* properties (strings that correspond to the selectors of properties) that return strings
|
|
*/
|
|
- (NSArray*)searchFor:(NSString*)searchText onProperties:(NSArray*)properties inCollection:(NSArray*)collection;
|
|
|
|
@end
|