nano-store 0.6.0 → 0.6.1
Sign up to get free protection for your applications and to get access to all the features.
- data/CHANGELOG.md +5 -0
- data/README.md +3 -1
- data/Rakefile +1 -1
- data/lib/nano_store.rb +1 -1
- data/lib/nano_store/model.rb +11 -7
- data/lib/nano_store/version.rb +1 -1
- data/spec/model_spec.rb +2 -5
- data/vendor/Podfile.lock +4 -4
- data/vendor/Pods/BuildHeaders/NanoStore/NSFNanoGlobals.h +3 -1
- data/vendor/Pods/BuildHeaders/NanoStore/NSFNanoPredicate.h +5 -5
- data/vendor/Pods/BuildHeaders/NanoStore/NSFNanoSearch.h +4 -2
- data/vendor/Pods/Documentation/NanoStore/docset-installed.txt +4 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Info.plist +33 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Documents/Classes/NSFNanoBag.html +2266 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Documents/Classes/NSFNanoEngine.html +4708 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Documents/Classes/NSFNanoExpression.html +818 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Documents/Classes/NSFNanoObject.html +1781 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Documents/Classes/NSFNanoPredicate.html +800 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Documents/Classes/NSFNanoResult.html +1054 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Documents/Classes/NSFNanoSearch.html +2544 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Documents/Classes/NSFNanoSortDescriptor.html +713 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Documents/Classes/NSFNanoStore.html +3723 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Documents/Classes/NSFOrderedDictionary.html +312 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Documents/Protocols/NSFNanoObjectProtocol.html +651 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Documents/css/styles.css +584 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Documents/css/stylesPrint.css +22 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Documents/hierarchy.html +106 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Documents/img/button_bar_background.png +0 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Documents/img/disclosure.png +0 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Documents/img/disclosure_open.png +0 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Documents/img/library_background.png +0 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Documents/img/title_background.png +0 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Documents/index.html +654 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Nodes.xml +92 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Tokens1.xml +596 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Tokens10.xml +48 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Tokens11.xml +118 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Tokens2.xml +1209 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Tokens3.xml +158 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Tokens4.xml +455 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Tokens5.xml +166 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Tokens6.xml +246 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Tokens7.xml +821 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Tokens8.xml +125 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Tokens9.xml +1082 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/docSet.dsidx +0 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/docSet.mom +0 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/docSet.skidx +0 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/docSet.toc +0 -0
- data/vendor/Pods/Documentation/NanoStore/html/Classes/NSFNanoBag.html +2266 -0
- data/vendor/Pods/Documentation/NanoStore/html/Classes/NSFNanoEngine.html +4708 -0
- data/vendor/Pods/Documentation/NanoStore/html/Classes/NSFNanoExpression.html +818 -0
- data/vendor/Pods/Documentation/NanoStore/html/Classes/NSFNanoObject.html +1781 -0
- data/vendor/Pods/Documentation/NanoStore/html/Classes/NSFNanoPredicate.html +800 -0
- data/vendor/Pods/Documentation/NanoStore/html/Classes/NSFNanoResult.html +1054 -0
- data/vendor/Pods/Documentation/NanoStore/html/Classes/NSFNanoSearch.html +2544 -0
- data/vendor/Pods/Documentation/NanoStore/html/Classes/NSFNanoSortDescriptor.html +713 -0
- data/vendor/Pods/Documentation/NanoStore/html/Classes/NSFNanoStore.html +3723 -0
- data/vendor/Pods/Documentation/NanoStore/html/Classes/NSFOrderedDictionary.html +312 -0
- data/vendor/Pods/Documentation/NanoStore/html/Protocols/NSFNanoObjectProtocol.html +651 -0
- data/vendor/Pods/Documentation/NanoStore/html/css/styles.css +584 -0
- data/vendor/Pods/Documentation/NanoStore/html/css/stylesPrint.css +22 -0
- data/vendor/Pods/Documentation/NanoStore/html/hierarchy.html +106 -0
- data/vendor/Pods/Documentation/NanoStore/html/img/button_bar_background.png +0 -0
- data/vendor/Pods/Documentation/NanoStore/html/img/disclosure.png +0 -0
- data/vendor/Pods/Documentation/NanoStore/html/img/disclosure_open.png +0 -0
- data/vendor/Pods/Documentation/NanoStore/html/img/library_background.png +0 -0
- data/vendor/Pods/Documentation/NanoStore/html/img/title_background.png +0 -0
- data/vendor/Pods/Documentation/NanoStore/html/index.html +654 -0
- data/vendor/Pods/Headers/NanoStore/NSFNanoGlobals.h +3 -1
- data/vendor/Pods/Headers/NanoStore/NSFNanoPredicate.h +5 -5
- data/vendor/Pods/Headers/NanoStore/NSFNanoSearch.h +4 -2
- data/vendor/Pods/NanoStore/Classes/Public/NSFNanoGlobals.h +3 -1
- data/vendor/Pods/NanoStore/Classes/Public/NSFNanoGlobals.m +1 -0
- data/vendor/Pods/NanoStore/Classes/Public/NSFNanoPredicate.h +5 -5
- data/vendor/Pods/NanoStore/Classes/Public/NSFNanoPredicate.m +15 -14
- data/vendor/Pods/NanoStore/Classes/Public/NSFNanoSearch.h +4 -2
- data/vendor/Pods/NanoStore/Classes/Public/NSFNanoSearch.m +95 -20
- data/vendor/Pods/Pods.bridgesupport +708 -700
- data/vendor/Pods/Pods.xcconfig +3 -3
- metadata +62 -4
@@ -0,0 +1,166 @@
|
|
1
|
+
<?xml version="1.0" encoding="UTF-8"?>
|
2
|
+
<Tokens version="1.0">
|
3
|
+
<File path="Classes/NSFNanoPredicate.html">
|
4
|
+
|
5
|
+
<Token>
|
6
|
+
<TokenIdentifier>//apple_ref/occ/cl/NSFNanoPredicate</TokenIdentifier>
|
7
|
+
<Abstract type="html">@class NSFNanoPredicate
|
8
|
+
* A predicate is an element of an expression used to perform complex queries.
|
9
|
+
*
|
10
|
+
* @note
|
11
|
+
* A predicate must be added to a NSFNanoExpression.
|
12
|
+
*
|
13
|
+
* @details <b>Example:</b>
|
14
|
+
@code
|
15
|
+
// Instantiate a NanoStore and open it
|
16
|
+
NSFNanoStore *nanoStore = [NSFNanoStore createAndOpenStoreWithType:NSFMemoryStoreType path:nil error:nil];</Abstract>
|
17
|
+
<DeclaredIn>NSFNanoPredicate.h</DeclaredIn>
|
18
|
+
|
19
|
+
<NodeRef refid="5"/>
|
20
|
+
</Token>
|
21
|
+
|
22
|
+
|
23
|
+
<Token>
|
24
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoPredicate/setColumn:</TokenIdentifier>
|
25
|
+
<Abstract type="html">* The type of column being referenced.</Abstract>
|
26
|
+
<DeclaredIn>NSFNanoPredicate.h</DeclaredIn>
|
27
|
+
|
28
|
+
<Declaration>@property (nonatomic, assign, readonly) NSFTableColumnType column</Declaration>
|
29
|
+
|
30
|
+
|
31
|
+
<Anchor>//api/name/column</Anchor>
|
32
|
+
</Token>
|
33
|
+
|
34
|
+
<Token>
|
35
|
+
<TokenIdentifier>//apple_ref/occ/instp/NSFNanoPredicate/column</TokenIdentifier>
|
36
|
+
<Abstract type="html">* The type of column being referenced.</Abstract>
|
37
|
+
<DeclaredIn>NSFNanoPredicate.h</DeclaredIn>
|
38
|
+
|
39
|
+
<Declaration>@property (nonatomic, assign, readonly) NSFTableColumnType column</Declaration>
|
40
|
+
|
41
|
+
|
42
|
+
<Anchor>//api/name/column</Anchor>
|
43
|
+
</Token>
|
44
|
+
|
45
|
+
<Token>
|
46
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoPredicate/setMatch:</TokenIdentifier>
|
47
|
+
<Abstract type="html">* The comparison operator to be used.</Abstract>
|
48
|
+
<DeclaredIn>NSFNanoPredicate.h</DeclaredIn>
|
49
|
+
|
50
|
+
<Declaration>@property (nonatomic, assign, readonly) NSFMatchType match</Declaration>
|
51
|
+
|
52
|
+
|
53
|
+
<Anchor>//api/name/match</Anchor>
|
54
|
+
</Token>
|
55
|
+
|
56
|
+
<Token>
|
57
|
+
<TokenIdentifier>//apple_ref/occ/instp/NSFNanoPredicate/match</TokenIdentifier>
|
58
|
+
<Abstract type="html">* The comparison operator to be used.</Abstract>
|
59
|
+
<DeclaredIn>NSFNanoPredicate.h</DeclaredIn>
|
60
|
+
|
61
|
+
<Declaration>@property (nonatomic, assign, readonly) NSFMatchType match</Declaration>
|
62
|
+
|
63
|
+
|
64
|
+
<Anchor>//api/name/match</Anchor>
|
65
|
+
</Token>
|
66
|
+
|
67
|
+
<Token>
|
68
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoPredicate/setValue:</TokenIdentifier>
|
69
|
+
<Abstract type="html">* The value to be used for comparison.</Abstract>
|
70
|
+
<DeclaredIn>NSFNanoPredicate.h</DeclaredIn>
|
71
|
+
|
72
|
+
<Declaration>@property (nonatomic, readonly) id value</Declaration>
|
73
|
+
|
74
|
+
|
75
|
+
<Anchor>//api/name/value</Anchor>
|
76
|
+
</Token>
|
77
|
+
|
78
|
+
<Token>
|
79
|
+
<TokenIdentifier>//apple_ref/occ/instp/NSFNanoPredicate/value</TokenIdentifier>
|
80
|
+
<Abstract type="html">* The value to be used for comparison.</Abstract>
|
81
|
+
<DeclaredIn>NSFNanoPredicate.h</DeclaredIn>
|
82
|
+
|
83
|
+
<Declaration>@property (nonatomic, readonly) id value</Declaration>
|
84
|
+
|
85
|
+
|
86
|
+
<Anchor>//api/name/value</Anchor>
|
87
|
+
</Token>
|
88
|
+
|
89
|
+
<Token>
|
90
|
+
<TokenIdentifier>//apple_ref/occ/clm/NSFNanoPredicate/predicateWithColumn:matching:value:</TokenIdentifier>
|
91
|
+
<Abstract type="html">Creates and returns a predicate.</Abstract>
|
92
|
+
<DeclaredIn>NSFNanoPredicate.h</DeclaredIn>
|
93
|
+
|
94
|
+
<RelatedTokens>
|
95
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoPredicate/initWithColumn:matching:value:</TokenIdentifier>
|
96
|
+
|
97
|
+
</RelatedTokens>
|
98
|
+
|
99
|
+
<Declaration>+ (NSFNanoPredicate *)predicateWithColumn:(NSFTableColumnType)theType matching:(NSFMatchType)theMatch value:(id)theValue</Declaration>
|
100
|
+
<Parameters>
|
101
|
+
<Parameter>
|
102
|
+
<Name>theType</Name>
|
103
|
+
<Abstract type="html">is the column type. Can be \link Globals::NSFKeyColumn NSFKeyColumn \endlink, \link Globals::NSFAttributeColumn NSFAttributeColumn \endlink or \link Globals::NSFValueColumn NSFValueColumn \endlink.</Abstract>
|
104
|
+
</Parameter><Parameter>
|
105
|
+
<Name>theMatch</Name>
|
106
|
+
<Abstract type="html">is the match operator.</Abstract>
|
107
|
+
</Parameter><Parameter>
|
108
|
+
<Name>theValue</Name>
|
109
|
+
<Abstract type="html">can be an NSString or [NSNull null]</Abstract>
|
110
|
+
</Parameter>
|
111
|
+
</Parameters>
|
112
|
+
<ReturnValue><Abstract type="html">A predicate which can be used in an NSFNanoExpression.</Abstract></ReturnValue>
|
113
|
+
<Anchor>//api/name/predicateWithColumn:matching:value:</Anchor>
|
114
|
+
</Token>
|
115
|
+
|
116
|
+
<Token>
|
117
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoPredicate/initWithColumn:matching:value:</TokenIdentifier>
|
118
|
+
<Abstract type="html">Initializes a newly allocated predicate.</Abstract>
|
119
|
+
<DeclaredIn>NSFNanoPredicate.h</DeclaredIn>
|
120
|
+
|
121
|
+
<RelatedTokens>
|
122
|
+
<TokenIdentifier>//apple_ref/occ/clm/NSFNanoPredicate/predicateWithColumn:matching:value:</TokenIdentifier>
|
123
|
+
|
124
|
+
</RelatedTokens>
|
125
|
+
|
126
|
+
<Declaration>- (id)initWithColumn:(NSFTableColumnType)theType matching:(NSFMatchType)theMatch value:(id)theValue</Declaration>
|
127
|
+
<Parameters>
|
128
|
+
<Parameter>
|
129
|
+
<Name>theType</Name>
|
130
|
+
<Abstract type="html">is the column type. Can be \link Globals::NSFKeyColumn NSFKeyColumn \endlink, \link Globals::NSFAttributeColumn NSFAttributeColumn \endlink or \link Globals::NSFValueColumn NSFValueColumn \endlink.</Abstract>
|
131
|
+
</Parameter><Parameter>
|
132
|
+
<Name>theMatch</Name>
|
133
|
+
<Abstract type="html">is the match operator.</Abstract>
|
134
|
+
</Parameter><Parameter>
|
135
|
+
<Name>theValue</Name>
|
136
|
+
<Abstract type="html">can be an NSString or [NSNull null]</Abstract>
|
137
|
+
</Parameter>
|
138
|
+
</Parameters>
|
139
|
+
<ReturnValue><Abstract type="html">A predicate which can be used in an NSFNanoExpression.</Abstract></ReturnValue>
|
140
|
+
<Anchor>//api/name/initWithColumn:matching:value:</Anchor>
|
141
|
+
</Token>
|
142
|
+
|
143
|
+
<Token>
|
144
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoPredicate/description</TokenIdentifier>
|
145
|
+
<Abstract type="html">Returns a string representation of the predicate.</Abstract>
|
146
|
+
<DeclaredIn>NSFNanoPredicate.h</DeclaredIn>
|
147
|
+
|
148
|
+
<Declaration>- (NSString *)description</Declaration>
|
149
|
+
|
150
|
+
|
151
|
+
<Anchor>//api/name/description</Anchor>
|
152
|
+
</Token>
|
153
|
+
|
154
|
+
<Token>
|
155
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoPredicate/JSONDescription</TokenIdentifier>
|
156
|
+
<Abstract type="html">Returns a JSON representation of the predicate.</Abstract>
|
157
|
+
<DeclaredIn>NSFNanoPredicate.h</DeclaredIn>
|
158
|
+
|
159
|
+
<Declaration>- (NSString *)JSONDescription</Declaration>
|
160
|
+
|
161
|
+
|
162
|
+
<Anchor>//api/name/JSONDescription</Anchor>
|
163
|
+
</Token>
|
164
|
+
|
165
|
+
</File>
|
166
|
+
</Tokens>
|
@@ -0,0 +1,246 @@
|
|
1
|
+
<?xml version="1.0" encoding="UTF-8"?>
|
2
|
+
<Tokens version="1.0">
|
3
|
+
<File path="Classes/NSFNanoResult.html">
|
4
|
+
|
5
|
+
<Token>
|
6
|
+
<TokenIdentifier>//apple_ref/occ/cl/NSFNanoResult</TokenIdentifier>
|
7
|
+
<Abstract type="html">@class NSFNanoResult
|
8
|
+
* A unit that describes the result of a search.
|
9
|
+
*
|
10
|
+
* @note
|
11
|
+
* The NanoResult is the object representation of a SQL result set. From it, you can obtain the number of rows, the column names and their
|
12
|
+
* associated values.
|
13
|
+
*
|
14
|
+
* @par
|
15
|
+
* After obtaining a NanoResult, it's always a good idea to check whether the <i>error</i> property is nil. If so, the result can be assumed to be
|
16
|
+
* correct. Otherwise, <i>error</i> will point to the main cause of failure.
|
17
|
+
*
|
18
|
+
* @details <b>Example:</b>
|
19
|
+
@code
|
20
|
+
// Instantiate a NanoStore and open it
|
21
|
+
NSFNanoStore *nanoStore = [NSFNanoStore createAndOpenStoreWithType:NSFMemoryStoreType path:nil error:nil];</Abstract>
|
22
|
+
<DeclaredIn>NSFNanoResult.h</DeclaredIn>
|
23
|
+
|
24
|
+
<NodeRef refid="6"/>
|
25
|
+
</Token>
|
26
|
+
|
27
|
+
|
28
|
+
<Token>
|
29
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoResult/setNumberOfRows:</TokenIdentifier>
|
30
|
+
<Abstract type="html">* Number of rows contained in the result set.</Abstract>
|
31
|
+
<DeclaredIn>NSFNanoResult.h</DeclaredIn>
|
32
|
+
|
33
|
+
<Declaration>@property (nonatomic, assign, readonly) NSUInteger numberOfRows</Declaration>
|
34
|
+
|
35
|
+
|
36
|
+
<Anchor>//api/name/numberOfRows</Anchor>
|
37
|
+
</Token>
|
38
|
+
|
39
|
+
<Token>
|
40
|
+
<TokenIdentifier>//apple_ref/occ/instp/NSFNanoResult/numberOfRows</TokenIdentifier>
|
41
|
+
<Abstract type="html">* Number of rows contained in the result set.</Abstract>
|
42
|
+
<DeclaredIn>NSFNanoResult.h</DeclaredIn>
|
43
|
+
|
44
|
+
<Declaration>@property (nonatomic, assign, readonly) NSUInteger numberOfRows</Declaration>
|
45
|
+
|
46
|
+
|
47
|
+
<Anchor>//api/name/numberOfRows</Anchor>
|
48
|
+
</Token>
|
49
|
+
|
50
|
+
<Token>
|
51
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoResult/setError:</TokenIdentifier>
|
52
|
+
<Abstract type="html">* A reference to the error encountered while processing the request, otherwise nil if the request was successful.</Abstract>
|
53
|
+
<DeclaredIn>NSFNanoResult.h</DeclaredIn>
|
54
|
+
|
55
|
+
<Declaration>@property (nonatomic, strong, readonly) NSError *error</Declaration>
|
56
|
+
|
57
|
+
|
58
|
+
<Anchor>//api/name/error</Anchor>
|
59
|
+
</Token>
|
60
|
+
|
61
|
+
<Token>
|
62
|
+
<TokenIdentifier>//apple_ref/occ/instp/NSFNanoResult/error</TokenIdentifier>
|
63
|
+
<Abstract type="html">* A reference to the error encountered while processing the request, otherwise nil if the request was successful.</Abstract>
|
64
|
+
<DeclaredIn>NSFNanoResult.h</DeclaredIn>
|
65
|
+
|
66
|
+
<Declaration>@property (nonatomic, strong, readonly) NSError *error</Declaration>
|
67
|
+
|
68
|
+
|
69
|
+
<Anchor>//api/name/error</Anchor>
|
70
|
+
</Token>
|
71
|
+
|
72
|
+
<Token>
|
73
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoResult/columns</TokenIdentifier>
|
74
|
+
<Abstract type="html">Returns a new array containing the columns.</Abstract>
|
75
|
+
<DeclaredIn>NSFNanoResult.h</DeclaredIn>
|
76
|
+
|
77
|
+
<Declaration>- (NSArray *)columns</Declaration>
|
78
|
+
|
79
|
+
<ReturnValue><Abstract type="html">An array with the columns retrieved from the result set.</Abstract></ReturnValue>
|
80
|
+
<Anchor>//api/name/columns</Anchor>
|
81
|
+
</Token>
|
82
|
+
|
83
|
+
<Token>
|
84
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoResult/valueAtIndex:forColumn:</TokenIdentifier>
|
85
|
+
<Abstract type="html">Returns a new array containing the values for a given column.</Abstract>
|
86
|
+
<DeclaredIn>NSFNanoResult.h</DeclaredIn>
|
87
|
+
|
88
|
+
<Declaration>- (NSString *)valueAtIndex:(NSUInteger)theIndex forColumn:(NSString *)theColumn</Declaration>
|
89
|
+
<Parameters>
|
90
|
+
<Parameter>
|
91
|
+
<Name>theIndex</Name>
|
92
|
+
<Abstract type="html">is the index of the value in the result set.</Abstract>
|
93
|
+
</Parameter><Parameter>
|
94
|
+
<Name>theColumn</Name>
|
95
|
+
<Abstract type="html">is the name of the column in the result set.</Abstract>
|
96
|
+
</Parameter>
|
97
|
+
</Parameters>
|
98
|
+
<ReturnValue><Abstract type="html">An array with the values associated with a given column.
|
99
|
+
@throws NSRangeException is thrown if the index is out of bounds.</Abstract></ReturnValue>
|
100
|
+
<Anchor>//api/name/valueAtIndex:forColumn:</Anchor>
|
101
|
+
</Token>
|
102
|
+
|
103
|
+
<Token>
|
104
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoResult/valuesForColumn:</TokenIdentifier>
|
105
|
+
<Abstract type="html">Returns a new array containing the values for a given column.</Abstract>
|
106
|
+
<DeclaredIn>NSFNanoResult.h</DeclaredIn>
|
107
|
+
|
108
|
+
<Declaration>- (NSArray *)valuesForColumn:(NSString *)theColumn</Declaration>
|
109
|
+
<Parameters>
|
110
|
+
<Parameter>
|
111
|
+
<Name>theColumn</Name>
|
112
|
+
<Abstract type="html">is the name of the column in the result set.</Abstract>
|
113
|
+
</Parameter>
|
114
|
+
</Parameters>
|
115
|
+
<ReturnValue><Abstract type="html">An array with the values associated with a given column.</Abstract></ReturnValue>
|
116
|
+
<Anchor>//api/name/valuesForColumn:</Anchor>
|
117
|
+
</Token>
|
118
|
+
|
119
|
+
<Token>
|
120
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoResult/firstValue</TokenIdentifier>
|
121
|
+
<Abstract type="html">Returns the first value.</Abstract>
|
122
|
+
<DeclaredIn>NSFNanoResult.h</DeclaredIn>
|
123
|
+
|
124
|
+
<Declaration>- (NSString *)firstValue</Declaration>
|
125
|
+
|
126
|
+
<ReturnValue><Abstract type="html">The value of the first element from the result set.</Abstract></ReturnValue>
|
127
|
+
<Anchor>//api/name/firstValue</Anchor>
|
128
|
+
</Token>
|
129
|
+
|
130
|
+
<Token>
|
131
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoResult/writeToFile:</TokenIdentifier>
|
132
|
+
<Abstract type="html">Saves the result to a file.</Abstract>
|
133
|
+
<DeclaredIn>NSFNanoResult.h</DeclaredIn>
|
134
|
+
|
135
|
+
<Declaration>- (void)writeToFile:(NSString *)thePath</Declaration>
|
136
|
+
<Parameters>
|
137
|
+
<Parameter>
|
138
|
+
<Name>thePath</Name>
|
139
|
+
<Abstract type="html">is the location where the result will be saved to a file.</Abstract>
|
140
|
+
</Parameter>
|
141
|
+
</Parameters>
|
142
|
+
|
143
|
+
<Anchor>//api/name/writeToFile:</Anchor>
|
144
|
+
</Token>
|
145
|
+
|
146
|
+
<Token>
|
147
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoResult/description</TokenIdentifier>
|
148
|
+
<Abstract type="html">Returns a string representation of the result.</Abstract>
|
149
|
+
<DeclaredIn>NSFNanoResult.h</DeclaredIn>
|
150
|
+
|
151
|
+
<Declaration>- (NSString *)description</Declaration>
|
152
|
+
|
153
|
+
|
154
|
+
<Anchor>//api/name/description</Anchor>
|
155
|
+
</Token>
|
156
|
+
|
157
|
+
<Token>
|
158
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoResult/JSONDescription</TokenIdentifier>
|
159
|
+
<Abstract type="html">Returns a JSON representation of the result.</Abstract>
|
160
|
+
<DeclaredIn>NSFNanoResult.h</DeclaredIn>
|
161
|
+
|
162
|
+
<Declaration>- (NSString *)JSONDescription</Declaration>
|
163
|
+
|
164
|
+
|
165
|
+
<Anchor>//api/name/JSONDescription</Anchor>
|
166
|
+
</Token>
|
167
|
+
|
168
|
+
<Token>
|
169
|
+
<TokenIdentifier>//apple_ref/occ/clm/NSFNanoResult/_resultWithDictionary:</TokenIdentifier>
|
170
|
+
<Abstract type="html"></Abstract>
|
171
|
+
<DeclaredIn>NSFNanoResult_Private.h</DeclaredIn>
|
172
|
+
|
173
|
+
<Declaration>+ (NSFNanoResult *)_resultWithDictionary:(NSDictionary *)results</Declaration>
|
174
|
+
|
175
|
+
|
176
|
+
<Anchor>//api/name/_resultWithDictionary:</Anchor>
|
177
|
+
</Token>
|
178
|
+
|
179
|
+
<Token>
|
180
|
+
<TokenIdentifier>//apple_ref/occ/clm/NSFNanoResult/_resultWithError:</TokenIdentifier>
|
181
|
+
<Abstract type="html"></Abstract>
|
182
|
+
<DeclaredIn>NSFNanoResult_Private.h</DeclaredIn>
|
183
|
+
|
184
|
+
<Declaration>+ (NSFNanoResult *)_resultWithError:(NSError *)error</Declaration>
|
185
|
+
|
186
|
+
|
187
|
+
<Anchor>//api/name/_resultWithError:</Anchor>
|
188
|
+
</Token>
|
189
|
+
|
190
|
+
<Token>
|
191
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoResult/_initWithDictionary:</TokenIdentifier>
|
192
|
+
<Abstract type="html"></Abstract>
|
193
|
+
<DeclaredIn>NSFNanoResult_Private.h</DeclaredIn>
|
194
|
+
|
195
|
+
<Declaration>- (id)_initWithDictionary:(NSDictionary *)results</Declaration>
|
196
|
+
|
197
|
+
|
198
|
+
<Anchor>//api/name/_initWithDictionary:</Anchor>
|
199
|
+
</Token>
|
200
|
+
|
201
|
+
<Token>
|
202
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoResult/_initWithError:</TokenIdentifier>
|
203
|
+
<Abstract type="html"></Abstract>
|
204
|
+
<DeclaredIn>NSFNanoResult_Private.h</DeclaredIn>
|
205
|
+
|
206
|
+
<Declaration>- (id)_initWithError:(NSError *)error</Declaration>
|
207
|
+
|
208
|
+
|
209
|
+
<Anchor>//api/name/_initWithError:</Anchor>
|
210
|
+
</Token>
|
211
|
+
|
212
|
+
<Token>
|
213
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoResult/_setError:</TokenIdentifier>
|
214
|
+
<Abstract type="html"></Abstract>
|
215
|
+
<DeclaredIn>NSFNanoResult_Private.h</DeclaredIn>
|
216
|
+
|
217
|
+
<Declaration>- (void)_setError:(NSError *)error</Declaration>
|
218
|
+
|
219
|
+
|
220
|
+
<Anchor>//api/name/_setError:</Anchor>
|
221
|
+
</Token>
|
222
|
+
|
223
|
+
<Token>
|
224
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoResult/_reset</TokenIdentifier>
|
225
|
+
<Abstract type="html"></Abstract>
|
226
|
+
<DeclaredIn>NSFNanoResult_Private.h</DeclaredIn>
|
227
|
+
|
228
|
+
<Declaration>- (void)_reset</Declaration>
|
229
|
+
|
230
|
+
|
231
|
+
<Anchor>//api/name/_reset</Anchor>
|
232
|
+
</Token>
|
233
|
+
|
234
|
+
<Token>
|
235
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoResult/_calculateNumberOfRows</TokenIdentifier>
|
236
|
+
<Abstract type="html"></Abstract>
|
237
|
+
<DeclaredIn>NSFNanoResult_Private.h</DeclaredIn>
|
238
|
+
|
239
|
+
<Declaration>- (void)_calculateNumberOfRows</Declaration>
|
240
|
+
|
241
|
+
|
242
|
+
<Anchor>//api/name/_calculateNumberOfRows</Anchor>
|
243
|
+
</Token>
|
244
|
+
|
245
|
+
</File>
|
246
|
+
</Tokens>
|
@@ -0,0 +1,821 @@
|
|
1
|
+
<?xml version="1.0" encoding="UTF-8"?>
|
2
|
+
<Tokens version="1.0">
|
3
|
+
<File path="Classes/NSFNanoSearch.html">
|
4
|
+
|
5
|
+
<Token>
|
6
|
+
<TokenIdentifier>//apple_ref/occ/cl/NSFNanoSearch</TokenIdentifier>
|
7
|
+
<Abstract type="html">@class NSFNanoSearch
|
8
|
+
* A unit that provides an API to retrieve data from the document store.
|
9
|
+
*
|
10
|
+
* The search can be conducted in two ways: programatically via setters or by providing a SQL statement. In both cases,
|
11
|
+
* it's necessary to indicate which object type should be returned. The type \link Globals::NSFReturnType NSFReturnType \endlink provides two options: \link Globals::NSFReturnObjects NSFReturnObjects \endlink and \link Globals::NSFReturnKeys NSFReturnKeys \endlink.
|
12
|
+
*
|
13
|
+
* - \link Globals::NSFReturnObjects NSFReturnObjects \endlink will return a dictionary with the key of the NanoObject (key and the NanoObject itself (value.
|
14
|
+
* - \link Globals::NSFReturnKeys NSFReturnKeys \endlink will return an array of NanoObjects.
|
15
|
+
*
|
16
|
+
* @par <b>Some observations about retrieving data</b><br>
|
17
|
+
*
|
18
|
+
* Given the following data set:
|
19
|
+
*
|
20
|
+
* - Number of dictionaries: 3.956
|
21
|
+
* - Number of attributes: 593.862
|
22
|
+
*
|
23
|
+
* The table describing different timings to perform a simple value search (i.e. 'Barcelona') is included below, ordered from fastest to slowest:
|
24
|
+
*
|
25
|
+
*<table border="1" cellpadding="5">
|
26
|
+
*<tr>
|
27
|
+
*<th>Match type</th>
|
28
|
+
*<th>Seconds</th>
|
29
|
+
*</tr>
|
30
|
+
*<tr><td>Equal to</td><td>0.295</td></tr>
|
31
|
+
*<tr><td>Begins with</td><td>0.295</td></tr>
|
32
|
+
*<tr><td>Contains</td><td>1.295</td></tr>
|
33
|
+
*<tr><td>Contains (insensitive)</td><td>1.339</td></tr>
|
34
|
+
*<tr><td>Ends with (insensitive)</td><td>1.341</td></tr>
|
35
|
+
*<tr><td>Ends with</td><td>1.351</td></tr>
|
36
|
+
*<tr><td>Equal to (insensitive)</td><td>1.890</td></tr>
|
37
|
+
*<tr><td>Begins with (insensitive)</td><td>2.412</td></tr>
|
38
|
+
*<tr><td>Greater than</td><td>18.246</td></tr>
|
39
|
+
*<tr><td>Less than</td><td>27.677</td></tr>
|
40
|
+
*</table></Abstract>
|
41
|
+
<DeclaredIn>NSFNanoSearch.h</DeclaredIn>
|
42
|
+
|
43
|
+
<NodeRef refid="7"/>
|
44
|
+
</Token>
|
45
|
+
|
46
|
+
|
47
|
+
<Token>
|
48
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoSearch/setNanoStore:</TokenIdentifier>
|
49
|
+
<Abstract type="html">* The document store used for searching.</Abstract>
|
50
|
+
<DeclaredIn>NSFNanoSearch.h</DeclaredIn>
|
51
|
+
|
52
|
+
<Declaration>@property (nonatomic, weak, readonly) NSFNanoStore *nanoStore</Declaration>
|
53
|
+
|
54
|
+
|
55
|
+
<Anchor>//api/name/nanoStore</Anchor>
|
56
|
+
</Token>
|
57
|
+
|
58
|
+
<Token>
|
59
|
+
<TokenIdentifier>//apple_ref/occ/instp/NSFNanoSearch/nanoStore</TokenIdentifier>
|
60
|
+
<Abstract type="html">* The document store used for searching.</Abstract>
|
61
|
+
<DeclaredIn>NSFNanoSearch.h</DeclaredIn>
|
62
|
+
|
63
|
+
<Declaration>@property (nonatomic, weak, readonly) NSFNanoStore *nanoStore</Declaration>
|
64
|
+
|
65
|
+
|
66
|
+
<Anchor>//api/name/nanoStore</Anchor>
|
67
|
+
</Token>
|
68
|
+
|
69
|
+
<Token>
|
70
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoSearch/setAttributesToBeReturned:</TokenIdentifier>
|
71
|
+
<Abstract type="html">* The set of attributes to be returned on matching objects.</Abstract>
|
72
|
+
<DeclaredIn>NSFNanoSearch.h</DeclaredIn>
|
73
|
+
|
74
|
+
<Declaration>@property (nonatomic, strong, readwrite) NSArray *attributesToBeReturned</Declaration>
|
75
|
+
|
76
|
+
|
77
|
+
<Anchor>//api/name/attributesToBeReturned</Anchor>
|
78
|
+
</Token>
|
79
|
+
|
80
|
+
<Token>
|
81
|
+
<TokenIdentifier>//apple_ref/occ/instp/NSFNanoSearch/attributesToBeReturned</TokenIdentifier>
|
82
|
+
<Abstract type="html">* The set of attributes to be returned on matching objects.</Abstract>
|
83
|
+
<DeclaredIn>NSFNanoSearch.h</DeclaredIn>
|
84
|
+
|
85
|
+
<Declaration>@property (nonatomic, strong, readwrite) NSArray *attributesToBeReturned</Declaration>
|
86
|
+
|
87
|
+
|
88
|
+
<Anchor>//api/name/attributesToBeReturned</Anchor>
|
89
|
+
</Token>
|
90
|
+
|
91
|
+
<Token>
|
92
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoSearch/setKey:</TokenIdentifier>
|
93
|
+
<Abstract type="html">* The key used for searching.</Abstract>
|
94
|
+
<DeclaredIn>NSFNanoSearch.h</DeclaredIn>
|
95
|
+
|
96
|
+
<Declaration>@property (nonatomic, copy, readwrite) NSString *key</Declaration>
|
97
|
+
|
98
|
+
|
99
|
+
<Anchor>//api/name/key</Anchor>
|
100
|
+
</Token>
|
101
|
+
|
102
|
+
<Token>
|
103
|
+
<TokenIdentifier>//apple_ref/occ/instp/NSFNanoSearch/key</TokenIdentifier>
|
104
|
+
<Abstract type="html">* The key used for searching.</Abstract>
|
105
|
+
<DeclaredIn>NSFNanoSearch.h</DeclaredIn>
|
106
|
+
|
107
|
+
<Declaration>@property (nonatomic, copy, readwrite) NSString *key</Declaration>
|
108
|
+
|
109
|
+
|
110
|
+
<Anchor>//api/name/key</Anchor>
|
111
|
+
</Token>
|
112
|
+
|
113
|
+
<Token>
|
114
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoSearch/setAttribute:</TokenIdentifier>
|
115
|
+
<Abstract type="html">* The attribute used for searching.</Abstract>
|
116
|
+
<DeclaredIn>NSFNanoSearch.h</DeclaredIn>
|
117
|
+
|
118
|
+
<Declaration>@property (nonatomic, copy, readwrite) NSString *attribute</Declaration>
|
119
|
+
|
120
|
+
|
121
|
+
<Anchor>//api/name/attribute</Anchor>
|
122
|
+
</Token>
|
123
|
+
|
124
|
+
<Token>
|
125
|
+
<TokenIdentifier>//apple_ref/occ/instp/NSFNanoSearch/attribute</TokenIdentifier>
|
126
|
+
<Abstract type="html">* The attribute used for searching.</Abstract>
|
127
|
+
<DeclaredIn>NSFNanoSearch.h</DeclaredIn>
|
128
|
+
|
129
|
+
<Declaration>@property (nonatomic, copy, readwrite) NSString *attribute</Declaration>
|
130
|
+
|
131
|
+
|
132
|
+
<Anchor>//api/name/attribute</Anchor>
|
133
|
+
</Token>
|
134
|
+
|
135
|
+
<Token>
|
136
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoSearch/setValue:</TokenIdentifier>
|
137
|
+
<Abstract type="html">* The value used for searching.</Abstract>
|
138
|
+
<DeclaredIn>NSFNanoSearch.h</DeclaredIn>
|
139
|
+
|
140
|
+
<Declaration>@property (nonatomic, copy, readwrite) id value</Declaration>
|
141
|
+
|
142
|
+
|
143
|
+
<Anchor>//api/name/value</Anchor>
|
144
|
+
</Token>
|
145
|
+
|
146
|
+
<Token>
|
147
|
+
<TokenIdentifier>//apple_ref/occ/instp/NSFNanoSearch/value</TokenIdentifier>
|
148
|
+
<Abstract type="html">* The value used for searching.</Abstract>
|
149
|
+
<DeclaredIn>NSFNanoSearch.h</DeclaredIn>
|
150
|
+
|
151
|
+
<Declaration>@property (nonatomic, copy, readwrite) id value</Declaration>
|
152
|
+
|
153
|
+
|
154
|
+
<Anchor>//api/name/value</Anchor>
|
155
|
+
</Token>
|
156
|
+
|
157
|
+
<Token>
|
158
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoSearch/setMatch:</TokenIdentifier>
|
159
|
+
<Abstract type="html">* The comparison operator used for searching.</Abstract>
|
160
|
+
<DeclaredIn>NSFNanoSearch.h</DeclaredIn>
|
161
|
+
|
162
|
+
<Declaration>@property (nonatomic, assign, readwrite) NSFMatchType match</Declaration>
|
163
|
+
|
164
|
+
|
165
|
+
<Anchor>//api/name/match</Anchor>
|
166
|
+
</Token>
|
167
|
+
|
168
|
+
<Token>
|
169
|
+
<TokenIdentifier>//apple_ref/occ/instp/NSFNanoSearch/match</TokenIdentifier>
|
170
|
+
<Abstract type="html">* The comparison operator used for searching.</Abstract>
|
171
|
+
<DeclaredIn>NSFNanoSearch.h</DeclaredIn>
|
172
|
+
|
173
|
+
<Declaration>@property (nonatomic, assign, readwrite) NSFMatchType match</Declaration>
|
174
|
+
|
175
|
+
|
176
|
+
<Anchor>//api/name/match</Anchor>
|
177
|
+
</Token>
|
178
|
+
|
179
|
+
<Token>
|
180
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoSearch/setExpressions:</TokenIdentifier>
|
181
|
+
<Abstract type="html">* The list of NSFNanoExpression objects used for searching.</Abstract>
|
182
|
+
<DeclaredIn>NSFNanoSearch.h</DeclaredIn>
|
183
|
+
|
184
|
+
<Declaration>@property (nonatomic, strong, readwrite) NSArray *expressions</Declaration>
|
185
|
+
|
186
|
+
|
187
|
+
<Anchor>//api/name/expressions</Anchor>
|
188
|
+
</Token>
|
189
|
+
|
190
|
+
<Token>
|
191
|
+
<TokenIdentifier>//apple_ref/occ/instp/NSFNanoSearch/expressions</TokenIdentifier>
|
192
|
+
<Abstract type="html">* The list of NSFNanoExpression objects used for searching.</Abstract>
|
193
|
+
<DeclaredIn>NSFNanoSearch.h</DeclaredIn>
|
194
|
+
|
195
|
+
<Declaration>@property (nonatomic, strong, readwrite) NSArray *expressions</Declaration>
|
196
|
+
|
197
|
+
|
198
|
+
<Anchor>//api/name/expressions</Anchor>
|
199
|
+
</Token>
|
200
|
+
|
201
|
+
<Token>
|
202
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoSearch/setGroupValues:</TokenIdentifier>
|
203
|
+
<Abstract type="html">* If set to YES, specifying NSFReturnKeys applies the DISTINCT function and groups the values.</Abstract>
|
204
|
+
<DeclaredIn>NSFNanoSearch.h</DeclaredIn>
|
205
|
+
|
206
|
+
<Declaration>@property (nonatomic, assign, readwrite) BOOL groupValues</Declaration>
|
207
|
+
|
208
|
+
|
209
|
+
<Anchor>//api/name/groupValues</Anchor>
|
210
|
+
</Token>
|
211
|
+
|
212
|
+
<Token>
|
213
|
+
<TokenIdentifier>//apple_ref/occ/instp/NSFNanoSearch/groupValues</TokenIdentifier>
|
214
|
+
<Abstract type="html">* If set to YES, specifying NSFReturnKeys applies the DISTINCT function and groups the values.</Abstract>
|
215
|
+
<DeclaredIn>NSFNanoSearch.h</DeclaredIn>
|
216
|
+
|
217
|
+
<Declaration>@property (nonatomic, assign, readwrite) BOOL groupValues</Declaration>
|
218
|
+
|
219
|
+
|
220
|
+
<Anchor>//api/name/groupValues</Anchor>
|
221
|
+
</Token>
|
222
|
+
|
223
|
+
<Token>
|
224
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoSearch/setSql:</TokenIdentifier>
|
225
|
+
<Abstract type="html">* The SQL statement used for searching. Set when executeSQL: is invoked.</Abstract>
|
226
|
+
<DeclaredIn>NSFNanoSearch.h</DeclaredIn>
|
227
|
+
|
228
|
+
<Declaration>@property (nonatomic, copy, readonly) NSString *sql</Declaration>
|
229
|
+
|
230
|
+
|
231
|
+
<Anchor>//api/name/sql</Anchor>
|
232
|
+
</Token>
|
233
|
+
|
234
|
+
<Token>
|
235
|
+
<TokenIdentifier>//apple_ref/occ/instp/NSFNanoSearch/sql</TokenIdentifier>
|
236
|
+
<Abstract type="html">* The SQL statement used for searching. Set when executeSQL: is invoked.</Abstract>
|
237
|
+
<DeclaredIn>NSFNanoSearch.h</DeclaredIn>
|
238
|
+
|
239
|
+
<Declaration>@property (nonatomic, copy, readonly) NSString *sql</Declaration>
|
240
|
+
|
241
|
+
|
242
|
+
<Anchor>//api/name/sql</Anchor>
|
243
|
+
</Token>
|
244
|
+
|
245
|
+
<Token>
|
246
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoSearch/setSort:</TokenIdentifier>
|
247
|
+
<Abstract type="html">* The sort holds an array of one or more sort descriptors of type \link NSFNanoSortDescriptor NSFNanoSortDescriptor \endlink.</Abstract>
|
248
|
+
<DeclaredIn>NSFNanoSearch.h</DeclaredIn>
|
249
|
+
|
250
|
+
<Declaration>@property (nonatomic, strong, readwrite) NSArray *sort</Declaration>
|
251
|
+
|
252
|
+
|
253
|
+
<Anchor>//api/name/sort</Anchor>
|
254
|
+
</Token>
|
255
|
+
|
256
|
+
<Token>
|
257
|
+
<TokenIdentifier>//apple_ref/occ/instp/NSFNanoSearch/sort</TokenIdentifier>
|
258
|
+
<Abstract type="html">* The sort holds an array of one or more sort descriptors of type \link NSFNanoSortDescriptor NSFNanoSortDescriptor \endlink.</Abstract>
|
259
|
+
<DeclaredIn>NSFNanoSearch.h</DeclaredIn>
|
260
|
+
|
261
|
+
<Declaration>@property (nonatomic, strong, readwrite) NSArray *sort</Declaration>
|
262
|
+
|
263
|
+
|
264
|
+
<Anchor>//api/name/sort</Anchor>
|
265
|
+
</Token>
|
266
|
+
|
267
|
+
<Token>
|
268
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoSearch/setFilterClass:</TokenIdentifier>
|
269
|
+
<Abstract type="html">* The filterClass allows to filter the results based on a specific object class.</Abstract>
|
270
|
+
<DeclaredIn>NSFNanoSearch.h</DeclaredIn>
|
271
|
+
|
272
|
+
<Declaration>@property (nonatomic, copy, readwrite) NSString *filterClass</Declaration>
|
273
|
+
|
274
|
+
|
275
|
+
<Anchor>//api/name/filterClass</Anchor>
|
276
|
+
</Token>
|
277
|
+
|
278
|
+
<Token>
|
279
|
+
<TokenIdentifier>//apple_ref/occ/instp/NSFNanoSearch/filterClass</TokenIdentifier>
|
280
|
+
<Abstract type="html">* The filterClass allows to filter the results based on a specific object class.</Abstract>
|
281
|
+
<DeclaredIn>NSFNanoSearch.h</DeclaredIn>
|
282
|
+
|
283
|
+
<Declaration>@property (nonatomic, copy, readwrite) NSString *filterClass</Declaration>
|
284
|
+
|
285
|
+
|
286
|
+
<Anchor>//api/name/filterClass</Anchor>
|
287
|
+
</Token>
|
288
|
+
|
289
|
+
<Token>
|
290
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoSearch/setOffset:</TokenIdentifier>
|
291
|
+
<Abstract type="html">* If an expression has an offset clause, then the first M rows are omitted from the result set returned by the search operation and the next N rows are returned, where M and N are the values that the offset and limit clauses evaluate to, respectively. Or, if the search would return less than M+N rows if it did not have a limit clause, then the first M rows are skipped and the remaining rows (if any) are returned.</Abstract>
|
292
|
+
<DeclaredIn>NSFNanoSearch.h</DeclaredIn>
|
293
|
+
|
294
|
+
<Declaration>@property (nonatomic, assign, readwrite) NSUInteger offset</Declaration>
|
295
|
+
|
296
|
+
|
297
|
+
<Anchor>//api/name/offset</Anchor>
|
298
|
+
</Token>
|
299
|
+
|
300
|
+
<Token>
|
301
|
+
<TokenIdentifier>//apple_ref/occ/instp/NSFNanoSearch/offset</TokenIdentifier>
|
302
|
+
<Abstract type="html">* If an expression has an offset clause, then the first M rows are omitted from the result set returned by the search operation and the next N rows are returned, where M and N are the values that the offset and limit clauses evaluate to, respectively. Or, if the search would return less than M+N rows if it did not have a limit clause, then the first M rows are skipped and the remaining rows (if any) are returned.</Abstract>
|
303
|
+
<DeclaredIn>NSFNanoSearch.h</DeclaredIn>
|
304
|
+
|
305
|
+
<Declaration>@property (nonatomic, assign, readwrite) NSUInteger offset</Declaration>
|
306
|
+
|
307
|
+
|
308
|
+
<Anchor>//api/name/offset</Anchor>
|
309
|
+
</Token>
|
310
|
+
|
311
|
+
<Token>
|
312
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoSearch/setLimit:</TokenIdentifier>
|
313
|
+
<Abstract type="html">* The limit clause is used to place an upper bound on the number of rows returned by a Search operation.</Abstract>
|
314
|
+
<DeclaredIn>NSFNanoSearch.h</DeclaredIn>
|
315
|
+
|
316
|
+
<Declaration>@property (nonatomic, assign, readwrite) NSUInteger limit</Declaration>
|
317
|
+
|
318
|
+
|
319
|
+
<Anchor>//api/name/limit</Anchor>
|
320
|
+
</Token>
|
321
|
+
|
322
|
+
<Token>
|
323
|
+
<TokenIdentifier>//apple_ref/occ/instp/NSFNanoSearch/limit</TokenIdentifier>
|
324
|
+
<Abstract type="html">* The limit clause is used to place an upper bound on the number of rows returned by a Search operation.</Abstract>
|
325
|
+
<DeclaredIn>NSFNanoSearch.h</DeclaredIn>
|
326
|
+
|
327
|
+
<Declaration>@property (nonatomic, assign, readwrite) NSUInteger limit</Declaration>
|
328
|
+
|
329
|
+
|
330
|
+
<Anchor>//api/name/limit</Anchor>
|
331
|
+
</Token>
|
332
|
+
|
333
|
+
<Token>
|
334
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoSearch/setBag:</TokenIdentifier>
|
335
|
+
<Abstract type="html">* limit a Search to a particular bag.</Abstract>
|
336
|
+
<DeclaredIn>NSFNanoSearch.h</DeclaredIn>
|
337
|
+
|
338
|
+
<Declaration>@property (nonatomic, assign, readwrite) NSFNanoBag *bag</Declaration>
|
339
|
+
|
340
|
+
|
341
|
+
<Anchor>//api/name/bag</Anchor>
|
342
|
+
</Token>
|
343
|
+
|
344
|
+
<Token>
|
345
|
+
<TokenIdentifier>//apple_ref/occ/instp/NSFNanoSearch/bag</TokenIdentifier>
|
346
|
+
<Abstract type="html">* limit a Search to a particular bag.</Abstract>
|
347
|
+
<DeclaredIn>NSFNanoSearch.h</DeclaredIn>
|
348
|
+
|
349
|
+
<Declaration>@property (nonatomic, assign, readwrite) NSFNanoBag *bag</Declaration>
|
350
|
+
|
351
|
+
|
352
|
+
<Anchor>//api/name/bag</Anchor>
|
353
|
+
</Token>
|
354
|
+
|
355
|
+
<Token>
|
356
|
+
<TokenIdentifier>//apple_ref/occ/clm/NSFNanoSearch/searchWithStore:</TokenIdentifier>
|
357
|
+
<Abstract type="html">Creates and returns a search element for a given document store.</Abstract>
|
358
|
+
<DeclaredIn>NSFNanoSearch.h</DeclaredIn>
|
359
|
+
|
360
|
+
<RelatedTokens>
|
361
|
+
<TokenIdentifier>//apple_ref/occ/cl/NSFNanoStore</TokenIdentifier>
|
362
|
+
|
363
|
+
</RelatedTokens>
|
364
|
+
|
365
|
+
<Declaration>+ (NSFNanoSearch *)searchWithStore:(NSFNanoStore *)theNanoStore</Declaration>
|
366
|
+
<Parameters>
|
367
|
+
<Parameter>
|
368
|
+
<Name>theNanoStore</Name>
|
369
|
+
<Abstract type="html">the document store where the search will be performed. Must not be nil.</Abstract>
|
370
|
+
</Parameter>
|
371
|
+
</Parameters>
|
372
|
+
<ReturnValue><Abstract type="html">An search element upon success, nil otherwise.</Abstract></ReturnValue>
|
373
|
+
<Anchor>//api/name/searchWithStore:</Anchor>
|
374
|
+
</Token>
|
375
|
+
|
376
|
+
<Token>
|
377
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoSearch/initWithStore:</TokenIdentifier>
|
378
|
+
<Abstract type="html">Initializes a newly allocated search element for a given document store.</Abstract>
|
379
|
+
<DeclaredIn>NSFNanoSearch.h</DeclaredIn>
|
380
|
+
|
381
|
+
<RelatedTokens>
|
382
|
+
<TokenIdentifier>//apple_ref/occ/cl/NSFNanoStore</TokenIdentifier>
|
383
|
+
|
384
|
+
</RelatedTokens>
|
385
|
+
|
386
|
+
<Declaration>- (id)initWithStore:(NSFNanoStore *)theNanoStore</Declaration>
|
387
|
+
<Parameters>
|
388
|
+
<Parameter>
|
389
|
+
<Name>theNanoStore</Name>
|
390
|
+
<Abstract type="html">the document store where the search will be performed. Must not be nil.</Abstract>
|
391
|
+
</Parameter>
|
392
|
+
</Parameters>
|
393
|
+
<ReturnValue><Abstract type="html">An search element upon success, nil otherwise.</Abstract></ReturnValue>
|
394
|
+
<Anchor>//api/name/initWithStore:</Anchor>
|
395
|
+
</Token>
|
396
|
+
|
397
|
+
<Token>
|
398
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoSearch/searchObjectsWithReturnType:error:</TokenIdentifier>
|
399
|
+
<Abstract type="html">Performs a search using the values of the properties.</Abstract>
|
400
|
+
<DeclaredIn>NSFNanoSearch.h</DeclaredIn>
|
401
|
+
|
402
|
+
<RelatedTokens>
|
403
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoSearch/searchObjectsAdded:date:returnType:error:</TokenIdentifier>
|
404
|
+
|
405
|
+
</RelatedTokens>
|
406
|
+
|
407
|
+
<Declaration>- (id)searchObjectsWithReturnType:(NSFReturnType)theReturnType error:(out NSError **)outError</Declaration>
|
408
|
+
<Parameters>
|
409
|
+
<Parameter>
|
410
|
+
<Name>theReturnType</Name>
|
411
|
+
<Abstract type="html">the type of object to be returned. Can be \link Globals::NSFReturnObjects NSFReturnObjects \endlink or \link Globals::NSFReturnKeys NSFReturnKeys \endlink.</Abstract>
|
412
|
+
</Parameter><Parameter>
|
413
|
+
<Name>outError</Name>
|
414
|
+
<Abstract type="html">is used if an error occurs. May be NULL.</Abstract>
|
415
|
+
</Parameter>
|
416
|
+
</Parameters>
|
417
|
+
<ReturnValue><Abstract type="html">An array is returned if: 1) the sort has been specified or 2) the return type is \link Globals::NSFReturnKeys NSFReturnKeys \endlink. Otherwise, a dictionary is returned.</Abstract></ReturnValue>
|
418
|
+
<Anchor>//api/name/searchObjectsWithReturnType:error:</Anchor>
|
419
|
+
</Token>
|
420
|
+
|
421
|
+
<Token>
|
422
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoSearch/searchObjectsAdded:date:returnType:error:</TokenIdentifier>
|
423
|
+
<Abstract type="html">Performs a search using the values of the properties before, on or after a given date.</Abstract>
|
424
|
+
<DeclaredIn>NSFNanoSearch.h</DeclaredIn>
|
425
|
+
|
426
|
+
<RelatedTokens>
|
427
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoSearch/searchObjectsWithReturnType:error:</TokenIdentifier>
|
428
|
+
|
429
|
+
</RelatedTokens>
|
430
|
+
|
431
|
+
<Declaration>- (id)searchObjectsAdded:(NSFDateMatchType)theDateMatch date:(NSDate *)theDate returnType:(NSFReturnType)theReturnType error:(out NSError **)outError</Declaration>
|
432
|
+
<Parameters>
|
433
|
+
<Parameter>
|
434
|
+
<Name>theDateMatch</Name>
|
435
|
+
<Abstract type="html">the type of date comparison. Can be \link Globals::NSFBeforeDate NSFBeforeDate \endlink, \link Globals::NSFOnDate NSFOnDate \endlink or \link Globals::NSFAfterDate NSFAfterDate \endlink.</Abstract>
|
436
|
+
</Parameter><Parameter>
|
437
|
+
<Name>theDate</Name>
|
438
|
+
<Abstract type="html">the date to use as a pivot during the search.</Abstract>
|
439
|
+
</Parameter><Parameter>
|
440
|
+
<Name>theReturnType</Name>
|
441
|
+
<Abstract type="html">the type of object to be returned. Can be \link Globals::NSFReturnObjects NSFReturnObjects \endlink or \link Globals::NSFReturnKeys NSFReturnKeys \endlink.</Abstract>
|
442
|
+
</Parameter><Parameter>
|
443
|
+
<Name>outError</Name>
|
444
|
+
<Abstract type="html">is used if an error occurs. May be NULL.</Abstract>
|
445
|
+
</Parameter>
|
446
|
+
</Parameters>
|
447
|
+
<ReturnValue><Abstract type="html">If theReturnType is \link Globals::NSFReturnObjects NSFReturnObjects \endlink, a dictionary is returned. Otherwise, an array is returned.</Abstract></ReturnValue>
|
448
|
+
<Anchor>//api/name/searchObjectsAdded:date:returnType:error:</Anchor>
|
449
|
+
</Token>
|
450
|
+
|
451
|
+
<Token>
|
452
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoSearch/aggregateOperation:onAttribute:</TokenIdentifier>
|
453
|
+
<Abstract type="html">* Returns the result of the aggregate function.
|
454
|
+
* @param theFunctionType is the function type to be applied.
|
455
|
+
* @param theAttribute is the attribute used in the function.
|
456
|
+
* @returns An NSNumber containing the result of the aggregate function.
|
457
|
+
* @details <b>Example:</b>
|
458
|
+
@code
|
459
|
+
NSFNanoStore nanoStore = [NSFNanoStore createAndOpenStoreWithType:NSFMemoryStoreType path:nil error:nil];
|
460
|
+
*
|
461
|
+
* // Assume we have saved data to the document store
|
462
|
+
* ...
|
463
|
+
* ...
|
464
|
+
*
|
465
|
+
* // Get the average for the attribute named 'SomeNumber'
|
466
|
+
NSFNanoSearch search = [NSFNanoSearch searchWithStore:nanoStore];
|
467
|
+
NSNumber result = [search aggregateOperation:NSFAverage onAttribute:@"SomeNumber"];
|
468
|
+
@endcode</Abstract>
|
469
|
+
<DeclaredIn>NSFNanoSearch.h</DeclaredIn>
|
470
|
+
|
471
|
+
<Declaration>- (NSNumber *)aggregateOperation:(NSFAggregateFunctionType)theFunctionType onAttribute:(NSString *)theAttribute</Declaration>
|
472
|
+
|
473
|
+
|
474
|
+
<Anchor>//api/name/aggregateOperation:onAttribute:</Anchor>
|
475
|
+
</Token>
|
476
|
+
|
477
|
+
<Token>
|
478
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoSearch/executeSQL:returnType:error:</TokenIdentifier>
|
479
|
+
<Abstract type="html">Performs a search with a given SQL statement.</Abstract>
|
480
|
+
<DeclaredIn>NSFNanoSearch.h</DeclaredIn>
|
481
|
+
|
482
|
+
<RelatedTokens>
|
483
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoSearch/executeSQL:</TokenIdentifier>
|
484
|
+
|
485
|
+
</RelatedTokens>
|
486
|
+
|
487
|
+
<Declaration>- (id)executeSQL:(NSString *)theSQLStatement returnType:(NSFReturnType)theReturnType error:(out NSError **)outError</Declaration>
|
488
|
+
<Parameters>
|
489
|
+
<Parameter>
|
490
|
+
<Name>theSQLStatement</Name>
|
491
|
+
<Abstract type="html">is the SQL statement to be executed. Must not be nil or an empty string.</Abstract>
|
492
|
+
</Parameter><Parameter>
|
493
|
+
<Name>theReturnType</Name>
|
494
|
+
<Abstract type="html">the type of object to be returned. Can be \link Globals::NSFReturnObjects NSFReturnObjects \endlink or \link Globals::NSFReturnKeys NSFReturnKeys \endlink.</Abstract>
|
495
|
+
</Parameter><Parameter>
|
496
|
+
<Name>outError</Name>
|
497
|
+
<Abstract type="html">is used if an error occurs. May be NULL.</Abstract>
|
498
|
+
</Parameter>
|
499
|
+
</Parameters>
|
500
|
+
<ReturnValue><Abstract type="html">If theReturnType is \link Globals::NSFReturnObjects NSFReturnObjects \endlink, a dictionary is returned. Otherwise, an array is returned.
|
501
|
+
@note
|
502
|
+
Use this method when performing search on NanoObjects. If you need to perform more advanced SQL statements, you may want to use
|
503
|
+
\link executeSQL: - (NSFNanoResult )executeSQL:(NSString )theSQLStatement \endlink instead.
|
504
|
+
@par
|
505
|
+
The key difference between this method and \link executeSQL: - (NSFNanoResult )executeSQL:(NSString )theSQLStatement \endlink is that this method performs
|
506
|
+
a check to make sure the columns specified match the ones required by the \link Globals::NSFReturnType NSFReturnType \endlink type selected. If the column selection is wrong,
|
507
|
+
NanoStore rewrites the query by specifying the right set of columns while honoring the rest of the query.
|
508
|
+
@details <b>Example:</b>
|
509
|
+
@code
|
510
|
+
// Prepare a document store
|
511
|
+
NSFNanoStore *nanoStore = [NSFNanoStore createAndOpenStoreWithType:NSFMemoryStoreType path:nil error:nil];
|
512
|
+
|
513
|
+
// Prepare some data and wrap it in a NanoObject
|
514
|
+
NSString *key = @"ABC-123";
|
515
|
+
NSDictionary *info = ...;
|
516
|
+
NSFNanoObject *nanoObject = [NSFNanoObject nanoObjectWithDictionary:info];
|
517
|
+
|
518
|
+
// Add it to the document store
|
519
|
+
[nanoStore addObjectsFromArray:[NSArray arrayWithObject:nanoObject] error:nil];
|
520
|
+
|
521
|
+
// Instantiate a search and specify the attribute we want to search for
|
522
|
+
NSFNanoSearch *search = [NSFNanoSearch searchWithStore:nanoStore];
|
523
|
+
|
524
|
+
// Perform the search
|
525
|
+
// The query will be rewritten as @"SELECT NSFKey, NSFKeyedArchive, NSFObjectClass FROM NSFKeys"
|
526
|
+
NSDictionary *results = [search executeSQL:@"SELECT foo, bar FROM NSFKeys" returnType:NSFReturnObjects error:nil];
|
527
|
+
@endcode</Abstract></ReturnValue>
|
528
|
+
<Anchor>//api/name/executeSQL:returnType:error:</Anchor>
|
529
|
+
</Token>
|
530
|
+
|
531
|
+
<Token>
|
532
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoSearch/executeSQL:</TokenIdentifier>
|
533
|
+
<Abstract type="html">Performs a search with a given SQL statement.</Abstract>
|
534
|
+
<DeclaredIn>NSFNanoSearch.h</DeclaredIn>
|
535
|
+
|
536
|
+
<RelatedTokens>
|
537
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoSearch/executeSQL:</TokenIdentifier>
|
538
|
+
|
539
|
+
</RelatedTokens>
|
540
|
+
|
541
|
+
<Declaration>- (NSFNanoResult *)executeSQL:(NSString *)theSQLStatement</Declaration>
|
542
|
+
<Parameters>
|
543
|
+
<Parameter>
|
544
|
+
<Name>theSQLStatement</Name>
|
545
|
+
<Abstract type="html">is the SQL statement to be executed. Must not be nil or an empty string.</Abstract>
|
546
|
+
</Parameter>
|
547
|
+
</Parameters>
|
548
|
+
<ReturnValue><Abstract type="html">Returns a NSFNanoResult.
|
549
|
+
@note
|
550
|
+
Use this method when you need to perform more advanced SQL statements. If you just want to query NanoObjects using your own SQL statement,
|
551
|
+
you may want to use \link executeSQL:returnType:error: - (id)executeSQL:(NSString )theSQLStatement returnType:(NSFReturnType)theReturnType error:(out NSError *)outError \endlink instead.
|
552
|
+
@par
|
553
|
+
The key difference between this method and \link executeSQL:returnType:error: - (id)executeSQL:(NSString )theSQLStatement returnType:(NSFReturnType)theReturnType error:(out NSError *)outError \endlink
|
554
|
+
is that this method doesn't perform any check at all. The SQL statement will be sent verbatim to SQLite.
|
555
|
+
@details <b>Example:</b>
|
556
|
+
@code
|
557
|
+
// Prepare a document store
|
558
|
+
NSFNanoStore *nanoStore = [NSFNanoStore createAndOpenStoreWithType:NSFMemoryStoreType path:nil error:nil];
|
559
|
+
|
560
|
+
// Prepare some data and wrap it in a NanoObject
|
561
|
+
NSString *key = @"ABC-123";
|
562
|
+
NSDictionary *info = ...;
|
563
|
+
NSFNanoObject *nanoObject = [NSFNanoObject nanoObjectWithDictionary:info];
|
564
|
+
|
565
|
+
// Add it to the document store
|
566
|
+
[nanoStore addObjectsFromArray:[NSArray arrayWithObject:nanoObject] error:nil];
|
567
|
+
|
568
|
+
// Instantiate a search and specify the attribute we want to search for
|
569
|
+
NSFNanoSearch *search = [NSFNanoSearch searchWithStore:nanoStore];
|
570
|
+
|
571
|
+
// Perform the search
|
572
|
+
NSFNanoResult result = [search executeSQL:@"SELECT COUNT() FROM NSFKEYS"];
|
573
|
+
@endcode</Abstract></ReturnValue>
|
574
|
+
<Anchor>//api/name/executeSQL:</Anchor>
|
575
|
+
</Token>
|
576
|
+
|
577
|
+
<Token>
|
578
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoSearch/explainSQL:</TokenIdentifier>
|
579
|
+
<Abstract type="html">Performs an analysis of the given SQL statement.</Abstract>
|
580
|
+
<DeclaredIn>NSFNanoSearch.h</DeclaredIn>
|
581
|
+
|
582
|
+
<RelatedTokens>
|
583
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoSearch/executeSQL:</TokenIdentifier>
|
584
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoSearch/executeSQL:</TokenIdentifier>
|
585
|
+
|
586
|
+
</RelatedTokens>
|
587
|
+
|
588
|
+
<Declaration>- (NSFNanoResult *)explainSQL:(NSString *)theSQLStatement</Declaration>
|
589
|
+
<Parameters>
|
590
|
+
<Parameter>
|
591
|
+
<Name>theSQLStatement</Name>
|
592
|
+
<Abstract type="html">is the SQL statement to be analyzed. Must not be nil or an empty string.</Abstract>
|
593
|
+
</Parameter>
|
594
|
+
</Parameters>
|
595
|
+
<ReturnValue><Abstract type="html">Returns a NSFNanoResult.
|
596
|
+
@note
|
597
|
+
Returns the sequence of virtual machine instructions with high-level information about what indices would have been used if the SQL statement had
|
598
|
+
been executed.
|
599
|
+
|
600
|
+
@warning
|
601
|
+
The analysis generated by this method is intended for interactive analysis and troubleshooting only. The details of the output format
|
602
|
+
are subject to change from one release of SQLite to the next. Applications should not use this method in production code since the exact behavior
|
603
|
+
is undocumented, unspecified, and variable.
|
604
|
+
|
605
|
+
For additional information about SQLite's Virtual Machine Opcodes, see http://www.sqlite.org/opcode.html
|
606
|
+
|
607
|
+
The tutorial Virtual Database Engine of SQLite is available here: http://www.sqlite.org/vdbe.html
|
608
|
+
|
609
|
+
@details <b>Example:</b>
|
610
|
+
@code
|
611
|
+
// Prepare a document store
|
612
|
+
NSFNanoStore *nanoStore = [NSFNanoStore createAndOpenStoreWithType:NSFMemoryStoreType path:nil error:nil];
|
613
|
+
|
614
|
+
// Instantiate a search object
|
615
|
+
NSFNanoSearch *search = [NSFNanoSearch searchWithStore:nanoStore];
|
616
|
+
|
617
|
+
// Perform the analysis
|
618
|
+
NSFNanoResult results = [search explainSQL:@"SELECT FROM NSFValues"];
|
619
|
+
@endcode</Abstract></ReturnValue>
|
620
|
+
<Anchor>//api/name/explainSQL:</Anchor>
|
621
|
+
</Token>
|
622
|
+
|
623
|
+
<Token>
|
624
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoSearch/reset</TokenIdentifier>
|
625
|
+
<Abstract type="html">Resets the values to a know, default state.
|
626
|
+
- key = nil;
|
627
|
+
- attribute = nil;
|
628
|
+
- value = nil;
|
629
|
+
- match = NSFContains;
|
630
|
+
- object type = NSFReturnObjects;
|
631
|
+
- groupValues = NO;
|
632
|
+
- attributesReturned = nil;
|
633
|
+
- type returned = NSFReturnObjects;
|
634
|
+
- sql = nil;
|
635
|
+
- sort = nil;</Abstract>
|
636
|
+
<DeclaredIn>NSFNanoSearch.h</DeclaredIn>
|
637
|
+
|
638
|
+
<Declaration>- (void)reset</Declaration>
|
639
|
+
|
640
|
+
|
641
|
+
<Anchor>//api/name/reset</Anchor>
|
642
|
+
</Token>
|
643
|
+
|
644
|
+
<Token>
|
645
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoSearch/description</TokenIdentifier>
|
646
|
+
<Abstract type="html">Returns a string representation of the search.</Abstract>
|
647
|
+
<DeclaredIn>NSFNanoSearch.h</DeclaredIn>
|
648
|
+
|
649
|
+
<Declaration>- (NSString *)description</Declaration>
|
650
|
+
|
651
|
+
|
652
|
+
<Anchor>//api/name/description</Anchor>
|
653
|
+
</Token>
|
654
|
+
|
655
|
+
<Token>
|
656
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoSearch/JSONDescription</TokenIdentifier>
|
657
|
+
<Abstract type="html">Returns a JSON representation of the search.</Abstract>
|
658
|
+
<DeclaredIn>NSFNanoSearch.h</DeclaredIn>
|
659
|
+
|
660
|
+
<Declaration>- (NSString *)JSONDescription</Declaration>
|
661
|
+
|
662
|
+
|
663
|
+
<Anchor>//api/name/JSONDescription</Anchor>
|
664
|
+
</Token>
|
665
|
+
|
666
|
+
<Token>
|
667
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoSearch/_retrieveDataWithError:</TokenIdentifier>
|
668
|
+
<Abstract type="html"></Abstract>
|
669
|
+
<DeclaredIn>NSFNanoSearch_Private.h</DeclaredIn>
|
670
|
+
|
671
|
+
<Declaration>- (NSDictionary *)_retrieveDataWithError:(out NSError **)outError</Declaration>
|
672
|
+
|
673
|
+
|
674
|
+
<Anchor>//api/name/_retrieveDataWithError:</Anchor>
|
675
|
+
</Token>
|
676
|
+
|
677
|
+
<Token>
|
678
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoSearch/_dataWithKey:attribute:value:matching:</TokenIdentifier>
|
679
|
+
<Abstract type="html"></Abstract>
|
680
|
+
<DeclaredIn>NSFNanoSearch_Private.h</DeclaredIn>
|
681
|
+
|
682
|
+
<Declaration>- (NSArray *)_dataWithKey:(NSString *)aKey attribute:(NSString *)anAttribute value:(NSString *)aValue matching:(NSFMatchType)match</Declaration>
|
683
|
+
|
684
|
+
|
685
|
+
<Anchor>//api/name/_dataWithKey:attribute:value:matching:</Anchor>
|
686
|
+
</Token>
|
687
|
+
|
688
|
+
<Token>
|
689
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoSearch/_dataWithKey:attribute:value:matching:returning:</TokenIdentifier>
|
690
|
+
<Abstract type="html"></Abstract>
|
691
|
+
<DeclaredIn>NSFNanoSearch_Private.h</DeclaredIn>
|
692
|
+
|
693
|
+
<Declaration>- (NSArray *)_dataWithKey:(NSString *)aKey attribute:(NSString *)anAttribute value:(NSString *)aValue matching:(NSFMatchType)match returning:(NSFReturnType)returnedObjectType</Declaration>
|
694
|
+
|
695
|
+
|
696
|
+
<Anchor>//api/name/_dataWithKey:attribute:value:matching:returning:</Anchor>
|
697
|
+
</Token>
|
698
|
+
|
699
|
+
<Token>
|
700
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoSearch/_retrieveDataAdded:calendarDate:error:</TokenIdentifier>
|
701
|
+
<Abstract type="html"></Abstract>
|
702
|
+
<DeclaredIn>NSFNanoSearch_Private.h</DeclaredIn>
|
703
|
+
|
704
|
+
<Declaration>- (NSDictionary *)_retrieveDataAdded:(NSFDateMatchType)aDateMatch calendarDate:(NSDate *)aDate error:(out NSError **)outError</Declaration>
|
705
|
+
|
706
|
+
|
707
|
+
<Anchor>//api/name/_retrieveDataAdded:calendarDate:error:</Anchor>
|
708
|
+
</Token>
|
709
|
+
|
710
|
+
<Token>
|
711
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoSearch/_preparedSQL</TokenIdentifier>
|
712
|
+
<Abstract type="html"></Abstract>
|
713
|
+
<DeclaredIn>NSFNanoSearch_Private.h</DeclaredIn>
|
714
|
+
|
715
|
+
<Declaration>- (NSString *)_preparedSQL</Declaration>
|
716
|
+
|
717
|
+
|
718
|
+
<Anchor>//api/name/_preparedSQL</Anchor>
|
719
|
+
</Token>
|
720
|
+
|
721
|
+
<Token>
|
722
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoSearch/_prepareSQLQueryStringWithKey:attribute:value:matching:</TokenIdentifier>
|
723
|
+
<Abstract type="html"></Abstract>
|
724
|
+
<DeclaredIn>NSFNanoSearch_Private.h</DeclaredIn>
|
725
|
+
|
726
|
+
<Declaration>- (NSString *)_prepareSQLQueryStringWithKey:(NSString *)aKey attribute:(NSString *)anAttribute value:(id)aValue matching:(NSFMatchType)match</Declaration>
|
727
|
+
|
728
|
+
|
729
|
+
<Anchor>//api/name/_prepareSQLQueryStringWithKey:attribute:value:matching:</Anchor>
|
730
|
+
</Token>
|
731
|
+
|
732
|
+
<Token>
|
733
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoSearch/_prepareSQLQueryStringWithExpressions:</TokenIdentifier>
|
734
|
+
<Abstract type="html"></Abstract>
|
735
|
+
<DeclaredIn>NSFNanoSearch_Private.h</DeclaredIn>
|
736
|
+
|
737
|
+
<Declaration>- (NSString *)_prepareSQLQueryStringWithExpressions:(NSArray *)someExpressions</Declaration>
|
738
|
+
|
739
|
+
|
740
|
+
<Anchor>//api/name/_prepareSQLQueryStringWithExpressions:</Anchor>
|
741
|
+
</Token>
|
742
|
+
|
743
|
+
<Token>
|
744
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoSearch/_resultsFromSQLQuery:</TokenIdentifier>
|
745
|
+
<Abstract type="html"></Abstract>
|
746
|
+
<DeclaredIn>NSFNanoSearch_Private.h</DeclaredIn>
|
747
|
+
|
748
|
+
<Declaration>- (NSArray *)_resultsFromSQLQuery:(NSString *)theSQLStatement</Declaration>
|
749
|
+
|
750
|
+
|
751
|
+
<Anchor>//api/name/_resultsFromSQLQuery:</Anchor>
|
752
|
+
</Token>
|
753
|
+
|
754
|
+
<Token>
|
755
|
+
<TokenIdentifier>//apple_ref/occ/clm/NSFNanoSearch/_prepareSQLQueryStringWithKeys:</TokenIdentifier>
|
756
|
+
<Abstract type="html"></Abstract>
|
757
|
+
<DeclaredIn>NSFNanoSearch_Private.h</DeclaredIn>
|
758
|
+
|
759
|
+
<Declaration>+ (NSString *)_prepareSQLQueryStringWithKeys:(NSArray *)someKeys</Declaration>
|
760
|
+
|
761
|
+
|
762
|
+
<Anchor>//api/name/_prepareSQLQueryStringWithKeys:</Anchor>
|
763
|
+
</Token>
|
764
|
+
|
765
|
+
<Token>
|
766
|
+
<TokenIdentifier>//apple_ref/occ/clm/NSFNanoSearch/_querySegmentForColumn:value:matching:</TokenIdentifier>
|
767
|
+
<Abstract type="html"></Abstract>
|
768
|
+
<DeclaredIn>NSFNanoSearch_Private.h</DeclaredIn>
|
769
|
+
|
770
|
+
<Declaration>+ (NSString *)_querySegmentForColumn:(NSString *)aColumn value:(id)aValue matching:(NSFMatchType)match</Declaration>
|
771
|
+
|
772
|
+
|
773
|
+
<Anchor>//api/name/_querySegmentForColumn:value:matching:</Anchor>
|
774
|
+
</Token>
|
775
|
+
|
776
|
+
<Token>
|
777
|
+
<TokenIdentifier>//apple_ref/occ/clm/NSFNanoSearch/_querySegmentForAttributeColumnWithValue:matching:valueColumnWithValue:</TokenIdentifier>
|
778
|
+
<Abstract type="html"></Abstract>
|
779
|
+
<DeclaredIn>NSFNanoSearch_Private.h</DeclaredIn>
|
780
|
+
|
781
|
+
<Declaration>+ (NSString *)_querySegmentForAttributeColumnWithValue:(id)anAttributeValue matching:(NSFMatchType)match valueColumnWithValue:(id)aValue</Declaration>
|
782
|
+
|
783
|
+
|
784
|
+
<Anchor>//api/name/_querySegmentForAttributeColumnWithValue:matching:valueColumnWithValue:</Anchor>
|
785
|
+
</Token>
|
786
|
+
|
787
|
+
<Token>
|
788
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoSearch/_dictionaryForKeyPath:value:</TokenIdentifier>
|
789
|
+
<Abstract type="html"></Abstract>
|
790
|
+
<DeclaredIn>NSFNanoSearch_Private.h</DeclaredIn>
|
791
|
+
|
792
|
+
<Declaration>- (NSDictionary *)_dictionaryForKeyPath:(NSString *)keyPath value:(id)value</Declaration>
|
793
|
+
|
794
|
+
|
795
|
+
<Anchor>//api/name/_dictionaryForKeyPath:value:</Anchor>
|
796
|
+
</Token>
|
797
|
+
|
798
|
+
<Token>
|
799
|
+
<TokenIdentifier>//apple_ref/occ/clm/NSFNanoSearch/_quoteStrings:joiningWithDelimiter:</TokenIdentifier>
|
800
|
+
<Abstract type="html"></Abstract>
|
801
|
+
<DeclaredIn>NSFNanoSearch_Private.h</DeclaredIn>
|
802
|
+
|
803
|
+
<Declaration>+ (NSString *)_quoteStrings:(NSArray *)strings joiningWithDelimiter:(NSString *)delimiter</Declaration>
|
804
|
+
|
805
|
+
|
806
|
+
<Anchor>//api/name/_quoteStrings:joiningWithDelimiter:</Anchor>
|
807
|
+
</Token>
|
808
|
+
|
809
|
+
<Token>
|
810
|
+
<TokenIdentifier>//apple_ref/occ/instm/NSFNanoSearch/_sortResultsIfApplicable:returnType:</TokenIdentifier>
|
811
|
+
<Abstract type="html"></Abstract>
|
812
|
+
<DeclaredIn>NSFNanoSearch_Private.h</DeclaredIn>
|
813
|
+
|
814
|
+
<Declaration>- (id)_sortResultsIfApplicable:(NSDictionary *)results returnType:(NSFReturnType)theReturnType</Declaration>
|
815
|
+
|
816
|
+
|
817
|
+
<Anchor>//api/name/_sortResultsIfApplicable:returnType:</Anchor>
|
818
|
+
</Token>
|
819
|
+
|
820
|
+
</File>
|
821
|
+
</Tokens>
|