RubyGems - nano-store - Versions diffs - 0.6.0 → 0.6.1 - Mend

nano-store 0.6.0 → 0.6.1

Files changed (81) hide show

data/vendor/Pods/Documentation/NanoStore/html/Classes/NSFOrderedDictionary.html ADDED

@@ -0,0 +1,312 @@
+<!DOCTYPE HTML>
+<html>
+	<head>
+		<meta http-equiv="Content-Type" content="html/html; charset=utf-8" />
+		<title>NSFOrderedDictionary Class Reference</title>
+		<meta id="xcode-display" name="xcode-display" content="render"/>
+		<meta name="viewport" content="width=550" />
+		<link rel="stylesheet" type="text/css" href="../css/styles.css" media="all" />
+		<link rel="stylesheet" type="text/css" media="print" href="../css/stylesPrint.css" />
+		<meta name="generator" content="appledoc 2.0.5 (build 789)" />
+	</head>
+	<body>
+		<header id="top_header">
+			<div id="library" class="hideInXcode">
+				<h1><a id="libraryTitle" href="../index.html">NanoStore 2.5.7 </a></h1>
+				<a id="developerHome" href="../index.html">Tito Ciuro</a>
+			</div>
+			<div id="title" role="banner">
+				<h1 class="hideInXcode">NSFOrderedDictionary Class Reference</h1>
+			</div>
+			<ul id="headerButtons" role="toolbar">
+				<li id="toc_button">
+					<button aria-label="Show Table of Contents" role="checkbox" class="open" id="table_of_contents"><span class="disclosure"></span>Table of Contents</button>
+				</li>
+				<li id="jumpto_button" role="navigation">
+					<select id="jumpTo">
+	<option value="top">Jump To&#133;</option>
+	<option value="tasks">Tasks</option>
+	<option value="instance_methods">Instance Methods</option>
+	<option value="//api/name/insertObject:forKey:atIndex:">&nbsp;&nbsp;&nbsp;&nbsp;- insertObject:forKey:atIndex:</option>
+	<option value="//api/name/keyAtIndex:">&nbsp;&nbsp;&nbsp;&nbsp;- keyAtIndex:</option>
+	<option value="//api/name/reverseKeyEnumerator">&nbsp;&nbsp;&nbsp;&nbsp;- reverseKeyEnumerator</option>
+</select>
+				</li>
+			</ul>
+		</header>
+		<nav id="tocContainer" class="isShowingTOC">
+			<ul id="toc" role="tree">
+<li role="treeitem" id="task_treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#tasks">Tasks</a></span><ul>
+</ul></li>
+<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#instance_methods">Instance Methods</a></span><ul>
+	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/insertObject:forKey:atIndex:">insertObject:forKey:atIndex:</a></span></li>
+	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/keyAtIndex:">keyAtIndex:</a></span></li>
+	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/reverseKeyEnumerator">reverseKeyEnumerator</a></span></li>
+</ul></li>
+			</ul>
+		</nav>
+		<article>
+			<div id="contents" class="isShowingTOC" role="main">
+				<a title="NSFOrderedDictionary Class Reference" name="top"></a>
+				<div class="main-navigation navigation-top">
+					<ul>
+	<li><a href="../index.html">Index</a></li>
+	<li><a href="../hierarchy.html">Hierarchy</a></li>
+</ul>
+				</div>
+				<div id="header">
+					<div class="section-header">
+						<h1 class="title title-header">NSFOrderedDictionary Class Reference</h1>
+					</div>
+				</div>
+				<div id="container">
+					<div class="section section-specification"><table cellspacing="0"><tbody>
+						<tr>
+	<td class="specification-title">Inherits from</td>
+	<td class="specification-value">NSMutableDictionary</td>
+</tr><tr>
+	<td class="specification-title">Declared in</td>
+	<td class="specification-value">NSFOrderedDictionary.h</td>
+</tr>
+						</tbody></table></div>
+					<div class="section section-tasks">
+						<a title="Tasks" name="tasks"></a>
+						<h2 class="subtitle subtitle-tasks">Tasks</h2>
+						<ul class="task-list">
+							<li>
+	<span class="tooltip">
+		<code><a href="#//api/name/insertObject:forKey:atIndex:">&ndash;&nbsp;insertObject:forKey:atIndex:</a></code>
+	</span>
+</li><li>
+	<span class="tooltip">
+		<code><a href="#//api/name/keyAtIndex:">&ndash;&nbsp;keyAtIndex:</a></code>
+	</span>
+</li><li>
+	<span class="tooltip">
+		<code><a href="#//api/name/reverseKeyEnumerator">&ndash;&nbsp;reverseKeyEnumerator</a></code>
+	</span>
+</li>
+						</ul>
+					</div>
+					<div class="section section-methods">
+						<a title="Instance Methods" name="instance_methods"></a>
+						<h2 class="subtitle subtitle-methods">Instance Methods</h2>
+						<div class="section-method">
+	<a name="//api/name/insertObject:forKey:atIndex:" title="insertObject:forKey:atIndex:"></a>
+	<h3 class="subsubtitle method-title">insertObject:forKey:atIndex:</h3>
+	<div class="method-subsection method-declaration"><code>- (void)insertObject:(id)<em>anObject</em> forKey:(id)<em>aKey</em> atIndex:(NSUInteger)<em>anIndex</em></code></div>
+</div>
+						<div class="section-method">
+	<a name="//api/name/keyAtIndex:" title="keyAtIndex:"></a>
+	<h3 class="subsubtitle method-title">keyAtIndex:</h3>
+	<div class="method-subsection method-declaration"><code>- (id)keyAtIndex:(NSUInteger)<em>anIndex</em></code></div>
+</div>
+						<div class="section-method">
+	<a name="//api/name/reverseKeyEnumerator" title="reverseKeyEnumerator"></a>
+	<h3 class="subsubtitle method-title">reverseKeyEnumerator</h3>
+	<div class="method-subsection method-declaration"><code>- (NSEnumerator *)reverseKeyEnumerator</code></div>
+</div>
+					</div>
+				</div>
+				<div class="main-navigation navigation-bottom">
+					<ul>
+	<li><a href="../index.html">Index</a></li>
+	<li><a href="../hierarchy.html">Hierarchy</a></li>
+</ul>
+				</div>
+				<div id="footer">
+					<hr />
+					<div class="footer-copyright">
+						<p><span class="copyright">&copy; 2013 Tito Ciuro. All rights reserved. (Last updated: 2013-01-22)</span><br />
+						<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.5 (build 789)</a>.</span></p>
+					</div>
+				</div>
+			</div>
+		</article>
+		<script type="text/javascript">
+			function jumpToChange()
+			{
+				window.location.hash = this.options[this.selectedIndex].value;
+			}
+			function toggleTOC()
+			{
+				var contents = document.getElementById('contents');
+				var tocContainer = document.getElementById('tocContainer');
+				if (this.getAttribute('class') == 'open')
+				{
+					this.setAttribute('class', '');
+					contents.setAttribute('class', '');
+					tocContainer.setAttribute('class', '');
+					window.name = "hideTOC";
+				}
+				else
+				{
+					this.setAttribute('class', 'open');
+					contents.setAttribute('class', 'isShowingTOC');
+					tocContainer.setAttribute('class', 'isShowingTOC');
+					window.name = "";
+				}
+				return false;
+			}
+			function toggleTOCEntryChildren(e)
+			{
+				e.stopPropagation();
+				var currentClass = this.getAttribute('class');
+				if (currentClass == 'children') {
+					this.setAttribute('class', 'children open');
+				}
+				else if (currentClass == 'children open') {
+					this.setAttribute('class', 'children');
+				}
+				return false;
+			}
+			function tocEntryClick(e)
+			{
+				e.stopPropagation();
+				return true;
+			}
+			function init()
+			{
+				var selectElement = document.getElementById('jumpTo');
+				selectElement.addEventListener('change', jumpToChange, false);
+				var tocButton = document.getElementById('table_of_contents');
+				tocButton.addEventListener('click', toggleTOC, false);
+				var taskTreeItem = document.getElementById('task_treeitem');
+				if (taskTreeItem.getElementsByTagName('li').length > 0)
+				{
+					taskTreeItem.setAttribute('class', 'children');
+					taskTreeItem.firstChild.setAttribute('class', 'disclosure');
+				}
+				var tocList = document.getElementById('toc');
+				var tocEntries = tocList.getElementsByTagName('li');
+				for (var i = 0; i < tocEntries.length; i++) {
+					tocEntries[i].addEventListener('click', toggleTOCEntryChildren, false);
+				}
+				var tocLinks = tocList.getElementsByTagName('a');
+				for (var i = 0; i < tocLinks.length; i++) {
+					tocLinks[i].addEventListener('click', tocEntryClick, false);
+				}
+				if (window.name == "hideTOC") {
+					toggleTOC.call(tocButton);
+				}
+			}
+			window.onload = init;
+			// If showing in Xcode, hide the TOC and Header
+			if (navigator.userAgent.match(/xcode/i)) {
+				document.getElementById("contents").className = "hideInXcode"
+				document.getElementById("tocContainer").className = "hideInXcode"
+				document.getElementById("top_header").className = "hideInXcode"
+			}
+		</script>
+	</body>
+</html>

data/vendor/Pods/Documentation/NanoStore/html/Protocols/NSFNanoObjectProtocol.html ADDED

@@ -0,0 +1,651 @@
+<!DOCTYPE HTML>
+<html>
+	<head>
+		<meta http-equiv="Content-Type" content="html/html; charset=utf-8" />
+		<title>NSFNanoObjectProtocol Protocol Reference</title>
+		<meta id="xcode-display" name="xcode-display" content="render"/>
+		<meta name="viewport" content="width=550" />
+		<link rel="stylesheet" type="text/css" href="../css/styles.css" media="all" />
+		<link rel="stylesheet" type="text/css" media="print" href="../css/stylesPrint.css" />
+		<meta name="generator" content="appledoc 2.0.5 (build 789)" />
+	</head>
+	<body>
+		<header id="top_header">
+			<div id="library" class="hideInXcode">
+				<h1><a id="libraryTitle" href="../index.html">NanoStore 2.5.7 </a></h1>
+				<a id="developerHome" href="../index.html">Tito Ciuro</a>
+			</div>
+			<div id="title" role="banner">
+				<h1 class="hideInXcode">NSFNanoObjectProtocol Protocol Reference</h1>
+			</div>
+			<ul id="headerButtons" role="toolbar">
+				<li id="toc_button">
+					<button aria-label="Show Table of Contents" role="checkbox" class="open" id="table_of_contents"><span class="disclosure"></span>Table of Contents</button>
+				</li>
+				<li id="jumpto_button" role="navigation">
+					<select id="jumpTo">
+	<option value="top">Jump To&#133;</option>
+	<option value="overview">Overview</option>
+	<option value="tasks">Tasks</option>
+	<option value="instance_methods">Instance Methods</option>
+	<option value="//api/name/initNanoObjectFromDictionaryRepresentation:forKey:store:">&nbsp;&nbsp;&nbsp;&nbsp;- initNanoObjectFromDictionaryRepresentation:forKey:store:</option>
+	<option value="//api/name/nanoObjectDictionaryRepresentation">&nbsp;&nbsp;&nbsp;&nbsp;- nanoObjectDictionaryRepresentation</option>
+	<option value="//api/name/nanoObjectKey">&nbsp;&nbsp;&nbsp;&nbsp;- nanoObjectKey</option>
+	<option value="//api/name/rootObject">&nbsp;&nbsp;&nbsp;&nbsp;- rootObject</option>
+</select>
+				</li>
+			</ul>
+		</header>
+		<nav id="tocContainer" class="isShowingTOC">
+			<ul id="toc" role="tree">
+<li role="treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#overview">Overview</a></span></li>
+<li role="treeitem" id="task_treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#tasks">Tasks</a></span><ul>
+</ul></li>
+<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#instance_methods">Instance Methods</a></span><ul>
+	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/initNanoObjectFromDictionaryRepresentation:forKey:store:">initNanoObjectFromDictionaryRepresentation:forKey:store:</a></span></li>
+	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/nanoObjectDictionaryRepresentation">nanoObjectDictionaryRepresentation</a></span></li>
+	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/nanoObjectKey">nanoObjectKey</a></span></li>
+	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/rootObject">rootObject</a></span></li>
+</ul></li>
+			</ul>
+		</nav>
+		<article>
+			<div id="contents" class="isShowingTOC" role="main">
+				<a title="NSFNanoObjectProtocol Protocol Reference" name="top"></a>
+				<div class="main-navigation navigation-top">
+					<ul>
+	<li><a href="../index.html">Index</a></li>
+	<li><a href="../hierarchy.html">Hierarchy</a></li>
+</ul>
+				</div>
+				<div id="header">
+					<div class="section-header">
+						<h1 class="title title-header">NSFNanoObjectProtocol Protocol Reference</h1>
+					</div>
+				</div>
+				<div id="container">
+					<div class="section section-specification"><table cellspacing="0"><tbody>
+						<tr>
+	<td class="specification-title">Declared in</td>
+	<td class="specification-value">NSFNanoObjectProtocol.h</td>
+</tr>
+						</tbody></table></div>
+					<div class="section section-overview">
+						<a title="Overview" name="overview"></a>
+						<h2 class="subtitle subtitle-overview">Overview</h2>
+						<p>@protocol <a href="NSFNanoObjectProtocol.html">NSFNanoObjectProtocol</a>
+A protocol declaring the interface that objects interfacing with NanoStore must implement.</p>
+<p>@note
+Check <a href="../Classes/NSFNanoBag.html">NSFNanoBag</a> or <a href="../Classes/NSFNanoObject.html">NSFNanoObject</a> to see a concrete example of how <a href="NSFNanoObjectProtocol.html">NSFNanoObjectProtocol</a> is implemented.</p>
+					</div>
+					<div class="section section-tasks">
+						<a title="Tasks" name="tasks"></a>
+						<h2 class="subtitle subtitle-tasks">Tasks</h2>
+						<ul class="task-list">
+							<li>
+	<span class="tooltip">
+		<code><a href="#//api/name/initNanoObjectFromDictionaryRepresentation:forKey:store:">&ndash;&nbsp;initNanoObjectFromDictionaryRepresentation:forKey:store:</a></code>
+		<span class="tooltip"><ul>
+<li>Initializes a newly allocated object containing a given key and value associated with a document store.</li>
+<li>@param theDictionary the information associated with the object.</li>
+<li>@param aKey the key associated with the information.</li>
+<li>@param theStore the document store where the object is stored.</li>
+<li>@return An initialized object upon success, nil otherwise.</li>
+<li>@details <b>Example:</b>
+@code</li>
+<li>(id)initNanoObjectFromDictionaryRepresentation:(NSDictionary <em>)aDictionary forKey:(NSString </em>)aKey store:(NSFNanoStore *)aStore
+{
+  if (self = [self init]) {
+    info = [aDictionary retain];
+    key = [aKey copy];
+  }</li>
+</ul>
+</span>
+	</span>
+	<span class="task-item-suffix">required method</span>
+</li><li>
+	<span class="tooltip">
+		<code><a href="#//api/name/nanoObjectDictionaryRepresentation">&ndash;&nbsp;nanoObjectDictionaryRepresentation</a></code>
+		<span class="tooltip"><p>Returns a dictionary that contains the information stored in the object.</p></span>
+	</span>
+	<span class="task-item-suffix">required method</span>
+</li><li>
+	<span class="tooltip">
+		<code><a href="#//api/name/nanoObjectKey">&ndash;&nbsp;nanoObjectKey</a></code>
+		<span class="tooltip"><p>Returns the key associated with the object.
+@note
+The class <a href="../Classes/NSFNanoEngine.html">NSFNanoEngine</a> contains a convenience method for this purpose: \ref <a href="../Classes/NSFNanoEngine.html">NSFNanoEngine</a>::stringWithUUID &ldquo;+(NSString*)stringWithUUID&rdquo;</p></span>
+	</span>
+	<span class="task-item-suffix">required method</span>
+</li><li>
+	<span class="tooltip">
+		<code><a href="#//api/name/rootObject">&ndash;&nbsp;rootObject</a></code>
+		<span class="tooltip"><ul>
+<li>Returns a reference to the object holding the private data or information that will be used for sorting.</li>
+<li>Most custom objects will return <i>self</i>, as is the case for <a href="../Classes/NSFNanoBag.html">NSFNanoBag</a>. Since we can sort a bag by <i>name</i>, <i>key</i> or <i>hasUnsavedChanges</i>,</li>
+<li>NanoStore requires a hint to find the attribute. This hint is the root object, which KVC uses to perform the sort. Taking <a href="../Classes/NSFNanoBag.html">NSFNanoBag</a> as an example:
+@code
+@interface <a href="../Classes/NSFNanoBag.html">NSFNanoBag</a> : NSObject <a href="NSFNanoObjectProtocol.html">NSFNanoObjectProtocol</a>, NSCopying>
+{
+  <a href="../Classes/NSFNanoStore.html">NSFNanoStore</a>            <em>store;
+  NSString                </em>name;
+  NSString                *key;
+  BOOL                    hasUnsavedChanges;
+}
+@endcode</li>
+<li>The implementation of <i>rootObject</i> would look like so:
+@code</li>
+<li>(id)rootObject
+{
+  return self;
+}
+@endcode</li>
+<li>Other objects may point directly to the collection that holds the information. <a href="../Classes/NSFNanoObject.html">NSFNanoObject</a> stores all its data in the <i>info</i> dictionary, so the</li>
+<li>implementation looks like this:
+@code</li>
+<li>(id)rootObject
+{
+  return info;
+}
+@endcode</li>
+<li>Assuming that <i>info</i> contains a key named <i>City</i>, we would specify a <a href="../Classes/NSFNanoSortDescriptor.html">NSFNanoSortDescriptor</a> which would sort the cities like so:
+@code
+<a href="../Classes/NSFNanoSortDescriptor.html">NSFNanoSortDescriptor</a> *sortedCities = [[NSFNanoSortDescriptor alloc]initWithAttribute:@&ldquo;City&rdquo; ascending:YES];
+@endcode</li>
+<li>If we had returned <i>self</i> as the root object, the sort descriptor would have to be written like so:
+@code
+NSFNanoSortDescriptor *sortedCities = [[NSFNanoSortDescriptor alloc]initWithAttribute:@&ldquo;info.City&rdquo; ascending:YES];
+@endcode</li>
+</ul>
+</span>
+	</span>
+	<span class="task-item-suffix">required method</span>
+</li>
+						</ul>
+					</div>
+					<div class="section section-methods">
+						<a title="Instance Methods" name="instance_methods"></a>
+						<h2 class="subtitle subtitle-methods">Instance Methods</h2>
+						<div class="section-method">
+	<a name="//api/name/initNanoObjectFromDictionaryRepresentation:forKey:store:" title="initNanoObjectFromDictionaryRepresentation:forKey:store:"></a>
+	<h3 class="subsubtitle method-title">initNanoObjectFromDictionaryRepresentation:forKey:store:</h3>
+	<div class="method-subsection brief-description">
+		<ul>
+<li>Initializes a newly allocated object containing a given key and value associated with a document store.</li>
+<li>@param theDictionary the information associated with the object.</li>
+<li>@param aKey the key associated with the information.</li>
+<li>@param theStore the document store where the object is stored.</li>
+<li>@return An initialized object upon success, nil otherwise.</li>
+<li>@details <b>Example:</b>
+@code</li>
+<li>(id)initNanoObjectFromDictionaryRepresentation:(NSDictionary <em>)aDictionary forKey:(NSString </em>)aKey store:(NSFNanoStore *)aStore
+{
+  if (self = [self init]) {
+    info = [aDictionary retain];
+    key = [aKey copy];
+  }</li>
+</ul>
+	</div>
+	<div class="method-subsection method-declaration"><code>- (id)initNanoObjectFromDictionaryRepresentation:(NSDictionary *)<em>theDictionary</em> forKey:(NSString *)<em>aKey</em> store:(NSFNanoStore *)<em>theStore</em></code></div>
+	<div class="method-subsection discussion-section">
+		<h4 class="method-subtitle">Discussion</h4>
+		<ul>
+<li>Initializes a newly allocated object containing a given key and value associated with a document store.</li>
+<li>@param theDictionary the information associated with the object.</li>
+<li>@param aKey the key associated with the information.</li>
+<li>@param theStore the document store where the object is stored.</li>
+<li>@return An initialized object upon success, nil otherwise.</li>
+<li>@details <b>Example:</b>
+@code</li>
+<li><p>(id)initNanoObjectFromDictionaryRepresentation:(NSDictionary <em>)aDictionary forKey:(NSString </em>)aKey store:(NSFNanoStore *)aStore
+{
+  if (self = [self init]) {
+    info = [aDictionary retain];
+    key = [aKey copy];
+  }</p>
+<p>  return self;
+}
+@endcode</p></li>
+</ul>
+	</div>
+	<div class="method-subsection declared-in-section">
+		<h4 class="method-subtitle">Declared In</h4>
+		<code class="declared-in-ref">NSFNanoObjectProtocol.h</code><br />
+	</div>
+</div>
+						<div class="section-method">
+	<a name="//api/name/nanoObjectDictionaryRepresentation" title="nanoObjectDictionaryRepresentation"></a>
+	<h3 class="subsubtitle method-title">nanoObjectDictionaryRepresentation</h3>
+	<div class="method-subsection brief-description">
+		<p>Returns a dictionary that contains the information stored in the object.</p>
+	</div>
+	<div class="method-subsection method-declaration"><code>- (NSDictionary *)nanoObjectDictionaryRepresentation</code></div>
+	<div class="method-subsection discussion-section">
+		<h4 class="method-subtitle">Discussion</h4>
+		<p>Returns a dictionary that contains the information stored in the object.</p>
+	</div>
+	<div class="method-subsection see-also-section">
+		<h4 class="method-subtitle">See Also</h4>
+		<ul>
+			<li><code><p>\link <a href="#//api/name/nanoObjectKey">&ndash; nanoObjectKey</a> &ndash; (NSString *)<a href="#//api/name/nanoObjectKey">&ndash; nanoObjectKey</a> \endlink</p></code></li>
+		</ul>
+	</div>
+	<div class="method-subsection declared-in-section">
+		<h4 class="method-subtitle">Declared In</h4>
+		<code class="declared-in-ref">NSFNanoObjectProtocol.h</code><br />
+	</div>
+</div>
+						<div class="section-method">
+	<a name="//api/name/nanoObjectKey" title="nanoObjectKey"></a>
+	<h3 class="subsubtitle method-title">nanoObjectKey</h3>
+	<div class="method-subsection brief-description">
+		<p>Returns the key associated with the object.
+@note
+The class <a href="../Classes/NSFNanoEngine.html">NSFNanoEngine</a> contains a convenience method for this purpose: \ref <a href="../Classes/NSFNanoEngine.html">NSFNanoEngine</a>::stringWithUUID &ldquo;+(NSString*)stringWithUUID&rdquo;</p>
+	</div>
+	<div class="method-subsection method-declaration"><code>- (NSString *)nanoObjectKey</code></div>
+	<div class="method-subsection discussion-section">
+		<h4 class="method-subtitle">Discussion</h4>
+		<p>Returns the key associated with the object.
+@note
+The class <a href="../Classes/NSFNanoEngine.html">NSFNanoEngine</a> contains a convenience method for this purpose: \ref <a href="../Classes/NSFNanoEngine.html">NSFNanoEngine</a>::stringWithUUID &ldquo;+(NSString*)stringWithUUID&rdquo;</p>
+	</div>
+	<div class="method-subsection see-also-section">
+		<h4 class="method-subtitle">See Also</h4>
+		<ul>
+			<li><code><p>\link <a href="#//api/name/nanoObjectDictionaryRepresentation">&ndash; nanoObjectDictionaryRepresentation</a> &ndash; (NSDictionary *)<a href="#//api/name/nanoObjectDictionaryRepresentation">&ndash; nanoObjectDictionaryRepresentation</a> \endlink</p></code></li>
+		</ul>
+	</div>
+	<div class="method-subsection declared-in-section">
+		<h4 class="method-subtitle">Declared In</h4>
+		<code class="declared-in-ref">NSFNanoObjectProtocol.h</code><br />
+	</div>
+</div>
+						<div class="section-method">
+	<a name="//api/name/rootObject" title="rootObject"></a>
+	<h3 class="subsubtitle method-title">rootObject</h3>
+	<div class="method-subsection brief-description">
+		<ul>
+<li>Returns a reference to the object holding the private data or information that will be used for sorting.</li>
+<li>Most custom objects will return <i>self</i>, as is the case for <a href="../Classes/NSFNanoBag.html">NSFNanoBag</a>. Since we can sort a bag by <i>name</i>, <i>key</i> or <i>hasUnsavedChanges</i>,</li>
+<li>NanoStore requires a hint to find the attribute. This hint is the root object, which KVC uses to perform the sort. Taking <a href="../Classes/NSFNanoBag.html">NSFNanoBag</a> as an example:
+@code
+@interface <a href="../Classes/NSFNanoBag.html">NSFNanoBag</a> : NSObject <a href="NSFNanoObjectProtocol.html">NSFNanoObjectProtocol</a>, NSCopying>
+{
+  <a href="../Classes/NSFNanoStore.html">NSFNanoStore</a>            <em>store;
+  NSString                </em>name;
+  NSString                *key;
+  BOOL                    hasUnsavedChanges;
+}
+@endcode</li>
+<li>The implementation of <i>rootObject</i> would look like so:
+@code</li>
+<li>(id)rootObject
+{
+  return self;
+}
+@endcode</li>
+<li>Other objects may point directly to the collection that holds the information. <a href="../Classes/NSFNanoObject.html">NSFNanoObject</a> stores all its data in the <i>info</i> dictionary, so the</li>
+<li>implementation looks like this:
+@code</li>
+<li>(id)rootObject
+{
+  return info;
+}
+@endcode</li>
+<li>Assuming that <i>info</i> contains a key named <i>City</i>, we would specify a <a href="../Classes/NSFNanoSortDescriptor.html">NSFNanoSortDescriptor</a> which would sort the cities like so:
+@code
+<a href="../Classes/NSFNanoSortDescriptor.html">NSFNanoSortDescriptor</a> *sortedCities = [[NSFNanoSortDescriptor alloc]initWithAttribute:@&ldquo;City&rdquo; ascending:YES];
+@endcode</li>
+<li>If we had returned <i>self</i> as the root object, the sort descriptor would have to be written like so:
+@code
+NSFNanoSortDescriptor *sortedCities = [[NSFNanoSortDescriptor alloc]initWithAttribute:@&ldquo;info.City&rdquo; ascending:YES];
+@endcode</li>
+</ul>
+	</div>
+	<div class="method-subsection method-declaration"><code>- (id)rootObject</code></div>
+	<div class="method-subsection discussion-section">
+		<h4 class="method-subtitle">Discussion</h4>
+		<ul>
+<li>Returns a reference to the object holding the private data or information that will be used for sorting.</li>
+<li>Most custom objects will return <i>self</i>, as is the case for <a href="../Classes/NSFNanoBag.html">NSFNanoBag</a>. Since we can sort a bag by <i>name</i>, <i>key</i> or <i>hasUnsavedChanges</i>,</li>
+<li>NanoStore requires a hint to find the attribute. This hint is the root object, which KVC uses to perform the sort. Taking <a href="../Classes/NSFNanoBag.html">NSFNanoBag</a> as an example:
+@code
+@interface <a href="../Classes/NSFNanoBag.html">NSFNanoBag</a> : NSObject <a href="NSFNanoObjectProtocol.html">NSFNanoObjectProtocol</a>, NSCopying>
+{
+  <a href="../Classes/NSFNanoStore.html">NSFNanoStore</a>            <em>store;
+  NSString                </em>name;
+  NSString                *key;
+  BOOL                    hasUnsavedChanges;
+}
+@endcode</li>
+<li>The implementation of <i>rootObject</i> would look like so:
+@code</li>
+<li>(id)rootObject
+{
+  return self;
+}
+@endcode</li>
+<li>Other objects may point directly to the collection that holds the information. <a href="../Classes/NSFNanoObject.html">NSFNanoObject</a> stores all its data in the <i>info</i> dictionary, so the</li>
+<li>implementation looks like this:
+@code</li>
+<li>(id)rootObject
+{
+  return info;
+}
+@endcode</li>
+<li>Assuming that <i>info</i> contains a key named <i>City</i>, we would specify a <a href="../Classes/NSFNanoSortDescriptor.html">NSFNanoSortDescriptor</a> which would sort the cities like so:
+@code
+<a href="../Classes/NSFNanoSortDescriptor.html">NSFNanoSortDescriptor</a> *sortedCities = [[NSFNanoSortDescriptor alloc]initWithAttribute:@&ldquo;City&rdquo; ascending:YES];
+@endcode</li>
+<li>If we had returned <i>self</i> as the root object, the sort descriptor would have to be written like so:
+@code
+NSFNanoSortDescriptor *sortedCities = [[NSFNanoSortDescriptor alloc]initWithAttribute:@&ldquo;info.City&rdquo; ascending:YES];
+@endcode</li>
+</ul>
+	</div>
+	<div class="method-subsection declared-in-section">
+		<h4 class="method-subtitle">Declared In</h4>
+		<code class="declared-in-ref">NSFNanoObjectProtocol.h</code><br />
+	</div>
+</div>
+					</div>
+				</div>
+				<div class="main-navigation navigation-bottom">
+					<ul>
+	<li><a href="../index.html">Index</a></li>
+	<li><a href="../hierarchy.html">Hierarchy</a></li>
+</ul>
+				</div>
+				<div id="footer">
+					<hr />
+					<div class="footer-copyright">
+						<p><span class="copyright">&copy; 2013 Tito Ciuro. All rights reserved. (Last updated: 2013-01-22)</span><br />
+						<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.5 (build 789)</a>.</span></p>
+					</div>
+				</div>
+			</div>
+		</article>
+		<script type="text/javascript">
+			function jumpToChange()
+			{
+				window.location.hash = this.options[this.selectedIndex].value;
+			}
+			function toggleTOC()
+			{
+				var contents = document.getElementById('contents');
+				var tocContainer = document.getElementById('tocContainer');
+				if (this.getAttribute('class') == 'open')
+				{
+					this.setAttribute('class', '');
+					contents.setAttribute('class', '');
+					tocContainer.setAttribute('class', '');
+					window.name = "hideTOC";
+				}
+				else
+				{
+					this.setAttribute('class', 'open');
+					contents.setAttribute('class', 'isShowingTOC');
+					tocContainer.setAttribute('class', 'isShowingTOC');
+					window.name = "";
+				}
+				return false;
+			}
+			function toggleTOCEntryChildren(e)
+			{
+				e.stopPropagation();
+				var currentClass = this.getAttribute('class');
+				if (currentClass == 'children') {
+					this.setAttribute('class', 'children open');
+				}
+				else if (currentClass == 'children open') {
+					this.setAttribute('class', 'children');
+				}
+				return false;
+			}
+			function tocEntryClick(e)
+			{
+				e.stopPropagation();
+				return true;
+			}
+			function init()
+			{
+				var selectElement = document.getElementById('jumpTo');
+				selectElement.addEventListener('change', jumpToChange, false);
+				var tocButton = document.getElementById('table_of_contents');
+				tocButton.addEventListener('click', toggleTOC, false);
+				var taskTreeItem = document.getElementById('task_treeitem');
+				if (taskTreeItem.getElementsByTagName('li').length > 0)
+				{
+					taskTreeItem.setAttribute('class', 'children');
+					taskTreeItem.firstChild.setAttribute('class', 'disclosure');
+				}
+				var tocList = document.getElementById('toc');
+				var tocEntries = tocList.getElementsByTagName('li');
+				for (var i = 0; i < tocEntries.length; i++) {
+					tocEntries[i].addEventListener('click', toggleTOCEntryChildren, false);
+				}
+				var tocLinks = tocList.getElementsByTagName('a');
+				for (var i = 0; i < tocLinks.length; i++) {
+					tocLinks[i].addEventListener('click', tocEntryClick, false);
+				}
+				if (window.name == "hideTOC") {
+					toggleTOC.call(tocButton);
+				}
+			}
+			window.onload = init;
+			// If showing in Xcode, hide the TOC and Header
+			if (navigator.userAgent.match(/xcode/i)) {
+				document.getElementById("contents").className = "hideInXcode"
+				document.getElementById("tocContainer").className = "hideInXcode"
+				document.getElementById("top_header").className = "hideInXcode"
+			}
+		</script>
+	</body>
+</html>