xXx

Hexid M1n1 5h3ll MobiLe

usr/local/java/db/javadoc/jdbc4/org/apache/derby/vti/_[ Not.Writable ]

File://usr/local/java/db/javadoc/jdbc4/org/apache/derby/vti/RestrictedVTI.html

<!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_13) on Tue Sep 21 16:20:50 PDT 2010 -->
<TITLE>
RestrictedVTI (Apache Derby 10.6 API Documentation)
</TITLE>

<META NAME="date" CONTENT="2010-09-21">

<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">

<SCRIPT type="text/javascript">
function windowTitle()
{
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="RestrictedVTI (Apache Derby 10.6 API Documentation)";
    }
}
</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>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Apache Derby 10.6</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
&nbsp;<A HREF="../../../../org/apache/derby/vti/Restriction.html" title="class in org.apache.derby.vti"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?org/apache/derby/vti/RestrictedVTI.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="RestrictedVTI.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<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.apache.derby.vti</FONT>
<BR>
Interface RestrictedVTI</H2>
<HR>
<DL>
<DT><PRE>public interface <B>RestrictedVTI</B></DL>
</PRE>

<P>
<p>
 Interface for Table Functions which can be told which columns need to be fetched plus simple bounds on those columns.
 </p>

 <p>
 This interface can be implemented by the ResultSet returned by the public
 static method which is bound to the Table Function. If that ResultSet
 implements this interface, then the initScan() method of this interface will be
 called before the scan of the ResultSet starts, that is, before calling any
 ResultSet method.
 </p>

 <p>
 ResultSets which implement this interface can perform more efficiently
 because they don't have to fetch all columns and rows. This can mean
 performance boosts for queries which only need a subset of the Table
 Function's columns and for queries which compare those columns to constant
 expressions using the <, <=, =, >, and >= operators. This can also mean
 performance boosts for LIKE and BETWEEN operations on Table Function
 columns. For more information, see the commentary on
 <a href="https://issues.apache.org/jira/browse/DERBY-4357">DERBY-4357</a>.
 </p>
<P>

<P>
<HR>

<P>

<!-- ========== 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>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/derby/vti/RestrictedVTI.html#initScan(java.lang.String[], org.apache.derby.vti.Restriction)">initScan</A></B>(java.lang.String[]&nbsp;columnNames,
         <A HREF="../../../../org/apache/derby/vti/Restriction.html" title="class in org.apache.derby.vti">Restriction</A>&nbsp;restriction)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 Initialize a scan of a ResultSet.</TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ============ 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="initScan(java.lang.String[], org.apache.derby.vti.Restriction)"><!-- --></A><H3>
initScan</H3>
<PRE>
void <B>initScan</B>(java.lang.String[]&nbsp;columnNames,
              <A HREF="../../../../org/apache/derby/vti/Restriction.html" title="class in org.apache.derby.vti">Restriction</A>&nbsp;restriction)
              throws java.sql.SQLException</PRE>
<DL>
<DD><p>
 Initialize a scan of a ResultSet. This method is called once before the scan begins. It
 is called before any
 ResultSet method is called. This method performs two tasks:
 </p>

 <li><b>Column names</b> - Tells the ResultSet which columns need to be fetched.</li>
 <li><b>Limits</b> - Gives the ResultSet simple bounds to apply in order
 to limit which rows are returned. Note that the ResultSet does not have
 to enforce all of these bounds. Derby will redundantly enforce these
 limits on all rows returned by the ResultSet. That is, filtering not
 performed inside the ResultSet will still happen outside the ResultSet.</li>

 <p>
 The <i>columnNames</i> argument is an array of columns which need to be fetched.  This
 is an array of the column names declared in the Table Function's
 CREATE FUNCTION statement. Column names which were double-quoted
 in the CREATE FUNCTION statement appear case-sensitive in this
 array. Column names which were not double-quoted appear
 upper-cased. Derby asks the Table Function to fetch all columns mentioned
 in the query. This includes columns mentioned in the SELECT list as well
 as columns mentioned in the WHERE clause. Note that a column could be
 mentioned in the WHERE clause in a complex expression which could not be
 passed to the Table Function via the <i>restriction</i> argument.
 </p>

 <p>
 The array has one slot for each column declared in the CREATE FUNCTION
 statement. Slot 0 corresponds to the first column declared in the CREATE
 FUNCTION statement and so on. If a column does not need to be
 fetched, then the corresponding slot is null. If a column needs
 to be fetched, then the corresponding slot holds the column's
 name.
 </p>

 <p>
 Note that even though the array may have gaps, it is expected that
 columns in the ResultSet will occur at the positions declared in the
 CREATE FUNCTION statement. Consider the following declaration:
 </p>

 <blockquote><pre>
  create function foreignEmployeeTable()
  returns table
  (
      id        int,
      birthDay  date,
      firstName varchar( 100 ),
      lastName  varchar( 100 )
  )
 ...
 </pre></blockquote>

 <p>
 and the following query:
 </p>

 <blockquote><pre>
 select lastName from table( foreignEmployeeTable() ) s
 </pre></blockquote>

 <p>
 In this example, the array passed to this method will have
 4 slots. Slots 0, 1, and 2 will be null and slot 3 will hold
 the String "LASTNAME". Last names will be retrieved from the
 ResultSet by calls to getString( 4 )--remember that JDBC column
 ids are 1-based.
 </p>

 <p>
 The <i>restriction</i> argument is a simple expression which should be evaluated inside the Table
 Function in order to eliminate rows. The expression is a binary tree built out of ANDs,
 ORs, and column qualifiers. The column qualifiers are simple comparisons
 between constant values and columns in the Table Function. The Table
 Function only returns rows which satisfy the expression. The
 <i>restriction</i> is redundantly enforced by Derby on the rows returned
 by the ResultSet--this means that <i>restriction</i> gives the Table
 Function a hint about how to optimize its performance but the Table
 Function is not required to enforce the entire <i>restriction</i>.
 </p>
<P>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE>java.sql.SQLException</CODE></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>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Built on Tue 2010-09-21 16:20:41-0700, from revision 999685</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
&nbsp;<A HREF="../../../../org/apache/derby/vti/Restriction.html" title="class in org.apache.derby.vti"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?org/apache/derby/vti/RestrictedVTI.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="RestrictedVTI.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>
Apache Derby 10.6 API Documentation  -  <i>Copyright &copy; 2004,2008 The Apache Software Foundation. All Rights Reserved.</i>
</BODY>
</HTML>

Your Access Expired	Date. in : 18-08-2025
Regist : 09-12-2024	Expired : 01-12-2027