<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title> Class: PhraseParser::Query — Documentation by YARD 0.9.28 </title> <link rel="stylesheet" href="../css/style.css" type="text/css" /> <link rel="stylesheet" href="../css/common.css" type="text/css" /> <script type="text/javascript"> pathId = "PhraseParser::Query"; relpath = '../'; </script> <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> <script type="text/javascript" charset="utf-8" src="../js/app.js"></script> </head> <body> <div class="nav_wrap"> <iframe id="nav" src="../class_list.html?1"></iframe> <div id="resizer"></div> </div> <div id="main" tabindex="-1"> <div id="header"> <div id="menu"> <a href="../_index.html">Index (Q)</a> » <span class='title'><span class='object_link'><a href="../PhraseParser.html" title="PhraseParser (module)">PhraseParser</a></span></span> » <span class="title">Query</span> </div> <div id="search"> <a class="full_list_link" id="class_list_link" href="../class_list.html"> <svg width="24" height="24"> <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect> <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect> <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect> </svg> </a> </div> <div class="clear"></div> </div> <div id="content"><h1>Class: PhraseParser::Query </h1> <div class="box_info"> <dl> <dt>Inherits:</dt> <dd> <span class="inheritName"><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></span> <ul class="fullTree"> <li><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></li> <li class="next">PhraseParser::Query</li> </ul> <a href="#" class="inheritanceTree">show all</a> </dd> </dl> <dl> <dt>Defined in:</dt> <dd>lib/doing/phrase_parser.rb</dd> </dl> </div> <h2>Overview</h2><div class="docstring"> <div class="discussion"> <p>Query object</p> </div> </div> <div class="tags"> </div> <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2> <ul class="summary"> <li class="public "> <span class="summary_signature"> <a href="#must_clauses-instance_method" title="#must_clauses (instance method)">#<strong>must_clauses</strong> ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'><p>Returns the value of attribute must_clauses.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#must_not_clauses-instance_method" title="#must_not_clauses (instance method)">#<strong>must_not_clauses</strong> ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'><p>Returns the value of attribute must_not_clauses.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#should_clauses-instance_method" title="#should_clauses (instance method)">#<strong>should_clauses</strong> ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'><p>Returns the value of attribute should_clauses.</p> </div></span> </li> </ul> <h2> Instance Method Summary <small><a href="#" class="summary_toggle">collapse</a></small> </h2> <ul class="summary"> <li class="public "> <span class="summary_signature"> <a href="#clause_to_query-instance_method" title="#clause_to_query (instance method)">#<strong>clause_to_query</strong>(clause) ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(clauses) ⇒ Query </a> </span> <span class="note title constructor">constructor</span> <span class="summary_desc"><div class='inline'><p>A new instance of Query.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#match-instance_method" title="#match (instance method)">#<strong>match</strong>(term) ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#match_phrase-instance_method" title="#match_phrase (instance method)">#<strong>match_phrase</strong>(phrase) ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#to_elasticsearch-instance_method" title="#to_elasticsearch (instance method)">#<strong>to_elasticsearch</strong> ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'></div></span> </li> </ul> <div id="constructor_details" class="method_details_list"> <h2>Constructor Details</h2> <div class="method_details first"> <h3 class="signature first" id="initialize-instance_method"> #<strong>initialize</strong>(clauses) ⇒ <tt><span class='object_link'><a href="" title="PhraseParser::Query (class)">Query</a></span></tt> </h3><div class="docstring"> <div class="discussion"> <p>Returns a new instance of Query.</p> </div> </div> <div class="tags"> </div> </div> </div> <div id="instance_attr_details" class="attr_details"> <h2>Instance Attribute Details</h2> <span id="must_clauses=-instance_method"></span> <div class="method_details first"> <h3 class="signature first" id="must_clauses-instance_method"> #<strong>must_clauses</strong> ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt> </h3><div class="docstring"> <div class="discussion"> <p>Returns the value of attribute must_clauses.</p> </div> </div> <div class="tags"> </div> </div> <span id="must_not_clauses=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="must_not_clauses-instance_method"> #<strong>must_not_clauses</strong> ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt> </h3><div class="docstring"> <div class="discussion"> <p>Returns the value of attribute must_not_clauses.</p> </div> </div> <div class="tags"> </div> </div> <span id="should_clauses=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="should_clauses-instance_method"> #<strong>should_clauses</strong> ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt> </h3><div class="docstring"> <div class="discussion"> <p>Returns the value of attribute should_clauses.</p> </div> </div> <div class="tags"> </div> </div> </div> <div id="instance_method_details" class="method_details_list"> <h2>Instance Method Details</h2> <div class="method_details first"> <h3 class="signature first" id="clause_to_query-instance_method"> #<strong>clause_to_query</strong>(clause) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt> </h3> </div> <div class="method_details "> <h3 class="signature " id="match-instance_method"> #<strong>match</strong>(term) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt> </h3> </div> <div class="method_details "> <h3 class="signature " id="match_phrase-instance_method"> #<strong>match_phrase</strong>(phrase) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt> </h3> </div> <div class="method_details "> <h3 class="signature " id="to_elasticsearch-instance_method"> #<strong>to_elasticsearch</strong> ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt> </h3> </div> </div> </div> <div id="footer"> Generated on Sat Mar 11 05:55:29 2023 by <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.28 (ruby-3.0.1). </div> </div> </body> </html>