spahql
Version:
A query language and data model for deep Javascript object structures.
246 lines (151 loc) • 14 kB
HTML
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>SpahQL v0.7.0 API documentation | SpahQL.Token.PathComponent</title>
<meta name="generator" content="PDoc" />
<script charset="utf-8" src="../../../javascripts/pdoc/prototype.js" type="text/javascript"></script>
<script charset="utf-8" src="../../../javascripts/pdoc/application.js" type="text/javascript"></script>
<script charset="utf-8" src="../../../javascripts/pdoc/tabs.js" type="text/javascript"></script>
<script charset="utf-8" src="../../../javascripts/pdoc/item_index.js" type="text/javascript"></script>
<link charset="utf-8" href="../../../stylesheets/pdoc/api.css" media="screen, projection" rel="stylesheet" type="text/css" />
<link charset="utf-8" href="../../../stylesheets/pdoc/pygments.css" media="screen, projection" rel="stylesheet" type="text/css" />
<script type="text/javascript">
PDoc.pathPrefix = '../../../';
</script>
</head>
<body>
<div id="sidebar">
<ul id="sidebar_tabs" class="sidebar-tabs">
<li>
<a href="#menu_pane">Menu</a>
</li>
<li>
<a href="#search_pane">Search</a>
</li>
</ul> <!-- .sidebar-tabs -->
<form class="search-ribbon">
<label>
<span class="hidden">Search</span>
<input type="text" id="search" size="20" title="Search" />
</label>
</form>
<div class="sidebar-pane scrollable" id="menu_pane">
<ul class="menu-items" id="api_menu"><li><div class="menu-item"><a class="class current-parent" href="../../../SpahQL/index.html" title="SpahQL (class)">SpahQL</a></div><ul><li><div class="menu-item"><a class="class" href="../../../SpahQL/Callbacks/index.html" title="SpahQL.Callbacks (class)">SpahQL.Callbacks</a></div></li>
<li><div class="menu-item"><a class="class" href="../../../SpahQL/DataHelper/index.html" title="SpahQL.DataHelper (class)">SpahQL.DataHelper</a></div></li>
<li><div class="menu-item"><a class="class" href="../../../SpahQL/Errors/index.html" title="SpahQL.Errors (class)">SpahQL.Errors</a></div><ul><li><div class="menu-item"><a class="class" href="../../../SpahQL/Errors/SpahQLError/index.html" title="SpahQL.Errors.SpahQLError (class)">SpahQL.Errors.SpahQLError</a></div></li>
<li><div class="menu-item"><a class="class" href="../../../SpahQL/Errors/SpahQLRunTimeError/index.html" title="SpahQL.Errors.SpahQLRunTimeError (class)">SpahQL.Errors.SpahQLRunTimeError</a></div></li></ul></li>
<li><div class="menu-item"><a class="class" href="../../../SpahQL/Query/index.html" title="SpahQL.Query (class)">SpahQL.Query</a></div></li>
<li><div class="menu-item"><a class="class" href="../../../SpahQL/QueryParser/index.html" title="SpahQL.QueryParser (class)">SpahQL.QueryParser</a></div></li>
<li><div class="menu-item"><a class="class" href="../../../SpahQL/QueryRunner/index.html" title="SpahQL.QueryRunner (class)">SpahQL.QueryRunner</a></div></li>
<li><div class="menu-item"><a class="class" href="../../../SpahQL/Strategiser/index.html" title="SpahQL.Strategiser (class)">SpahQL.Strategiser</a></div></li>
<li><div class="menu-item"><a class="class current-parent" href="../../../SpahQL/Token/index.html" title="SpahQL.Token (class)">SpahQL.Token</a></div><ul><li><div class="menu-item"><a class="class" href="../../../SpahQL/Token/Base/index.html" title="SpahQL.Token.Base (class)">SpahQL.Token.Base</a></div></li>
<li><div class="menu-item"><a class="class" href="../../../SpahQL/Token/Boolean/index.html" title="SpahQL.Token.Boolean (class)">SpahQL.Token.Boolean</a></div></li>
<li><div class="menu-item"><a class="class" href="../../../SpahQL/Token/ComparisonOperator/index.html" title="SpahQL.Token.ComparisonOperator (class)">SpahQL.Token.ComparisonOperator</a></div></li>
<li><div class="menu-item"><a class="class" href="../../../SpahQL/Token/FilterQuery/index.html" title="SpahQL.Token.FilterQuery (class)">SpahQL.Token.FilterQuery</a></div></li>
<li><div class="menu-item"><a class="class" href="../../../SpahQL/Token/KeyName/index.html" title="SpahQL.Token.KeyName (class)">SpahQL.Token.KeyName</a></div></li>
<li><div class="menu-item"><a class="class" href="../../../SpahQL/Token/Numeric/index.html" title="SpahQL.Token.Numeric (class)">SpahQL.Token.Numeric</a></div></li>
<li><div class="menu-item"><a class="class current" href="../../../SpahQL/Token/PathComponent/index.html" title="SpahQL.Token.PathComponent (class)">SpahQL.Token.PathComponent</a></div><ul><li><div class="menu-item"><a class="constructor" href="../../../SpahQL/Token/PathComponent/new/index.html" title="new SpahQL.Token.PathComponent (constructor)">new</a></div></li>
<li><div class="menu-item"><a class="class-method" href="../../../SpahQL/Token/PathComponent/parseAt/index.html" title="SpahQL.Token.PathComponent.parseAt (class method)">parseAt</a></div></li>
<li><div class="menu-item"><a class="instance-method" href="../../../SpahQL/Token/PathComponent/prototype/evaluate/index.html" title="SpahQL.Token.PathComponent#evaluate (instance method)">evaluate</a></div></li>
<li><div class="menu-item"><a class="instance-method" href="../../../SpahQL/Token/PathComponent/prototype/fetchResultsFromObjectByKey/index.html" title="SpahQL.Token.PathComponent#fetchResultsFromObjectByKey (instance method)">fetchResultsFromObjectByKey</a></div></li>
<li><div class="menu-item"><a class="instance-method" href="../../../SpahQL/Token/PathComponent/prototype/fetchResultsFromObjectByProperty/index.html" title="SpahQL.Token.PathComponent#fetchResultsFromObjectByProperty (instance method)">fetchResultsFromObjectByProperty</a></div></li>
<li><div class="menu-item"><a class="instance-property" href="../../../SpahQL/Token/PathComponent/prototype/filterQueries/index.html" title="SpahQL.Token.PathComponent#filterQueries (instance property)">filterQueries</a></div></li>
<li><div class="menu-item"><a class="instance-property" href="../../../SpahQL/Token/PathComponent/prototype/key/index.html" title="SpahQL.Token.PathComponent#key (instance property)">key</a></div></li>
<li><div class="menu-item"><a class="instance-property" href="../../../SpahQL/Token/PathComponent/prototype/property/index.html" title="SpahQL.Token.PathComponent#property (instance property)">property</a></div></li>
<li><div class="menu-item"><a class="instance-property" href="../../../SpahQL/Token/PathComponent/prototype/recursive/index.html" title="SpahQL.Token.PathComponent#recursive (instance property)">recursive</a></div></li></ul></li>
<li><div class="menu-item"><a class="class" href="../../../SpahQL/Token/SelectionQuery/index.html" title="SpahQL.Token.SelectionQuery (class)">SpahQL.Token.SelectionQuery</a></div></li>
<li><div class="menu-item"><a class="class" href="../../../SpahQL/Token/Set/index.html" title="SpahQL.Token.Set (class)">SpahQL.Token.Set</a></div></li>
<li><div class="menu-item"><a class="class" href="../../../SpahQL/Token/Simple/index.html" title="SpahQL.Token.Simple (class)">SpahQL.Token.Simple</a></div></li>
<li><div class="menu-item"><a class="class" href="../../../SpahQL/Token/String/index.html" title="SpahQL.Token.String (class)">SpahQL.Token.String</a></div></li></ul><ul><li><div class="menu-item"><a class="class-method" href="../../../SpahQL/Token/parseAt/index.html" title="SpahQL.Token.parseAt (class method)">parseAt</a></div></li>
<li><div class="menu-item"><a class="class-method" href="../../../SpahQL/Token/throwParseErrorAt/index.html" title="SpahQL.Token.throwParseErrorAt (class method)">throwParseErrorAt</a></div></li>
<li><div class="menu-item"><a class="instance-method" href="../../../SpahQL/Token/prototype/toSet/index.html" title="SpahQL.Token#toSet (instance method)">toSet</a></div></li></ul></li></ul></li></ul><!--- #api_menu =-->
</div> <!-- .sidebar-pane -->
<div class="sidebar-pane" id="search_pane">
<ul id="search_results" class="search-results menu-items scrollable"></ul>
</div> <!-- .sidebar-pane -->
</div> <!-- #sidebar -->
<div id="page">
<div id="main" class="page-content">
<ul class="breadcrumbs clearfix">
<li><a href="../../../">Home</a></li>
<li>→ <a href="../../../SpahQL/index.html" title="SpahQL (class)">SpahQL</a></li>
<li>→ <a href="../../../SpahQL/Token/index.html" title="SpahQL.Token (class)">Token</a></li>
<li>→ <a href="../../../SpahQL/Token/PathComponent/index.html" title="SpahQL.Token.PathComponent (class)">PathComponent</a></li>
</ul>
<p id="src_code_href"><a href="http://github.com/danski/spahql/blob/master/src/SpahQL.Token.PathComponent.js#7">src code</a></p>
<h2 class="page-title">
<span class="type">class</span> SpahQL.Token.PathComponent
</h2>
<div class="section section-description">
<div class="section-title">
<h3>Description</h3>
</div> <!-- .section-title -->
<div class="section-content">
<p>A token describing any path component within a selection query, comprised of one or two path delimiters followed by a key or property name and an optional set of filter query tokens.</p>
</div> <!-- .section-content -->
</div> <!-- .section -->
<div class="section section-superclass">
<div class="section-title">
<h3>Superclass</h3>
</div> <!-- .section-title -->
<div class="section-content">
<p><code><a href="../../../SpahQL/Token/Base/index.html" title="SpahQL.Token.Base (class)">SpahQL.Token.Base</a></code></p>
</div> <!-- .section-content -->
</div> <!-- .section -->
<div class="section section-constructor">
<div class="section-title">
<h3>Constructor</h3>
</div> <!-- .section-title -->
<div class="section-content">
<p><code><a href="../../../SpahQL/Token/PathComponent/new/index.html" title="new SpahQL.Token.PathComponent (constructor)">new SpahQL.Token.PathComponent</a></code></p>
</div> <!-- .section-content -->
</div> <!-- .section -->
<div class="section section-class_methods">
<div class="section-title">
<h3>Class methods</h3>
</div> <!-- .section-title -->
<div class="section-content">
<ul class="method-list">
<li><code><a class="class-method" href="../../../SpahQL/Token/PathComponent/parseAt/index.html" title="SpahQL.Token.PathComponent.parseAt (class method)">parseAt</a></code></li>
</ul>
</div> <!-- .section-content -->
</div> <!-- .section -->
<div class="section section-instance_methods">
<div class="section-title">
<h3>Instance methods</h3>
</div> <!-- .section-title -->
<div class="section-content">
<ul class="method-list">
<li><code><a class="instance-method" href="../../../SpahQL/Token/PathComponent/prototype/evaluate/index.html" title="SpahQL.Token.PathComponent#evaluate (instance method)">evaluate</a></code></li>
<li><code><a class="instance-method" href="../../../SpahQL/Token/PathComponent/prototype/fetchResultsFromObjectByKey/index.html" title="SpahQL.Token.PathComponent#fetchResultsFromObjectByKey (instance method)">fetchResultsFromObjectByKey</a></code></li>
<li><code><a class="instance-method" href="../../../SpahQL/Token/PathComponent/prototype/fetchResultsFromObjectByProperty/index.html" title="SpahQL.Token.PathComponent#fetchResultsFromObjectByProperty (instance method)">fetchResultsFromObjectByProperty</a></code></li>
</ul>
</div> <!-- .section-content -->
</div> <!-- .section -->
<div class="section section-instance_properties">
<div class="section-title">
<h3>Instance properties</h3>
</div> <!-- .section-title -->
<div class="section-content">
<ul class="method-list">
<li><code><a class="instance-property" href="../../../SpahQL/Token/PathComponent/prototype/filterQueries/index.html" title="SpahQL.Token.PathComponent#filterQueries (instance property)">filterQueries</a></code></li>
<li><code><a class="instance-property" href="../../../SpahQL/Token/PathComponent/prototype/key/index.html" title="SpahQL.Token.PathComponent#key (instance property)">key</a></code></li>
<li><code><a class="instance-property" href="../../../SpahQL/Token/PathComponent/prototype/property/index.html" title="SpahQL.Token.PathComponent#property (instance property)">property</a></code></li>
<li><code><a class="instance-property" href="../../../SpahQL/Token/PathComponent/prototype/recursive/index.html" title="SpahQL.Token.PathComponent#recursive (instance property)">recursive</a></code></li>
</ul>
</div> <!-- .section-content -->
</div> <!-- .section -->
</div> <!-- #main -->
<div id="footer">
<p><a href="http://danski.github.com/spahql">SpahQL</a> v0.7.0 API documentation.</p>
<p>
Last updated on May 19, 2012 at 14:16 UTC.
Generated by <a href="http://pdoc.org">PDoc</a>.
Uses <a href="http://famfamfam.com/lab/icons/silk/" title="famfamfam.com: Silk Icons">Silk Icons</a> and portions of <a href="http://github.com/280north/aristo/tree/master" title="280north's aristo at master - GitHub">Aristo</a>.
</p>
</div> <!-- #footer -->
</div> <!-- #page -->
</body>
</html>