classes/Estraier/Condition.html

<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html 
     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>Class: Estraier::Condition</title>
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
  <meta http-equiv="Content-Script-Type" content="text/javascript" />
  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
  <script type="text/javascript">
  // <![CDATA[

  function popupCode( url ) {
    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
  }

  function toggleCode( id ) {
    if ( document.getElementById )
      elem = document.getElementById( id );
    else if ( document.all )
      elem = eval( "document.all." + id );
    else
      return false;

    elemStyle = elem.style;
    
    if ( elemStyle.display != "block" ) {
      elemStyle.display = "block"
    } else {
      elemStyle.display = "none"
    }

    return true;
  }
  
  // Make codeblocks hidden by default
  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
  
  // ]]>
  </script>

</head>
<body>


    <div id="classHeader">
        <table class="header-table">
        <tr class="top-aligned-row">
          <td><strong>Class</strong></td>
          <td class="class-name-in-header">Estraier::Condition</td>
        </tr>
        <tr class="top-aligned-row">
            <td><strong>In:</strong></td>
            <td>
                <a href="../../files/estraier_rb.html">
                estraier.rb
                </a>
        <br />
            </td>
        </tr>

        <tr class="top-aligned-row">
            <td><strong>Parent:</strong></td>
            <td>
                Object
            </td>
        </tr>
        </table>
    </div>
  <!-- banner header -->

  <div id="bodyContent">


  <div id="contextContent">

    <div id="description">
      <p>
Abstraction of search condition.
</p>

    </div>


   </div>

    <div id="method-list">
      <h3 class="section-bar">Methods</h3>

      <div class="name-list">
      <a href="#M000033">add_attr</a>&nbsp;&nbsp;
      <a href="#M000038">attrs</a>&nbsp;&nbsp;
      <a href="#M000040">max</a>&nbsp;&nbsp;
      <a href="#M000042">new</a>&nbsp;&nbsp;
      <a href="#M000041">options</a>&nbsp;&nbsp;
      <a href="#M000039">order</a>&nbsp;&nbsp;
      <a href="#M000037">phrase</a>&nbsp;&nbsp;
      <a href="#M000035">set_max</a>&nbsp;&nbsp;
      <a href="#M000036">set_options</a>&nbsp;&nbsp;
      <a href="#M000034">set_order</a>&nbsp;&nbsp;
      <a href="#M000032">set_phrase</a>&nbsp;&nbsp;
      </div>
    </div>

  </div>


    <!-- if includes -->

    <div id="section">


    <div id="constants-list">
      <h3 class="section-bar">Constants</h3>

      <div class="name-list">
        <table summary="Constants">
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">CONDSURE</td>
          <td>=</td>
          <td class="context-item-value">1 &lt;&lt; 0</td>
          <td width="3em">&nbsp;</td>
          <td class="context-item-desc">
option: check N-gram keys skipping by three

</td>
        </tr>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">CONDUSU</td>
          <td>=</td>
          <td class="context-item-value">1 &lt;&lt; 1</td>
          <td width="3em">&nbsp;</td>
          <td class="context-item-desc">
option: check N-gram keys skipping by two

</td>
        </tr>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">CONDFAST</td>
          <td>=</td>
          <td class="context-item-value">1 &lt;&lt; 2</td>
          <td width="3em">&nbsp;</td>
          <td class="context-item-desc">
option: without TF-IDF tuning

</td>
        </tr>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">CONDAGIT</td>
          <td>=</td>
          <td class="context-item-value">1 &lt;&lt; 3</td>
          <td width="3em">&nbsp;</td>
          <td class="context-item-desc">
option: with the simplified phrase

</td>
        </tr>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">CONDNOIDF</td>
          <td>=</td>
          <td class="context-item-value">1 &lt;&lt; 4</td>
          <td width="3em">&nbsp;</td>
          <td class="context-item-desc">
option: check every N-gram key

</td>
        </tr>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">CONDSIMPLE</td>
          <td>=</td>
          <td class="context-item-value">1 &lt;&lt; 10</td>
          <td width="3em">&nbsp;</td>
          <td class="context-item-desc">
option: check N-gram keys skipping by one

</td>
        </tr>
        </table>
      </div>
    </div>


    <!-- if method_list -->
    <div id="methods">
      <h3 class="section-bar">Public Class methods</h3>

      <div id="method-M000042" class="method-detail">
        <a name="M000042"></a>

        <div class="method-heading">
          <a href="Condition.src/M000042.html" target="Code" class="method-signature"
            onclick="popupCode('Condition.src/M000042.html');return false;">
          <span class="method-name">new</span><span class="method-args">()</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Create a search condition object.
</p>
        </div>
      </div>

      <h3 class="section-bar">Public Instance methods</h3>

      <div id="method-M000033" class="method-detail">
        <a name="M000033"></a>

        <div class="method-heading">
          <a href="Condition.src/M000033.html" target="Code" class="method-signature"
            onclick="popupCode('Condition.src/M000033.html');return false;">
          <span class="method-name">add_attr</span><span class="method-args">(expr)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Add an expression for an attribute. `expr&#8217; specifies an expression
for an attribute.
</p>
        </div>
      </div>

      <div id="method-M000038" class="method-detail">
        <a name="M000038"></a>

        <div class="method-heading">
          <a href="Condition.src/M000038.html" target="Code" class="method-signature"
            onclick="popupCode('Condition.src/M000038.html');return false;">
          <span class="method-name">attrs</span><span class="method-args">()</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Get expressions for attributes. The return value is expressions for
attributes.
</p>
        </div>
      </div>

      <div id="method-M000040" class="method-detail">
        <a name="M000040"></a>

        <div class="method-heading">
          <a href="Condition.src/M000040.html" target="Code" class="method-signature"
            onclick="popupCode('Condition.src/M000040.html');return false;">
          <span class="method-name">max</span><span class="method-args">()</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Get the maximum number of retrieval. The return value is the maximum number
of retrieval.
</p>
        </div>
      </div>

      <div id="method-M000041" class="method-detail">
        <a name="M000041"></a>

        <div class="method-heading">
          <a href="Condition.src/M000041.html" target="Code" class="method-signature"
            onclick="popupCode('Condition.src/M000041.html');return false;">
          <span class="method-name">options</span><span class="method-args">()</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Get options of retrieval. The return value is options by bitwise or.
</p>
        </div>
      </div>

      <div id="method-M000039" class="method-detail">
        <a name="M000039"></a>

        <div class="method-heading">
          <a href="Condition.src/M000039.html" target="Code" class="method-signature"
            onclick="popupCode('Condition.src/M000039.html');return false;">
          <span class="method-name">order</span><span class="method-args">()</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Get the order expression. The return value is the order expression.
</p>
        </div>
      </div>

      <div id="method-M000037" class="method-detail">
        <a name="M000037"></a>

        <div class="method-heading">
          <a href="Condition.src/M000037.html" target="Code" class="method-signature"
            onclick="popupCode('Condition.src/M000037.html');return false;">
          <span class="method-name">phrase</span><span class="method-args">()</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Get the search phrase. The return value is the search phrase.
</p>
        </div>
      </div>

      <div id="method-M000035" class="method-detail">
        <a name="M000035"></a>

        <div class="method-heading">
          <a href="Condition.src/M000035.html" target="Code" class="method-signature"
            onclick="popupCode('Condition.src/M000035.html');return false;">
          <span class="method-name">set_max</span><span class="method-args">(max)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Set the maximum number of retrieval. `max&#8217; specifies the maximum
number of retrieval. By default, the number of retrieval is not limited.
</p>
        </div>
      </div>

      <div id="method-M000036" class="method-detail">
        <a name="M000036"></a>

        <div class="method-heading">
          <a href="Condition.src/M000036.html" target="Code" class="method-signature"
            onclick="popupCode('Condition.src/M000036.html');return false;">
          <span class="method-name">set_options</span><span class="method-args">(options)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Set options of retrieval. `options&#8217; specifies options:
`Condition::ESTCONDSURE&#8217; specifies that it checks every N-gram key,
`Condition::ESTCONDUSU&#8217;, which is the default, specifies that it
checks N-gram keys with skipping one key, `Condition::ESTCONDFAST&#8217;
skips two keys, `Condition::ESTCONDAGIT&#8217; skips three keys,
`Condition::ESTCONDNOIDF&#8217; specifies not to perform TF-IDF tuning,
`Condition::ESTCONDSIMPLE&#8217; specifies to use simplified phrase. Each
option can be specified at the same time by bitwise or. If keys are
skipped, though search speed is improved, the relevance ratio grows less.
</p>
        </div>
      </div>

      <div id="method-M000034" class="method-detail">
        <a name="M000034"></a>

        <div class="method-heading">
          <a href="Condition.src/M000034.html" target="Code" class="method-signature"
            onclick="popupCode('Condition.src/M000034.html');return false;">
          <span class="method-name">set_order</span><span class="method-args">(expr)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Set the order of a condition object. `expr&#8217; specifies an expression
for the order. By default, the order is by score descending.
</p>
        </div>
      </div>

      <div id="method-M000032" class="method-detail">
        <a name="M000032"></a>

        <div class="method-heading">
          <a href="Condition.src/M000032.html" target="Code" class="method-signature"
            onclick="popupCode('Condition.src/M000032.html');return false;">
          <span class="method-name">set_phrase</span><span class="method-args">(phrase)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Set the search phrase. `phrase&#8217; specifies a search phrase.
</p>
        </div>
      </div>


    </div>


  </div>


<div id="validator-badges">
  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>

</body>
</html>
1	dpavlin	10	<?xml version="1.0" encoding="iso-8859-1"?>
2			<!DOCTYPE html
3			PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4			"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6			<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7			<head>
8			<title>Class: Estraier::Condition</title>
9			<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10			<meta http-equiv="Content-Script-Type" content="text/javascript" />
11			<link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
12			<script type="text/javascript">
13			// <![CDATA[
14
15			function popupCode( url ) {
16			window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
17			}
18
19			function toggleCode( id ) {
20			if ( document.getElementById )
21			elem = document.getElementById( id );
22			else if ( document.all )
23			elem = eval( "document.all." + id );
24			else
25			return false;
26
27			elemStyle = elem.style;
28
29			if ( elemStyle.display != "block" ) {
30			elemStyle.display = "block"
31			} else {
32			elemStyle.display = "none"
33			}
34
35			return true;
36			}
37
38			// Make codeblocks hidden by default
39			document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
40
41			// ]]>
42			</script>
43
44			</head>
45			<body>
46
47
48
49			<div id="classHeader">
50			<table class="header-table">
51			<tr class="top-aligned-row">
52			<td><strong>Class</strong></td>
53			<td class="class-name-in-header">Estraier::Condition</td>
54			</tr>
55			<tr class="top-aligned-row">
56			<td><strong>In:</strong></td>
57			<td>
58			<a href="../../files/estraier_rb.html">
59			estraier.rb
60			</a>
61			<br />
62			</td>
63			</tr>
64
65			<tr class="top-aligned-row">
66			<td><strong>Parent:</strong></td>
67			<td>
68			Object
69			</td>
70			</tr>
71			</table>
72			</div>
73			<!-- banner header -->
74
75			<div id="bodyContent">
76
77
78
79			<div id="contextContent">
80
81			<div id="description">
82			<p>
83			Abstraction of search condition.
84			</p>
85
86			</div>
87
88
89			</div>
90
91			<div id="method-list">
92			<h3 class="section-bar">Methods</h3>
93
94			<div class="name-list">
95			<a href="#M000033">add_attr</a>
96			<a href="#M000038">attrs</a>
97			<a href="#M000040">max</a>
98			<a href="#M000042">new</a>
99			<a href="#M000041">options</a>
100			<a href="#M000039">order</a>
101			<a href="#M000037">phrase</a>
102			<a href="#M000035">set_max</a>
103			<a href="#M000036">set_options</a>
104			<a href="#M000034">set_order</a>
105			<a href="#M000032">set_phrase</a>
106			</div>
107			</div>
108
109			</div>
110
111
112			<!-- if includes -->
113
114			<div id="section">
115
116
117			<div id="constants-list">
118			<h3 class="section-bar">Constants</h3>
119
120			<div class="name-list">
121			<table summary="Constants">
122			<tr class="top-aligned-row context-row">
123			<td class="context-item-name">CONDSURE</td>
124			<td>=</td>
125			<td class="context-item-value">1 << 0</td>
126			<td width="3em"> </td>
127			<td class="context-item-desc">
128			option: check N-gram keys skipping by three
129
130			</td>
131			</tr>
132			<tr class="top-aligned-row context-row">
133			<td class="context-item-name">CONDUSU</td>
134			<td>=</td>
135			<td class="context-item-value">1 << 1</td>
136			<td width="3em"> </td>
137			<td class="context-item-desc">
138			option: check N-gram keys skipping by two
139
140			</td>
141			</tr>
142			<tr class="top-aligned-row context-row">
143			<td class="context-item-name">CONDFAST</td>
144			<td>=</td>
145			<td class="context-item-value">1 << 2</td>
146			<td width="3em"> </td>
147			<td class="context-item-desc">
148			option: without TF-IDF tuning
149
150			</td>
151			</tr>
152			<tr class="top-aligned-row context-row">
153			<td class="context-item-name">CONDAGIT</td>
154			<td>=</td>
155			<td class="context-item-value">1 << 3</td>
156			<td width="3em"> </td>
157			<td class="context-item-desc">
158			option: with the simplified phrase
159
160			</td>
161			</tr>
162			<tr class="top-aligned-row context-row">
163			<td class="context-item-name">CONDNOIDF</td>
164			<td>=</td>
165			<td class="context-item-value">1 << 4</td>
166			<td width="3em"> </td>
167			<td class="context-item-desc">
168			option: check every N-gram key
169
170			</td>
171			</tr>
172			<tr class="top-aligned-row context-row">
173			<td class="context-item-name">CONDSIMPLE</td>
174			<td>=</td>
175			<td class="context-item-value">1 << 10</td>
176			<td width="3em"> </td>
177			<td class="context-item-desc">
178			option: check N-gram keys skipping by one
179
180			</td>
181			</tr>
182			</table>
183			</div>
184			</div>
185
186
187
188
189
190
191			<!-- if method_list -->
192			<div id="methods">
193			<h3 class="section-bar">Public Class methods</h3>
194
195			<div id="method-M000042" class="method-detail">
196			<a name="M000042"></a>
197
198			<div class="method-heading">
199			<a href="Condition.src/M000042.html" target="Code" class="method-signature"
200			onclick="popupCode('Condition.src/M000042.html');return false;">
201			<span class="method-name">new</span><span class="method-args">()</span>
202			</a>
203			</div>
204
205			<div class="method-description">
206			<p>
207			Create a search condition object.
208			</p>
209			</div>
210			</div>
211
212			<h3 class="section-bar">Public Instance methods</h3>
213
214			<div id="method-M000033" class="method-detail">
215			<a name="M000033"></a>
216
217			<div class="method-heading">
218			<a href="Condition.src/M000033.html" target="Code" class="method-signature"
219			onclick="popupCode('Condition.src/M000033.html');return false;">
220			<span class="method-name">add_attr</span><span class="method-args">(expr)</span>
221			</a>
222			</div>
223
224			<div class="method-description">
225			<p>
226			Add an expression for an attribute. `expr’ specifies an expression
227			for an attribute.
228			</p>
229			</div>
230			</div>
231
232			<div id="method-M000038" class="method-detail">
233			<a name="M000038"></a>
234
235			<div class="method-heading">
236			<a href="Condition.src/M000038.html" target="Code" class="method-signature"
237			onclick="popupCode('Condition.src/M000038.html');return false;">
238			<span class="method-name">attrs</span><span class="method-args">()</span>
239			</a>
240			</div>
241
242			<div class="method-description">
243			<p>
244			Get expressions for attributes. The return value is expressions for
245			attributes.
246			</p>
247			</div>
248			</div>
249
250			<div id="method-M000040" class="method-detail">
251			<a name="M000040"></a>
252
253			<div class="method-heading">
254			<a href="Condition.src/M000040.html" target="Code" class="method-signature"
255			onclick="popupCode('Condition.src/M000040.html');return false;">
256			<span class="method-name">max</span><span class="method-args">()</span>
257			</a>
258			</div>
259
260			<div class="method-description">
261			<p>
262			Get the maximum number of retrieval. The return value is the maximum number
263			of retrieval.
264			</p>
265			</div>
266			</div>
267
268			<div id="method-M000041" class="method-detail">
269			<a name="M000041"></a>
270
271			<div class="method-heading">
272			<a href="Condition.src/M000041.html" target="Code" class="method-signature"
273			onclick="popupCode('Condition.src/M000041.html');return false;">
274			<span class="method-name">options</span><span class="method-args">()</span>
275			</a>
276			</div>
277
278			<div class="method-description">
279			<p>
280			Get options of retrieval. The return value is options by bitwise or.
281			</p>
282			</div>
283			</div>
284
285			<div id="method-M000039" class="method-detail">
286			<a name="M000039"></a>
287
288			<div class="method-heading">
289			<a href="Condition.src/M000039.html" target="Code" class="method-signature"
290			onclick="popupCode('Condition.src/M000039.html');return false;">
291			<span class="method-name">order</span><span class="method-args">()</span>
292			</a>
293			</div>
294
295			<div class="method-description">
296			<p>
297			Get the order expression. The return value is the order expression.
298			</p>
299			</div>
300			</div>
301
302			<div id="method-M000037" class="method-detail">
303			<a name="M000037"></a>
304
305			<div class="method-heading">
306			<a href="Condition.src/M000037.html" target="Code" class="method-signature"
307			onclick="popupCode('Condition.src/M000037.html');return false;">
308			<span class="method-name">phrase</span><span class="method-args">()</span>
309			</a>
310			</div>
311
312			<div class="method-description">
313			<p>
314			Get the search phrase. The return value is the search phrase.
315			</p>
316			</div>
317			</div>
318
319			<div id="method-M000035" class="method-detail">
320			<a name="M000035"></a>
321
322			<div class="method-heading">
323			<a href="Condition.src/M000035.html" target="Code" class="method-signature"
324			onclick="popupCode('Condition.src/M000035.html');return false;">
325			<span class="method-name">set_max</span><span class="method-args">(max)</span>
326			</a>
327			</div>
328
329			<div class="method-description">
330			<p>
331			Set the maximum number of retrieval. `max’ specifies the maximum
332			number of retrieval. By default, the number of retrieval is not limited.
333			</p>
334			</div>
335			</div>
336
337			<div id="method-M000036" class="method-detail">
338			<a name="M000036"></a>
339
340			<div class="method-heading">
341			<a href="Condition.src/M000036.html" target="Code" class="method-signature"
342			onclick="popupCode('Condition.src/M000036.html');return false;">
343			<span class="method-name">set_options</span><span class="method-args">(options)</span>
344			</a>
345			</div>
346
347			<div class="method-description">
348			<p>
349			Set options of retrieval. `options’ specifies options:
350			`Condition::ESTCONDSURE’ specifies that it checks every N-gram key,
351			`Condition::ESTCONDUSU’, which is the default, specifies that it
352			checks N-gram keys with skipping one key, `Condition::ESTCONDFAST’
353			skips two keys, `Condition::ESTCONDAGIT’ skips three keys,
354			`Condition::ESTCONDNOIDF’ specifies not to perform TF-IDF tuning,
355			`Condition::ESTCONDSIMPLE’ specifies to use simplified phrase. Each
356			option can be specified at the same time by bitwise or. If keys are
357			skipped, though search speed is improved, the relevance ratio grows less.
358			</p>
359			</div>
360			</div>
361
362			<div id="method-M000034" class="method-detail">
363			<a name="M000034"></a>
364
365			<div class="method-heading">
366			<a href="Condition.src/M000034.html" target="Code" class="method-signature"
367			onclick="popupCode('Condition.src/M000034.html');return false;">
368			<span class="method-name">set_order</span><span class="method-args">(expr)</span>
369			</a>
370			</div>
371
372			<div class="method-description">
373			<p>
374			Set the order of a condition object. `expr’ specifies an expression
375			for the order. By default, the order is by score descending.
376			</p>
377			</div>
378			</div>
379
380			<div id="method-M000032" class="method-detail">
381			<a name="M000032"></a>
382
383			<div class="method-heading">
384			<a href="Condition.src/M000032.html" target="Code" class="method-signature"
385			onclick="popupCode('Condition.src/M000032.html');return false;">
386			<span class="method-name">set_phrase</span><span class="method-args">(phrase)</span>
387			</a>
388			</div>
389
390			<div class="method-description">
391			<p>
392			Set the search phrase. `phrase’ specifies a search phrase.
393			</p>
394			</div>
395			</div>
396
397
398			</div>
399
400
401			</div>
402
403
404			<div id="validator-badges">
405			<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
406			</div>
407
408			</body>
409			</html>