/usr/share/doc/libjosql-java/api/org/josql/expressions/BindVariable.html is in libjosql-java-doc 2.2-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_22) on Thu Jun 30 09:42:01 UTC 2011 -->
<TITLE>
BindVariable (JoSQL 2.2 - SQL for Java Objects)
</TITLE>
<META NAME="date" CONTENT="2011-06-30">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../javadocsStyle.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="BindVariable (JoSQL 2.2 - SQL for Java Objects)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/BindVariable.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../org/josql/expressions/BinaryExpression.html" title="class in org.josql.expressions"><B>PREV CLASS</B></A>
<A HREF="../../../org/josql/expressions/BooleanExpression.html" title="class in org.josql.expressions"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?org/josql/expressions/BindVariable.html" target="_top"><B>FRAMES</B></A>
<A HREF="BindVariable.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.josql.expressions</FONT>
<BR>
Class BindVariable</H2>
<PRE>
<A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
<IMG SRC="../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../org/josql/expressions/Expression.html" title="class in org.josql.expressions">org.josql.expressions.Expression</A>
<IMG SRC="../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../org/josql/expressions/ValueExpression.html" title="class in org.josql.expressions">org.josql.expressions.ValueExpression</A>
<IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.josql.expressions.BindVariable</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>BindVariable</B><DT>extends <A HREF="../../../org/josql/expressions/ValueExpression.html" title="class in org.josql.expressions">ValueExpression</A></DL>
</PRE>
<P>
This class represents a "bind variable" used within a SQL statement.
A bind variable can be either:
<ul>
<li>Named - a named bind variable is prefixed with ":", the value of the
variable is set in the <A HREF="../../../org/josql/Query.html" title="class in org.josql"><CODE>Query</CODE></A> object via: <A HREF="../../../org/josql/Query.html#setVariable(java.lang.String, java.lang.Object)"><CODE>Query.setVariable(String,Object)</CODE></A>.
The parser used (javacc generated) is a little picky about "reserved keywords" and as
such you cannot use the following as the names of bind variables: select, from, limit,
execute, on, all, results, where, having, order, by, group. If you <b>must</b> use one of
reserved names then suffix it with "$", i.e. "execute$", "limit$" and so on.</li>
<li>Anonymous - an anonymous bind variable is represented as "?". The value of the
variable is set in the <A HREF="../../../org/josql/Query.html" title="class in org.josql"><CODE>Query</CODE></A> object via: <A HREF="../../../org/josql/Query.html#setVariable(int, java.lang.Object)"><CODE>Query.setVariable(int,Object)</CODE></A>.
Anonymous variables are assigned an internal integer index starting at 1 and they increase
by 1.</li>
<li>Special - there are 3 types of "special" bind variable:
<ul>
<li><b>:_currobj</b> - Indicates the current object within the execution scope.</li>
<li><b>:_allobjs</b> - Indicates the current set of objects within the execution scope.</li>
<li><b>:_query</b> - Indicates the Query object.</li>
<li><b>:_grpby</b> - Indicates the Group By object. If there are more than 1 group by
objects then :_grpby1 ... :_grpby2 ... :_grpbyX can be used to identify which
group by object you mean. Remember that the group by object only has meaning
if there is a group by statement.</li>
<li><b>:_grpbys</b> - Indicates the set of group bys, this will be a list of lists, one
list for each group by key, and each group by column will be in that list.
<li><b>:_groupby</b> - A synonym for <b>:_grpby</b>.</li>
<li><b>:_groupbys</b> - A synonym for <b>:_grpbys</b>.</li>
</ul>
<p>
Special bind variables are mainly used in function calls however they can also be used
just about anywhere.
</li>
</ul>
<h3>Examples</h3>
<pre>
SELECT :_query,
:_allobjs,
:_currobj
FROM java.lang.Object
SELECT name
FROM java.io.File
WHERE length(:_currobj, name) > :length
AND length > avg(:_query,:_allobjs,length)
AND path LIKE '%' + ?
</pre>
<h3>Accessors</h3>
<p>
It is also possible for bind variables (including the special variables) to have accessors.
For example:
<pre>
SELECT :_query.variables
FROM java.lang.Object
</pre>
<p>
Would cause all the bind variables in the query to be returned.
Also, if the ? in the next query is an instance of <code>java.lang.String</code>.
<pre>
SELECT ?.length
FROM java.lang.Object
</pre>
<P>
<P>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/josql/expressions/BindVariable.html#SPECIAL_NAME_PREFIX">SPECIAL_NAME_PREFIX</A></B></CODE>
<BR>
</TD>
</TR>
</TABLE>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../org/josql/expressions/BindVariable.html#BindVariable()">BindVariable</A></B>()</CODE>
<BR>
</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/josql/expressions/BindVariable.html#equals(java.lang.Object)">equals</A></B>(<A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> o)</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/josql/expressions/BindVariable.html#evaluate(java.lang.Object, org.josql.Query)">evaluate</A></B>(<A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> o,
<A HREF="../../../org/josql/Query.html" title="class in org.josql">Query</A> q)</CODE>
<BR>
Evaluates the value of this bind variable.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/josql/expressions/BindVariable.html#getAccessor()">getAccessor</A></B>()</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/josql/expressions/BindVariable.html#getExpectedReturnType(org.josql.Query)">getExpectedReturnType</A></B>(<A HREF="../../../org/josql/Query.html" title="class in org.josql">Query</A> q)</CODE>
<BR>
Get the expected return type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/josql/expressions/BindVariable.html#getName()">getName</A></B>()</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/josql/expressions/BindVariable.html#getValue(java.lang.Object, org.josql.Query)">getValue</A></B>(<A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> o,
<A HREF="../../../org/josql/Query.html" title="class in org.josql">Query</A> q)</CODE>
<BR>
Gets the value of this bind variable.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/josql/expressions/BindVariable.html#hasFixedResult(org.josql.Query)">hasFixedResult</A></B>(<A HREF="../../../org/josql/Query.html" title="class in org.josql">Query</A> q)</CODE>
<BR>
Will always return false since a bind variable cannot be fixed.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/josql/expressions/BindVariable.html#init(org.josql.Query)">init</A></B>(<A HREF="../../../org/josql/Query.html" title="class in org.josql">Query</A> q)</CODE>
<BR>
Initialises this bind variable.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/josql/expressions/BindVariable.html#isAnonymous()">isAnonymous</A></B>()</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/josql/expressions/BindVariable.html#isTrue(java.lang.Object, org.josql.Query)">isTrue</A></B>(<A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> o,
<A HREF="../../../org/josql/Query.html" title="class in org.josql">Query</A> q)</CODE>
<BR>
Returns whether the value of this bind variable represents a <code>true</code>
value.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/josql/expressions/BindVariable.html#setAccessor(java.lang.String)">setAccessor</A></B>(<A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> a)</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/josql/expressions/BindVariable.html#setAnonymous(boolean)">setAnonymous</A></B>(boolean v)</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/josql/expressions/BindVariable.html#setName(java.lang.String)">setName</A></B>(<A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/josql/expressions/BindVariable.html#toString()">toString</A></B>()</CODE>
<BR>
Returns a string version of this bind variable.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_org.josql.expressions.Expression"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class org.josql.expressions.<A HREF="../../../org/josql/expressions/Expression.html" title="class in org.josql.expressions">Expression</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../org/josql/expressions/Expression.html#isBracketed()">isBracketed</A>, <A HREF="../../../org/josql/expressions/Expression.html#setBracketed(boolean)">setBracketed</A></CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="SPECIAL_NAME_PREFIX"><!-- --></A><H3>
SPECIAL_NAME_PREFIX</H3>
<PRE>
public static final <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>SPECIAL_NAME_PREFIX</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.josql.expressions.BindVariable.SPECIAL_NAME_PREFIX">Constant Field Values</A></DL>
</DL>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="BindVariable()"><!-- --></A><H3>
BindVariable</H3>
<PRE>
public <B>BindVariable</B>()</PRE>
<DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
equals</H3>
<PRE>
public boolean <B>equals</B>(<A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> o)</PRE>
<DL>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A></CODE> in class <CODE><A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getAccessor()"><!-- --></A><H3>
getAccessor</H3>
<PRE>
public <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getAccessor</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setAccessor(java.lang.String)"><!-- --></A><H3>
setAccessor</H3>
<PRE>
public void <B>setAccessor</B>(<A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> a)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getExpectedReturnType(org.josql.Query)"><!-- --></A><H3>
getExpectedReturnType</H3>
<PRE>
public <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A> <B>getExpectedReturnType</B>(<A HREF="../../../org/josql/Query.html" title="class in org.josql">Query</A> q)
throws <A HREF="../../../org/josql/QueryParseException.html" title="class in org.josql">QueryParseException</A></PRE>
<DL>
<DD>Get the expected return type.
The exact class returned here is dependent (obviously) on what the bind variable
represents. Wherever possible it attempts to get the most specific class for the
variable. It is generally better to set the variables prior to executing the:
<A HREF="../../../org/josql/Query.html#parse(java.lang.String)"><CODE>Query.parse(String)</CODE></A> method to ensure that the correct class is returned here.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/josql/expressions/Expression.html#getExpectedReturnType(org.josql.Query)">getExpectedReturnType</A></CODE> in class <CODE><A HREF="../../../org/josql/expressions/Expression.html" title="class in org.josql.expressions">Expression</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>q</CODE> - The Query object.
<DT><B>Returns:</B><DD>The return type class or <code>java.lang.Object.class</code> if the class
cannot be determined.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/josql/QueryParseException.html" title="class in org.josql">QueryParseException</A></CODE> - If the type cannot be determined.</DL>
</DD>
</DL>
<HR>
<A NAME="init(org.josql.Query)"><!-- --></A><H3>
init</H3>
<PRE>
public void <B>init</B>(<A HREF="../../../org/josql/Query.html" title="class in org.josql">Query</A> q)
throws <A HREF="../../../org/josql/QueryParseException.html" title="class in org.josql">QueryParseException</A></PRE>
<DL>
<DD>Initialises this bind variable.
If the bind variable is "anonymous" then a name is gained for it from the
Query object. If there is a value then it is gained from the Query object and
cached. Also, if there is an accessor defined then it is inited where possible.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/josql/expressions/Expression.html#init(org.josql.Query)">init</A></CODE> in class <CODE><A HREF="../../../org/josql/expressions/Expression.html" title="class in org.josql.expressions">Expression</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>q</CODE> - The Query object.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/josql/QueryParseException.html" title="class in org.josql">QueryParseException</A></CODE> - If the bind variable cannot be inited.</DL>
</DD>
</DL>
<HR>
<A NAME="getName()"><!-- --></A><H3>
getName</H3>
<PRE>
public <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getName</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="isAnonymous()"><!-- --></A><H3>
isAnonymous</H3>
<PRE>
public boolean <B>isAnonymous</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setAnonymous(boolean)"><!-- --></A><H3>
setAnonymous</H3>
<PRE>
public void <B>setAnonymous</B>(boolean v)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setName(java.lang.String)"><!-- --></A><H3>
setName</H3>
<PRE>
public void <B>setName</B>(<A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getValue(java.lang.Object, org.josql.Query)"><!-- --></A><H3>
getValue</H3>
<PRE>
public <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> <B>getValue</B>(<A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> o,
<A HREF="../../../org/josql/Query.html" title="class in org.josql">Query</A> q)
throws <A HREF="../../../org/josql/QueryExecutionException.html" title="class in org.josql">QueryExecutionException</A></PRE>
<DL>
<DD>Gets the value of this bind variable.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../org/josql/expressions/ValueExpression.html#getValue(java.lang.Object, org.josql.Query)">getValue</A></CODE> in class <CODE><A HREF="../../../org/josql/expressions/ValueExpression.html" title="class in org.josql.expressions">ValueExpression</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>o</CODE> - The current object. Note that this variable isn't used in this method.<DD><CODE>q</CODE> - The Query object.
<DT><B>Returns:</B><DD>The value.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/josql/QueryExecutionException.html" title="class in org.josql">QueryExecutionException</A></CODE> - If something goes wrong during the accessing
of the value.</DL>
</DD>
</DL>
<HR>
<A NAME="isTrue(java.lang.Object, org.josql.Query)"><!-- --></A><H3>
isTrue</H3>
<PRE>
public boolean <B>isTrue</B>(<A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> o,
<A HREF="../../../org/josql/Query.html" title="class in org.josql">Query</A> q)
throws <A HREF="../../../org/josql/QueryExecutionException.html" title="class in org.josql">QueryExecutionException</A></PRE>
<DL>
<DD>Returns whether the value of this bind variable represents a <code>true</code>
value. See: <A HREF="../../../org/josql/expressions/ArithmeticExpression.html#isTrue(java.lang.Object, org.josql.Query)"><CODE>ArithmeticExpression.isTrue(Object,Query)</CODE></A> for details of how
the return value is determined.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/josql/expressions/Expression.html#isTrue(java.lang.Object, org.josql.Query)">isTrue</A></CODE> in class <CODE><A HREF="../../../org/josql/expressions/Expression.html" title="class in org.josql.expressions">Expression</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>o</CODE> - The current object. Not used in this method.<DD><CODE>q</CODE> - The Query object.
<DT><B>Returns:</B><DD><code>true</code> if the bind variable evaluates to <code>true</code>.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/josql/QueryExecutionException.html" title="class in org.josql">QueryExecutionException</A></CODE> - If a problem occurs during evaluation.</DL>
</DD>
</DL>
<HR>
<A NAME="evaluate(java.lang.Object, org.josql.Query)"><!-- --></A><H3>
evaluate</H3>
<PRE>
public <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> <B>evaluate</B>(<A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> o,
<A HREF="../../../org/josql/Query.html" title="class in org.josql">Query</A> q)
throws <A HREF="../../../org/josql/QueryExecutionException.html" title="class in org.josql">QueryExecutionException</A></PRE>
<DL>
<DD>Evaluates the value of this bind variable. This is just a thin-wrapper around:
<A HREF="../../../org/josql/expressions/BindVariable.html#getValue(java.lang.Object, org.josql.Query)"><CODE>getValue(Object,Query)</CODE></A>.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/josql/expressions/ValueExpression.html#evaluate(java.lang.Object, org.josql.Query)">evaluate</A></CODE> in class <CODE><A HREF="../../../org/josql/expressions/ValueExpression.html" title="class in org.josql.expressions">ValueExpression</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>o</CODE> - The current object, not used in this method.<DD><CODE>q</CODE> - The Query object.
<DT><B>Returns:</B><DD>The value of this bind variable.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/josql/QueryExecutionException.html" title="class in org.josql">QueryExecutionException</A></CODE> - If there is a problem getting the value.</DL>
</DD>
</DL>
<HR>
<A NAME="toString()"><!-- --></A><H3>
toString</H3>
<PRE>
public <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>toString</B>()</PRE>
<DL>
<DD>Returns a string version of this bind variable.
Returns in the form: ? | ":" [ "_" ] Name
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/josql/expressions/Expression.html#toString()">toString</A></CODE> in class <CODE><A HREF="../../../org/josql/expressions/Expression.html" title="class in org.josql.expressions">Expression</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>A string version of the bind variable.</DL>
</DD>
</DL>
<HR>
<A NAME="hasFixedResult(org.josql.Query)"><!-- --></A><H3>
hasFixedResult</H3>
<PRE>
public boolean <B>hasFixedResult</B>(<A HREF="../../../org/josql/Query.html" title="class in org.josql">Query</A> q)</PRE>
<DL>
<DD>Will always return false since a bind variable cannot be fixed.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/josql/expressions/Expression.html#hasFixedResult(org.josql.Query)">hasFixedResult</A></CODE> in class <CODE><A HREF="../../../org/josql/expressions/Expression.html" title="class in org.josql.expressions">Expression</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>q</CODE> - The Query object.
<DT><B>Returns:</B><DD><code>false</code> always.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/BindVariable.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../org/josql/expressions/BinaryExpression.html" title="class in org.josql.expressions"><B>PREV CLASS</B></A>
<A HREF="../../../org/josql/expressions/BooleanExpression.html" title="class in org.josql.expressions"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?org/josql/expressions/BindVariable.html" target="_top"><B>FRAMES</B></A>
<A HREF="BindVariable.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<center><dd><a href='http://sourceforge.net'><img border='0' height='31' width='88' title='SourceForge' src='http://sourceforge.net/sflogo.php?group_id=josql&type=1' />  </a>Copyright © 2010 Gary Bentley. All Rights Reserved.</dd></center>
</BODY>
</HTML>
|