You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@manifoldcf.apache.org by kw...@apache.org on 2012/06/02 22:37:11 UTC
svn commit: r1345569 [12/36] - in /incubator/lcf/site/publish: ./
release/trunk/ release/trunk/api/activedirectory/
release/trunk/api/activedirectory/org/apache/manifoldcf/authorities/authorities/activedirectory/
release/trunk/api/alfresco/ release/tru...
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/DBInterfaceMySQL.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/DBInterfaceMySQL.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/DBInterfaceMySQL.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/DBInterfaceMySQL.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:23 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:07:57 EDT 2012 -->
<TITLE>
DBInterfaceMySQL
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
@@ -388,7 +388,7 @@ java.lang.Object
<TD><CODE><B><A HREF="../../../../../org/apache/manifoldcf/core/database/DBInterfaceMySQL.html#getMaxInClause()">getMaxInClause</A></B>()</CODE>
<BR>
- Obtain the maximum number of individual items that should be
+ Obtain the maximum number of individual items that should be
present in an IN clause.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -397,7 +397,7 @@ java.lang.Object
<TD><CODE><B><A HREF="../../../../../org/apache/manifoldcf/core/database/DBInterfaceMySQL.html#getMaxOrClause()">getMaxOrClause</A></B>()</CODE>
<BR>
- Obtain the maximum number of individual clauses that should be
+ Obtain the maximum number of individual clauses that should be
present in a sequence of OR clauses.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -740,7 +740,7 @@ reinterpretException</H3>
<PRE>
protected <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A> <B>reinterpretException</B>(<A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A> theException)</PRE>
<DL>
-<DD>Reinterpret an exception tossed by the database layer. We need to disambiguate the various kinds of exception that
+<DD>Reinterpret an exception tossed by the database layer. We need to disambiguate the various kinds of exception that
should be thrown.
<P>
<DD><DL>
@@ -776,7 +776,7 @@ openDatabase</H3>
public void <B>openDatabase</B>()
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Initialize. This method is called once per JVM instance, in order to set up
+<DD>Initialize. This method is called once per JVM instance, in order to set up
database communication.
<P>
<DD><DL>
@@ -796,7 +796,7 @@ closeDatabase</H3>
public void <B>closeDatabase</B>()
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Uninitialize. This method is called during JVM shutdown, in order to close
+<DD>Uninitialize. This method is called during JVM shutdown, in order to close
all database communication.
<P>
<DD><DL>
@@ -841,7 +841,7 @@ public void <B>performInsert</B>(java.la
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/IDBInterface.html#performInsert(java.lang.String, java.util.Map, org.apache.manifoldcf.core.interfaces.StringSet)">performInsert</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/IDBInterface.html" title="interface in org.apache.manifoldcf.core.interfaces">IDBInterface</A></CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>tableName</CODE> - is the name of the table.<DD><CODE>invalidateKeys</CODE> - are the cache keys that should be
+<DT><B>Parameters:</B><DD><CODE>tableName</CODE> - is the name of the table.<DD><CODE>invalidateKeys</CODE> - are the cache keys that should be
invalidated.<DD><CODE>parameterMap</CODE> - is the map of column name/values to write.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></CODE></DL>
@@ -908,8 +908,8 @@ public void <B>performCreate</B>(java.la
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/IDBInterface.html#performCreate(java.lang.String, java.util.Map, org.apache.manifoldcf.core.interfaces.StringSet)">performCreate</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/IDBInterface.html" title="interface in org.apache.manifoldcf.core.interfaces">IDBInterface</A></CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>tableName</CODE> - is the name of the table to create.<DD><CODE>columnMap</CODE> - is the map describing the columns and types. NOTE that these are abstract
- types, which will be mapped to the proper types for the actual database inside this
+<DT><B>Parameters:</B><DD><CODE>tableName</CODE> - is the name of the table to create.<DD><CODE>columnMap</CODE> - is the map describing the columns and types. NOTE that these are abstract
+ types, which will be mapped to the proper types for the actual database inside this
layer.<DD><CODE>invalidateKeys</CODE> - are the cache keys that should be invalidated, if any.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></CODE></DL>
@@ -967,9 +967,9 @@ public void <B>performAlter</B>(java.lan
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/IDBInterface.html#performAlter(java.lang.String, java.util.Map, java.util.Map, java.util.List, org.apache.manifoldcf.core.interfaces.StringSet)">performAlter</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/IDBInterface.html" title="interface in org.apache.manifoldcf.core.interfaces">IDBInterface</A></CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>tableName</CODE> - is the name of the table to alter.<DD><CODE>columnMap</CODE> - is the map describing the columns and types to add. These
- are in the same form as for performCreate.<DD><CODE>columnModifyMap</CODE> - is the map describing the columns to be changed. The key is the
- existing column name, and the value is the new type of the column. Data will be copied from
+<DT><B>Parameters:</B><DD><CODE>tableName</CODE> - is the name of the table to alter.<DD><CODE>columnMap</CODE> - is the map describing the columns and types to add. These
+ are in the same form as for performCreate.<DD><CODE>columnModifyMap</CODE> - is the map describing the columns to be changed. The key is the
+ existing column name, and the value is the new type of the column. Data will be copied from
the old column to the new.<DD><CODE>columnDeleteList</CODE> - is the list of column names to delete.<DD><CODE>invalidateKeys</CODE> - are the cache keys that should be invalidated, if any.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></CODE></DL>
@@ -991,7 +991,7 @@ public void <B>addTableIndex</B>(java.la
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/IDBInterface.html#addTableIndex(java.lang.String, boolean, java.util.List)">addTableIndex</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/IDBInterface.html" title="interface in org.apache.manifoldcf.core.interfaces">IDBInterface</A></CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>tableName</CODE> - is the name of the table to add the index for.<DD><CODE>unique</CODE> - is a boolean that if true describes a unique index.<DD><CODE>columnList</CODE> - is the list of columns that need to be included
+<DT><B>Parameters:</B><DD><CODE>tableName</CODE> - is the name of the table to add the index for.<DD><CODE>unique</CODE> - is a boolean that if true describes a unique index.<DD><CODE>columnList</CODE> - is the list of columns that need to be included
in the index, in order.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></CODE></DL>
@@ -1258,7 +1258,7 @@ public <A HREF="../../../../../org/apach
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/IDBInterface.html#performQuery(java.lang.String, java.util.List, org.apache.manifoldcf.core.interfaces.StringSet, java.lang.String)">performQuery</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/IDBInterface.html" title="interface in org.apache.manifoldcf.core.interfaces">IDBInterface</A></CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>query</CODE> - is the query string.<DD><CODE>params</CODE> - are the parameterized values, if needed.<DD><CODE>cacheKeys</CODE> - are the cache keys, if needed (null if no cache desired).<DD><CODE>queryClass</CODE> - is the LRU class name against which this query would be cached,
+<DT><B>Parameters:</B><DD><CODE>query</CODE> - is the query string.<DD><CODE>params</CODE> - are the parameterized values, if needed.<DD><CODE>cacheKeys</CODE> - are the cache keys, if needed (null if no cache desired).<DD><CODE>queryClass</CODE> - is the LRU class name against which this query would be cached,
or null if no LRU behavior desired.
<DT><B>Returns:</B><DD>a resultset.
<DT><B>Throws:</B>
@@ -1284,7 +1284,7 @@ public <A HREF="../../../../../org/apach
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/IDBInterface.html#performQuery(java.lang.String, java.util.List, org.apache.manifoldcf.core.interfaces.StringSet, java.lang.String, int, org.apache.manifoldcf.core.interfaces.ILimitChecker)">performQuery</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/IDBInterface.html" title="interface in org.apache.manifoldcf.core.interfaces">IDBInterface</A></CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>query</CODE> - is the query string.<DD><CODE>params</CODE> - are the parameterized values, if needed.<DD><CODE>cacheKeys</CODE> - are the cache keys, if needed (null if no cache desired).<DD><CODE>queryClass</CODE> - is the LRU class name against which this query would be cached,
+<DT><B>Parameters:</B><DD><CODE>query</CODE> - is the query string.<DD><CODE>params</CODE> - are the parameterized values, if needed.<DD><CODE>cacheKeys</CODE> - are the cache keys, if needed (null if no cache desired).<DD><CODE>queryClass</CODE> - is the LRU class name against which this query would be cached,
or null if no LRU behavior desired.<DD><CODE>maxResults</CODE> - is the maximum number of results returned (-1 for all).<DD><CODE>returnLimit</CODE> - is a description of how to limit the return result, or null if no limit.
<DT><B>Returns:</B><DD>a resultset.
<DT><B>Throws:</B>
@@ -1311,7 +1311,7 @@ public <A HREF="../../../../../org/apach
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/IDBInterface.html#performQuery(java.lang.String, java.util.List, org.apache.manifoldcf.core.interfaces.StringSet, java.lang.String, int, org.apache.manifoldcf.core.interfaces.ResultSpecification, org.apache.manifoldcf.core.interfaces.ILimitChecker)">performQuery</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/IDBInterface.html" title="interface in org.apache.manifoldcf.core.interfaces">IDBInterface</A></CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>query</CODE> - is the query string.<DD><CODE>params</CODE> - are the parameterized values, if needed.<DD><CODE>cacheKeys</CODE> - are the cache keys, if needed (null if no cache desired).<DD><CODE>queryClass</CODE> - is the LRU class name against which this query would be cached,
+<DT><B>Parameters:</B><DD><CODE>query</CODE> - is the query string.<DD><CODE>params</CODE> - are the parameterized values, if needed.<DD><CODE>cacheKeys</CODE> - are the cache keys, if needed (null if no cache desired).<DD><CODE>queryClass</CODE> - is the LRU class name against which this query would be cached,
or null if no LRU behavior desired.<DD><CODE>maxResults</CODE> - is the maximum number of results returned (-1 for all).<DD><CODE>resultSpec</CODE> - is a result specification, or null for the standard treatment.<DD><CODE>returnLimit</CODE> - is a description of how to limit the return result, or null if no limit.
<DT><B>Returns:</B><DD>a resultset.
<DT><B>Throws:</B>
@@ -1325,8 +1325,8 @@ constructDoubleCastClause</H3>
<PRE>
public java.lang.String <B>constructDoubleCastClause</B>(java.lang.String value)</PRE>
<DL>
-<DD>Construct a cast to a double value.
- On most databases this cast needs to be explicit, but on some it is implicit (and cannot be in fact
+<DD>Construct a cast to a double value.
+ On most databases this cast needs to be explicit, but on some it is implicit (and cannot be in fact
specified).
<P>
<DD><DL>
@@ -1344,8 +1344,8 @@ constructCountClause</H3>
<PRE>
public java.lang.String <B>constructCountClause</B>(java.lang.String column)</PRE>
<DL>
-<DD>Construct a count clause.
- On most databases this will be COUNT(col), but on some the count needs to be cast to a BIGINT, so
+<DD>Construct a count clause.
+ On most databases this will be COUNT(col), but on some the count needs to be cast to a BIGINT, so
CAST(COUNT(col) AS BIGINT) will be emitted instead.
<P>
<DD><DL>
@@ -1365,7 +1365,7 @@ public java.lang.String <B>constructRege
java.lang.String regularExpression,
boolean caseInsensitive)</PRE>
<DL>
-<DD>Construct a regular-expression match clause.
+<DD>Construct a regular-expression match clause.
This method builds both the text part of a regular-expression match.
<P>
<DD><DL>
@@ -1385,8 +1385,8 @@ public java.lang.String <B>constructSubs
java.lang.String regularExpression,
boolean caseInsensitive)</PRE>
<DL>
-<DD>Construct a regular-expression substring clause.
- This method builds an expression that extracts a specified string section from a field, based on
+<DD>Construct a regular-expression substring clause.
+ This method builds an expression that extracts a specified string section from a field, based on
a regular expression.
<P>
<DD><DL>
@@ -1406,7 +1406,7 @@ public java.lang.String <B>constructOffs
int limit,
boolean afterOrderBy)</PRE>
<DL>
-<DD>Construct an offset/limit clause.
+<DD>Construct an offset/limit clause.
This method constructs an offset/limit clause in the proper manner for the database in question.
<P>
<DD><DL>
@@ -1430,16 +1430,16 @@ public java.lang.String <B>constructDist
boolean[] orderFieldsAscending,
java.util.Map<java.lang.String,java.lang.String> otherFields)</PRE>
<DL>
-<DD>Construct a 'distinct on (x)' filter.
- This filter wraps a query and returns a new query whose results are similar to POSTGRESQL's DISTINCT-ON feature.
- Specifically, for each combination of the specified distinct fields in the result, only the first such row is included in the final
+<DD>Construct a 'distinct on (x)' filter.
+ This filter wraps a query and returns a new query whose results are similar to POSTGRESQL's DISTINCT-ON feature.
+ Specifically, for each combination of the specified distinct fields in the result, only the first such row is included in the final
result.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/IDBInterface.html#constructDistinctOnClause(java.util.List, java.lang.String, java.util.List, java.lang.String[], java.lang.String[], boolean[], java.util.Map)">constructDistinctOnClause</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/IDBInterface.html" title="interface in org.apache.manifoldcf.core.interfaces">IDBInterface</A></CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>outputParameters</CODE> - is a blank list into which to put parameters. Null may be used if the baseParameters parameter is null.<DD><CODE>baseQuery</CODE> - is the base query, which is another SELECT statement, without parens,
+<DT><B>Parameters:</B><DD><CODE>outputParameters</CODE> - is a blank list into which to put parameters. Null may be used if the baseParameters parameter is null.<DD><CODE>baseQuery</CODE> - is the base query, which is another SELECT statement, without parens,
e.g. "SELECT ..."<DD><CODE>baseParameters</CODE> - are the parameters corresponding to the baseQuery.<DD><CODE>distinctFields</CODE> - are the fields to consider to be distinct. These should all be keys in otherFields below.<DD><CODE>orderFields</CODE> - are the otherfield keys that determine the ordering.<DD><CODE>orderFieldsAscending</CODE> - are true for orderFields that are ordered as ASC, false for DESC.<DD><CODE>otherFields</CODE> - are the rest of the fields to return, keyed by the AS name, value being the base query column value, e.g. "value AS key"
<DT><B>Returns:</B><DD>a revised query that performs the necessary DISTINCT ON operation. The list outputParameters will also be appropriately filled in.</DL>
</DD>
@@ -1451,8 +1451,8 @@ getMaxInClause</H3>
<PRE>
public int <B>getMaxInClause</B>()</PRE>
<DL>
-<DD>Obtain the maximum number of individual items that should be
- present in an IN clause. Exceeding this amount will potentially cause the query performance
+<DD>Obtain the maximum number of individual items that should be
+ present in an IN clause. Exceeding this amount will potentially cause the query performance
to drop.
<P>
<DD><DL>
@@ -1470,8 +1470,8 @@ getMaxOrClause</H3>
<PRE>
public int <B>getMaxOrClause</B>()</PRE>
<DL>
-<DD>Obtain the maximum number of individual clauses that should be
- present in a sequence of OR clauses. Exceeding this amount will potentially cause the query performance
+<DD>Obtain the maximum number of individual clauses that should be
+ present in a sequence of OR clauses. Exceeding this amount will potentially cause the query performance
to drop.
<P>
<DD><DL>
@@ -1489,7 +1489,7 @@ getWindowedReportMaxRows</H3>
<PRE>
public int <B>getWindowedReportMaxRows</B>()</PRE>
<DL>
-<DD>For windowed report queries, e.g. maxActivity or maxBandwidth, obtain the maximum number of rows
+<DD>For windowed report queries, e.g. maxActivity or maxBandwidth, obtain the maximum number of rows
that can reasonably be expected to complete in an acceptable time.
<P>
<DD><DL>
@@ -1508,12 +1508,12 @@ beginTransaction</H3>
public void <B>beginTransaction</B>()
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Begin a database transaction. This method call MUST be paired with an endTransaction() call,
- or database handles will be lost. If the transaction should be rolled back, then signalRollback() should
- be called before the transaction is ended.
- It is strongly recommended that the code that uses transactions be structured so that a try block
- starts immediately after this method call. The body of the try block will contain all direct or indirect
- calls to executeQuery(). After this should be a catch for every exception type, including Error, which should call the
+<DD>Begin a database transaction. This method call MUST be paired with an endTransaction() call,
+ or database handles will be lost. If the transaction should be rolled back, then signalRollback() should
+ be called before the transaction is ended.
+ It is strongly recommended that the code that uses transactions be structured so that a try block
+ starts immediately after this method call. The body of the try block will contain all direct or indirect
+ calls to executeQuery(). After this should be a catch for every exception type, including Error, which should call the
signalRollback() method, and rethrow the exception. Then, after that a finally{} block which calls endTransaction().
<P>
<DD><DL>
@@ -1533,12 +1533,12 @@ beginTransaction</H3>
public void <B>beginTransaction</B>(int transactionType)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Begin a database transaction. This method call MUST be paired with an endTransaction() call,
- or database handles will be lost. If the transaction should be rolled back, then signalRollback() should
- be called before the transaction is ended.
- It is strongly recommended that the code that uses transactions be structured so that a try block
- starts immediately after this method call. The body of the try block will contain all direct or indirect
- calls to executeQuery(). After this should be a catch for every exception type, including Error, which should call the
+<DD>Begin a database transaction. This method call MUST be paired with an endTransaction() call,
+ or database handles will be lost. If the transaction should be rolled back, then signalRollback() should
+ be called before the transaction is ended.
+ It is strongly recommended that the code that uses transactions be structured so that a try block
+ starts immediately after this method call. The body of the try block will contain all direct or indirect
+ calls to executeQuery(). After this should be a catch for every exception type, including Error, which should call the
signalRollback() method, and rethrow the exception. Then, after that a finally{} block which calls endTransaction().
<P>
<DD><DL>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/DBInterfacePostgreSQL.TableStatistics.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/DBInterfacePostgreSQL.TableStatistics.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/DBInterfacePostgreSQL.TableStatistics.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/DBInterfacePostgreSQL.TableStatistics.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:23 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:07:57 EDT 2012 -->
<TITLE>
DBInterfacePostgreSQL.TableStatistics
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/DBInterfacePostgreSQL.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/DBInterfacePostgreSQL.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/DBInterfacePostgreSQL.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/DBInterfacePostgreSQL.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:23 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:07:57 EDT 2012 -->
<TITLE>
DBInterfacePostgreSQL
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
@@ -488,7 +488,7 @@ java.lang.Object
<TD><CODE><B><A HREF="../../../../../org/apache/manifoldcf/core/database/DBInterfacePostgreSQL.html#endTransaction()">endTransaction</A></B>()</CODE>
<BR>
- End a database transaction, either performing a commit or a rollback (depending on whether
+ End a database transaction, either performing a commit or a rollback (depending on whether
signalRollback() was called within the transaction).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -523,7 +523,7 @@ java.lang.Object
<TD><CODE><B><A HREF="../../../../../org/apache/manifoldcf/core/database/DBInterfacePostgreSQL.html#getMaxInClause()">getMaxInClause</A></B>()</CODE>
<BR>
- Obtain the maximum number of individual items that should be
+ Obtain the maximum number of individual items that should be
present in an IN clause.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -532,7 +532,7 @@ java.lang.Object
<TD><CODE><B><A HREF="../../../../../org/apache/manifoldcf/core/database/DBInterfacePostgreSQL.html#getMaxOrClause()">getMaxOrClause</A></B>()</CODE>
<BR>
- Obtain the maximum number of individual clauses that should be
+ Obtain the maximum number of individual clauses that should be
present in a sequence of OR clauses.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -1065,7 +1065,7 @@ openDatabase</H3>
public void <B>openDatabase</B>()
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Initialize. This method is called once per JVM instance, in order to set up
+<DD>Initialize. This method is called once per JVM instance, in order to set up
database communication.
<P>
<DD><DL>
@@ -1085,7 +1085,7 @@ closeDatabase</H3>
public void <B>closeDatabase</B>()
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Uninitialize. This method is called during JVM shutdown, in order to close
+<DD>Uninitialize. This method is called during JVM shutdown, in order to close
all database communication.
<P>
<DD><DL>
@@ -1130,7 +1130,7 @@ public void <B>performInsert</B>(java.la
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/IDBInterface.html#performInsert(java.lang.String, java.util.Map, org.apache.manifoldcf.core.interfaces.StringSet)">performInsert</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/IDBInterface.html" title="interface in org.apache.manifoldcf.core.interfaces">IDBInterface</A></CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>tableName</CODE> - is the name of the table.<DD><CODE>invalidateKeys</CODE> - are the cache keys that should be
+<DT><B>Parameters:</B><DD><CODE>tableName</CODE> - is the name of the table.<DD><CODE>invalidateKeys</CODE> - are the cache keys that should be
invalidated.<DD><CODE>parameterMap</CODE> - is the map of column name/values to write.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></CODE></DL>
@@ -1197,8 +1197,8 @@ public void <B>performCreate</B>(java.la
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/IDBInterface.html#performCreate(java.lang.String, java.util.Map, org.apache.manifoldcf.core.interfaces.StringSet)">performCreate</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/IDBInterface.html" title="interface in org.apache.manifoldcf.core.interfaces">IDBInterface</A></CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>tableName</CODE> - is the name of the table to create.<DD><CODE>columnMap</CODE> - is the map describing the columns and types. NOTE that these are abstract
- types, which will be mapped to the proper types for the actual database inside this
+<DT><B>Parameters:</B><DD><CODE>tableName</CODE> - is the name of the table to create.<DD><CODE>columnMap</CODE> - is the map describing the columns and types. NOTE that these are abstract
+ types, which will be mapped to the proper types for the actual database inside this
layer.<DD><CODE>invalidateKeys</CODE> - are the cache keys that should be invalidated, if any.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></CODE></DL>
@@ -1239,9 +1239,9 @@ public void <B>performAlter</B>(java.lan
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/IDBInterface.html#performAlter(java.lang.String, java.util.Map, java.util.Map, java.util.List, org.apache.manifoldcf.core.interfaces.StringSet)">performAlter</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/IDBInterface.html" title="interface in org.apache.manifoldcf.core.interfaces">IDBInterface</A></CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>tableName</CODE> - is the name of the table to alter.<DD><CODE>columnMap</CODE> - is the map describing the columns and types to add. These
- are in the same form as for performCreate.<DD><CODE>columnModifyMap</CODE> - is the map describing the columns to be changed. The key is the
- existing column name, and the value is the new type of the column. Data will be copied from
+<DT><B>Parameters:</B><DD><CODE>tableName</CODE> - is the name of the table to alter.<DD><CODE>columnMap</CODE> - is the map describing the columns and types to add. These
+ are in the same form as for performCreate.<DD><CODE>columnModifyMap</CODE> - is the map describing the columns to be changed. The key is the
+ existing column name, and the value is the new type of the column. Data will be copied from
the old column to the new.<DD><CODE>columnDeleteList</CODE> - is the list of column names to delete.<DD><CODE>invalidateKeys</CODE> - are the cache keys that should be invalidated, if any.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></CODE></DL>
@@ -1280,7 +1280,7 @@ public void <B>addTableIndex</B>(java.la
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/IDBInterface.html#addTableIndex(java.lang.String, boolean, java.util.List)">addTableIndex</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/IDBInterface.html" title="interface in org.apache.manifoldcf.core.interfaces">IDBInterface</A></CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>tableName</CODE> - is the name of the table to add the index for.<DD><CODE>unique</CODE> - is a boolean that if true describes a unique index.<DD><CODE>columnList</CODE> - is the list of columns that need to be included
+<DT><B>Parameters:</B><DD><CODE>tableName</CODE> - is the name of the table to add the index for.<DD><CODE>unique</CODE> - is a boolean that if true describes a unique index.<DD><CODE>columnList</CODE> - is the list of columns that need to be included
in the index, in order.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></CODE></DL>
@@ -1396,7 +1396,7 @@ reinterpretException</H3>
<PRE>
protected <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A> <B>reinterpretException</B>(<A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A> theException)</PRE>
<DL>
-<DD>Reinterpret an exception tossed by the database layer. We need to disambiguate the various kinds of exception that
+<DD>Reinterpret an exception tossed by the database layer. We need to disambiguate the various kinds of exception that
should be thrown.
<P>
<DD><DL>
@@ -1445,7 +1445,7 @@ public java.util.Map<java.lang.String
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>tableName</CODE> - is the name of the table.<DD><CODE>cacheKeys</CODE> - are the keys against which to cache the query, or null.<DD><CODE>queryClass</CODE> - is the name of the query class, or null.
-<DT><B>Returns:</B><DD>a map of column names and ColumnDescription objects, describing the schema, or null if the
+<DT><B>Returns:</B><DD>a map of column names and ColumnDescription objects, describing the schema, or null if the
table doesn't exist.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></CODE></DL>
@@ -1511,7 +1511,7 @@ public <A HREF="../../../../../org/apach
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/IDBInterface.html#performQuery(java.lang.String, java.util.List, org.apache.manifoldcf.core.interfaces.StringSet, java.lang.String)">performQuery</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/IDBInterface.html" title="interface in org.apache.manifoldcf.core.interfaces">IDBInterface</A></CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>query</CODE> - is the query string.<DD><CODE>params</CODE> - are the parameterized values, if needed.<DD><CODE>cacheKeys</CODE> - are the cache keys, if needed (null if no cache desired).<DD><CODE>queryClass</CODE> - is the LRU class name against which this query would be cached,
+<DT><B>Parameters:</B><DD><CODE>query</CODE> - is the query string.<DD><CODE>params</CODE> - are the parameterized values, if needed.<DD><CODE>cacheKeys</CODE> - are the cache keys, if needed (null if no cache desired).<DD><CODE>queryClass</CODE> - is the LRU class name against which this query would be cached,
or null if no LRU behavior desired.
<DT><B>Returns:</B><DD>a resultset.
<DT><B>Throws:</B>
@@ -1537,7 +1537,7 @@ public <A HREF="../../../../../org/apach
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/IDBInterface.html#performQuery(java.lang.String, java.util.List, org.apache.manifoldcf.core.interfaces.StringSet, java.lang.String, int, org.apache.manifoldcf.core.interfaces.ILimitChecker)">performQuery</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/IDBInterface.html" title="interface in org.apache.manifoldcf.core.interfaces">IDBInterface</A></CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>query</CODE> - is the query string.<DD><CODE>params</CODE> - are the parameterized values, if needed.<DD><CODE>cacheKeys</CODE> - are the cache keys, if needed (null if no cache desired).<DD><CODE>queryClass</CODE> - is the LRU class name against which this query would be cached,
+<DT><B>Parameters:</B><DD><CODE>query</CODE> - is the query string.<DD><CODE>params</CODE> - are the parameterized values, if needed.<DD><CODE>cacheKeys</CODE> - are the cache keys, if needed (null if no cache desired).<DD><CODE>queryClass</CODE> - is the LRU class name against which this query would be cached,
or null if no LRU behavior desired.<DD><CODE>maxResults</CODE> - is the maximum number of results returned (-1 for all).<DD><CODE>returnLimit</CODE> - is a description of how to limit the return result, or null if no limit.
<DT><B>Returns:</B><DD>a resultset.
<DT><B>Throws:</B>
@@ -1564,7 +1564,7 @@ public <A HREF="../../../../../org/apach
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/IDBInterface.html#performQuery(java.lang.String, java.util.List, org.apache.manifoldcf.core.interfaces.StringSet, java.lang.String, int, org.apache.manifoldcf.core.interfaces.ResultSpecification, org.apache.manifoldcf.core.interfaces.ILimitChecker)">performQuery</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/IDBInterface.html" title="interface in org.apache.manifoldcf.core.interfaces">IDBInterface</A></CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>query</CODE> - is the query string.<DD><CODE>params</CODE> - are the parameterized values, if needed.<DD><CODE>cacheKeys</CODE> - are the cache keys, if needed (null if no cache desired).<DD><CODE>queryClass</CODE> - is the LRU class name against which this query would be cached,
+<DT><B>Parameters:</B><DD><CODE>query</CODE> - is the query string.<DD><CODE>params</CODE> - are the parameterized values, if needed.<DD><CODE>cacheKeys</CODE> - are the cache keys, if needed (null if no cache desired).<DD><CODE>queryClass</CODE> - is the LRU class name against which this query would be cached,
or null if no LRU behavior desired.<DD><CODE>maxResults</CODE> - is the maximum number of results returned (-1 for all).<DD><CODE>resultSpec</CODE> - is a result specification, or null for the standard treatment.<DD><CODE>returnLimit</CODE> - is a description of how to limit the return result, or null if no limit.
<DT><B>Returns:</B><DD>a resultset.
<DT><B>Throws:</B>
@@ -1578,8 +1578,8 @@ constructDoubleCastClause</H3>
<PRE>
public java.lang.String <B>constructDoubleCastClause</B>(java.lang.String value)</PRE>
<DL>
-<DD>Construct a cast to a double value.
- On most databases this cast needs to be explicit, but on some it is implicit (and cannot be in fact
+<DD>Construct a cast to a double value.
+ On most databases this cast needs to be explicit, but on some it is implicit (and cannot be in fact
specified).
<P>
<DD><DL>
@@ -1597,8 +1597,8 @@ constructCountClause</H3>
<PRE>
public java.lang.String <B>constructCountClause</B>(java.lang.String column)</PRE>
<DL>
-<DD>Construct a count clause.
- On most databases this will be COUNT(col), but on some the count needs to be cast to a BIGINT, so
+<DD>Construct a count clause.
+ On most databases this will be COUNT(col), but on some the count needs to be cast to a BIGINT, so
CAST(COUNT(col) AS BIGINT) will be emitted instead.
<P>
<DD><DL>
@@ -1618,7 +1618,7 @@ public java.lang.String <B>constructRege
java.lang.String regularExpression,
boolean caseInsensitive)</PRE>
<DL>
-<DD>Construct a regular-expression match clause.
+<DD>Construct a regular-expression match clause.
This method builds both the text part of a regular-expression match.
<P>
<DD><DL>
@@ -1638,8 +1638,8 @@ public java.lang.String <B>constructSubs
java.lang.String regularExpression,
boolean caseInsensitive)</PRE>
<DL>
-<DD>Construct a regular-expression substring clause.
- This method builds an expression that extracts a specified string section from a field, based on
+<DD>Construct a regular-expression substring clause.
+ This method builds an expression that extracts a specified string section from a field, based on
a regular expression.
<P>
<DD><DL>
@@ -1659,7 +1659,7 @@ public java.lang.String <B>constructOffs
int limit,
boolean afterOrderBy)</PRE>
<DL>
-<DD>Construct an offset/limit clause.
+<DD>Construct an offset/limit clause.
This method constructs an offset/limit clause in the proper manner for the database in question.
<P>
<DD><DL>
@@ -1683,16 +1683,16 @@ public java.lang.String <B>constructDist
boolean[] orderFieldsAscending,
java.util.Map<java.lang.String,java.lang.String> otherFields)</PRE>
<DL>
-<DD>Construct a 'distinct on (x)' filter.
- This filter wraps a query and returns a new query whose results are similar to POSTGRESQL's DISTINCT-ON feature.
- Specifically, for each combination of the specified distinct fields in the result, only the first such row is included in the final
+<DD>Construct a 'distinct on (x)' filter.
+ This filter wraps a query and returns a new query whose results are similar to POSTGRESQL's DISTINCT-ON feature.
+ Specifically, for each combination of the specified distinct fields in the result, only the first such row is included in the final
result.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/IDBInterface.html#constructDistinctOnClause(java.util.List, java.lang.String, java.util.List, java.lang.String[], java.lang.String[], boolean[], java.util.Map)">constructDistinctOnClause</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/IDBInterface.html" title="interface in org.apache.manifoldcf.core.interfaces">IDBInterface</A></CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>outputParameters</CODE> - is a blank list into which to put parameters. Null may be used if the baseParameters parameter is null.<DD><CODE>baseQuery</CODE> - is the base query, which is another SELECT statement, without parens,
+<DT><B>Parameters:</B><DD><CODE>outputParameters</CODE> - is a blank list into which to put parameters. Null may be used if the baseParameters parameter is null.<DD><CODE>baseQuery</CODE> - is the base query, which is another SELECT statement, without parens,
e.g. "SELECT ..."<DD><CODE>baseParameters</CODE> - are the parameters corresponding to the baseQuery.<DD><CODE>distinctFields</CODE> - are the fields to consider to be distinct. These should all be keys in otherFields below.<DD><CODE>orderFields</CODE> - are the otherfield keys that determine the ordering.<DD><CODE>orderFieldsAscending</CODE> - are true for orderFields that are ordered as ASC, false for DESC.<DD><CODE>otherFields</CODE> - are the rest of the fields to return, keyed by the AS name, value being the base query column value, e.g. "value AS key"
<DT><B>Returns:</B><DD>a revised query that performs the necessary DISTINCT ON operation. The list outputParameters will also be appropriately filled in.</DL>
</DD>
@@ -1704,8 +1704,8 @@ getMaxInClause</H3>
<PRE>
public int <B>getMaxInClause</B>()</PRE>
<DL>
-<DD>Obtain the maximum number of individual items that should be
- present in an IN clause. Exceeding this amount will potentially cause the query performance
+<DD>Obtain the maximum number of individual items that should be
+ present in an IN clause. Exceeding this amount will potentially cause the query performance
to drop.
<P>
<DD><DL>
@@ -1723,8 +1723,8 @@ getMaxOrClause</H3>
<PRE>
public int <B>getMaxOrClause</B>()</PRE>
<DL>
-<DD>Obtain the maximum number of individual clauses that should be
- present in a sequence of OR clauses. Exceeding this amount will potentially cause the query performance
+<DD>Obtain the maximum number of individual clauses that should be
+ present in a sequence of OR clauses. Exceeding this amount will potentially cause the query performance
to drop.
<P>
<DD><DL>
@@ -1742,7 +1742,7 @@ getWindowedReportMaxRows</H3>
<PRE>
public int <B>getWindowedReportMaxRows</B>()</PRE>
<DL>
-<DD>For windowed report queries, e.g. maxActivity or maxBandwidth, obtain the maximum number of rows
+<DD>For windowed report queries, e.g. maxActivity or maxBandwidth, obtain the maximum number of rows
that can reasonably be expected to complete in an acceptable time.
<P>
<DD><DL>
@@ -1761,12 +1761,12 @@ beginTransaction</H3>
public void <B>beginTransaction</B>()
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Begin a database transaction. This method call MUST be paired with an endTransaction() call,
- or database handles will be lost. If the transaction should be rolled back, then signalRollback() should
- be called before the transaction is ended.
- It is strongly recommended that the code that uses transactions be structured so that a try block
- starts immediately after this method call. The body of the try block will contain all direct or indirect
- calls to executeQuery(). After this should be a catch for every exception type, including Error, which should call the
+<DD>Begin a database transaction. This method call MUST be paired with an endTransaction() call,
+ or database handles will be lost. If the transaction should be rolled back, then signalRollback() should
+ be called before the transaction is ended.
+ It is strongly recommended that the code that uses transactions be structured so that a try block
+ starts immediately after this method call. The body of the try block will contain all direct or indirect
+ calls to executeQuery(). After this should be a catch for every exception type, including Error, which should call the
signalRollback() method, and rethrow the exception. Then, after that a finally{} block which calls endTransaction().
<P>
<DD><DL>
@@ -1786,12 +1786,12 @@ beginTransaction</H3>
public void <B>beginTransaction</B>(int transactionType)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Begin a database transaction. This method call MUST be paired with an endTransaction() call,
- or database handles will be lost. If the transaction should be rolled back, then signalRollback() should
- be called before the transaction is ended.
- It is strongly recommended that the code that uses transactions be structured so that a try block
- starts immediately after this method call. The body of the try block will contain all direct or indirect
- calls to executeQuery(). After this should be a catch for every exception type, including Error, which should call the
+<DD>Begin a database transaction. This method call MUST be paired with an endTransaction() call,
+ or database handles will be lost. If the transaction should be rolled back, then signalRollback() should
+ be called before the transaction is ended.
+ It is strongly recommended that the code that uses transactions be structured so that a try block
+ starts immediately after this method call. The body of the try block will contain all direct or indirect
+ calls to executeQuery(). After this should be a catch for every exception type, including Error, which should call the
signalRollback() method, and rethrow the exception. Then, after that a finally{} block which calls endTransaction().
<P>
<DD><DL>
@@ -1827,7 +1827,7 @@ endTransaction</H3>
public void <B>endTransaction</B>()
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>End a database transaction, either performing a commit or a rollback (depending on whether
+<DD>End a database transaction, either performing a commit or a rollback (depending on whether
signalRollback() was called within the transaction).
<P>
<DD><DL>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/Database.ExecuteQueryThread.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/Database.ExecuteQueryThread.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/Database.ExecuteQueryThread.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/Database.ExecuteQueryThread.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:22 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:07:57 EDT 2012 -->
<TITLE>
Database.ExecuteQueryThread
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
@@ -107,8 +107,8 @@ java.lang.Object
</PRE>
<P>
-Thread used to execute queries. An instance of this thread is spun up every time a query is executed. This is necessary because JDBC does not
- guarantee interruptability, and the Postgresql JDBC driver unfortunately eats all thread interrupts. So, we fire up a thread to do each interaction with
+Thread used to execute queries. An instance of this thread is spun up every time a query is executed. This is necessary because JDBC does not
+ guarantee interruptability, and the Postgresql JDBC driver unfortunately eats all thread interrupts. So, we fire up a thread to do each interaction with
the database server, thus insuring that the owning thread remains interruptable and will therefore not block shutdown.
<P>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/Database.Modifications.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/Database.Modifications.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/Database.Modifications.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/Database.Modifications.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:22 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:07:57 EDT 2012 -->
<TITLE>
Database.Modifications
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/Database.QueryCacheExecutor.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/Database.QueryCacheExecutor.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/Database.QueryCacheExecutor.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/Database.QueryCacheExecutor.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:22 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:07:57 EDT 2012 -->
<TITLE>
Database.QueryCacheExecutor
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
@@ -107,11 +107,11 @@ java.lang.Object
</PRE>
<P>
-This object is meant to execute within a cache manager call. It contains all knowledge needed to
- perform any query, including a parameterized one. It may (or may not) be also passed a transaction
- handle, depending on whether or not a transaction is currently underway.
- Nevertheless, all database access, save transaction setup and teardown, takes place inside this class.
- Even uncached queries will be done here; the cache manager will simply not keep the result around
+This object is meant to execute within a cache manager call. It contains all knowledge needed to
+ perform any query, including a parameterized one. It may (or may not) be also passed a transaction
+ handle, depending on whether or not a transaction is currently underway.
+ Nevertheless, all database access, save transaction setup and teardown, takes place inside this class.
+ Even uncached queries will be done here; the cache manager will simply not keep the result around
afterwards.
<P>
@@ -210,7 +210,7 @@ This object is meant to execute within a
java.lang.Object cachedObject)</CODE>
<BR>
- Notify the implementing class of the existence of a cached version of the
+ Notify the implementing class of the existence of a cached version of the
object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -306,7 +306,7 @@ getResult</H3>
<PRE>
public <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/IResultSet.html" title="interface in org.apache.manifoldcf.core.interfaces">IResultSet</A> <B>getResult</B>()</PRE>
<DL>
-<DD>Fetch the result. No errors are possible at this time; they would have already
+<DD>Fetch the result. No errors are possible at this time; they would have already
occurred...
<P>
<DD><DL>
@@ -321,9 +321,9 @@ create</H3>
public java.lang.Object[] <B>create</B>(<A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ICacheDescription.html" title="interface in org.apache.manifoldcf.core.interfaces">ICacheDescription</A>[] objectDescriptions)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Create a new object to operate on and cache. This method is called only
- if the specified object is NOT available in the cache. The specified object
- should be created and returned; if it is not created, it means that the
+<DD>Create a new object to operate on and cache. This method is called only
+ if the specified object is NOT available in the cache. The specified object
+ should be created and returned; if it is not created, it means that the
execution cannot proceed, and the execute() method will not be called.
<P>
<DD><DL>
@@ -342,9 +342,9 @@ public void <B>exists</B>(<A HREF="../..
java.lang.Object cachedObject)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Notify the implementing class of the existence of a cached version of the
- object. The object is passed to this method so that the execute() method below
- will have it available to operate on. This method is also called for all objects
+<DD>Notify the implementing class of the existence of a cached version of the
+ object. The object is passed to this method so that the execute() method below
+ will have it available to operate on. This method is also called for all objects
that are freshly created as well.
<P>
<DD><DL>
@@ -361,7 +361,7 @@ execute</H3>
public void <B>execute</B>()
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Perform the desired operation. This method is called after either createGetObject()
+<DD>Perform the desired operation. This method is called after either createGetObject()
or exists() is called for every requested object.
<P>
<DD><DL>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/Database.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/Database.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/Database.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/Database.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:22 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:07:57 EDT 2012 -->
<TITLE>
Database
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
@@ -103,10 +103,10 @@ java.lang.Object
</PRE>
<P>
-This class implements jskw.interfaces.IDatabase, and provides basic cached database services.
- The actual cache keys are determined by layers above this.
- It is expected that there is ONE of these objects per thread per database! If there are more, then
- the transaction management will get screwed up (i.e. nobody will know what happened to the connection
+This class implements jskw.interfaces.IDatabase, and provides basic cached database services.
+ The actual cache keys are determined by layers above this.
+ It is expected that there is ONE of these objects per thread per database! If there are more, then
+ the transaction management will get screwed up (i.e. nobody will know what happened to the connection
handles...)
<P>
@@ -380,7 +380,7 @@ This class implements jskw.interfaces.ID
<TD><CODE><B><A HREF="../../../../../org/apache/manifoldcf/core/database/Database.html#endTransaction()">endTransaction</A></B>()</CODE>
<BR>
- End a database transaction, either performing a commit or a rollback (depending on whether
+ End a database transaction, either performing a commit or a rollback (depending on whether
signalRollback() was called within the transaction).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -424,7 +424,7 @@ This class implements jskw.interfaces.ID
<A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ILimitChecker.html" title="interface in org.apache.manifoldcf.core.interfaces">ILimitChecker</A> returnLimit)</CODE>
<BR>
- This method does NOT appear in any interface; it is here to
+ This method does NOT appear in any interface; it is here to
service the cache object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -510,7 +510,7 @@ This class implements jskw.interfaces.ID
<TD><CODE><B><A HREF="../../../../../org/apache/manifoldcf/core/database/Database.html#getMaxInClause()">getMaxInClause</A></B>()</CODE>
<BR>
- Obtain the maximum number of individual items that should be
+ Obtain the maximum number of individual items that should be
present in an IN clause.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -1033,23 +1033,23 @@ public <A HREF="../../../../../org/apach
<A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ILimitChecker.html" title="interface in org.apache.manifoldcf.core.interfaces">ILimitChecker</A> returnLimits)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Execute arbitrary database query, and optionally cache the result. Cached results are
- returned for this operation if they are valid and appropriate. Note that any cached results
- returned were only guaranteed to be pertinent at the time the cached result was obtained; the
- actual data may become invalid due to other threads writing to the database.
- This is NOT true, however, if a transaction is started. If a transaction was started for this
- database within this thread context, then the query
- will be executed within the transaction, and since the transaction is owned by the current
+<DD>Execute arbitrary database query, and optionally cache the result. Cached results are
+ returned for this operation if they are valid and appropriate. Note that any cached results
+ returned were only guaranteed to be pertinent at the time the cached result was obtained; the
+ actual data may become invalid due to other threads writing to the database.
+ This is NOT true, however, if a transaction is started. If a transaction was started for this
+ database within this thread context, then the query
+ will be executed within the transaction, and since the transaction is owned by the current
thread, no others will be able to disrupt its processing.
<P>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>query</CODE> - is the actual query string.<DD><CODE>params</CODE> - if not null, are prepared statement parameters.<DD><CODE>cacheKeys</CODE> - is the set of cache keys that the query result will be cached against. If the
- value for this parameter is null, then the query will not be cached.<DD><CODE>invalidateKeys</CODE> - is the set of cache keys that the query will invalidate when the query occurs.
- If this is null, then no keys will be invalidated. Note that if this is in a transaction, the
- cache invalidation will only occur for queries that are part of the transaction, at least until
- the transaction is committed.<DD><CODE>queryClass</CODE> - describes the class of the query, for the purposes of LRU and expiration time.
- The queryClass groups queries together, so that they are managed with a common set of timeouts
- and maximum sizes. If null, then no expiration or LRU behavior will take place.<DD><CODE>needResult</CODE> - is true if the result is needed.<DD><CODE>maxReturn</CODE> - is the maximum number of rows to return. Use -1 for infinite.<DD><CODE>spec</CODE> - is the result specification object, or null for standard.<DD><CODE>returnLimits</CODE> - is a description of how to limit return results (in addition to the maxReturn value).
+<DT><B>Parameters:</B><DD><CODE>query</CODE> - is the actual query string.<DD><CODE>params</CODE> - if not null, are prepared statement parameters.<DD><CODE>cacheKeys</CODE> - is the set of cache keys that the query result will be cached against. If the
+ value for this parameter is null, then the query will not be cached.<DD><CODE>invalidateKeys</CODE> - is the set of cache keys that the query will invalidate when the query occurs.
+ If this is null, then no keys will be invalidated. Note that if this is in a transaction, the
+ cache invalidation will only occur for queries that are part of the transaction, at least until
+ the transaction is committed.<DD><CODE>queryClass</CODE> - describes the class of the query, for the purposes of LRU and expiration time.
+ The queryClass groups queries together, so that they are managed with a common set of timeouts
+ and maximum sizes. If null, then no expiration or LRU behavior will take place.<DD><CODE>needResult</CODE> - is true if the result is needed.<DD><CODE>maxReturn</CODE> - is the maximum number of rows to return. Use -1 for infinite.<DD><CODE>spec</CODE> - is the result specification object, or null for standard.<DD><CODE>returnLimits</CODE> - is a description of how to limit return results (in addition to the maxReturn value).
Pass null if no limits are desired.
<DT><B>Returns:</B><DD>the resultset
<DT><B>Throws:</B>
@@ -1063,7 +1063,7 @@ getCurrentTransactionType</H3>
<PRE>
public int <B>getCurrentTransactionType</B>()</PRE>
<DL>
-<DD>Get the current transaction type. Returns "READCOMMITTED"
+<DD>Get the current transaction type. Returns "READCOMMITTED"
outside of a transaction.
<P>
<DD><DL>
@@ -1078,12 +1078,12 @@ beginTransaction</H3>
public void <B>beginTransaction</B>(int transactionType)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Begin a database transaction. This method call MUST be paired with an endTransaction() call,
- or database handles will be lost. If the transaction should be rolled back, then signalRollback() should
- be called before the transaction is ended.
- It is strongly recommended that the code that uses transactions be structured so that a try block
- starts immediately after this method call. The body of the try block will contain all direct or indirect
- calls to executeQuery(). After this should be a catch for every exception type, including Error, which should call the
+<DD>Begin a database transaction. This method call MUST be paired with an endTransaction() call,
+ or database handles will be lost. If the transaction should be rolled back, then signalRollback() should
+ be called before the transaction is ended.
+ It is strongly recommended that the code that uses transactions be structured so that a try block
+ starts immediately after this method call. The body of the try block will contain all direct or indirect
+ calls to executeQuery(). After this should be a catch for every exception type, including Error, which should call the
signalRollback() method, and rethrow the exception. Then, after that a finally{} block which calls endTransaction().
<P>
<DD><DL>
@@ -1132,9 +1132,9 @@ performCommit</H3>
public void <B>performCommit</B>()
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Perform the transaction commit.
- Calling this method does not relieve the coder of the responsibility of calling endTransaction(),
- as listed below. The purpose of a separate commit operation is to allow handling of situations where the
+<DD>Perform the transaction commit.
+ Calling this method does not relieve the coder of the responsibility of calling endTransaction(),
+ as listed below. The purpose of a separate commit operation is to allow handling of situations where the
commit generates a TRANSACTION_ABORT signal.
<P>
<DD><DL>
@@ -1164,7 +1164,7 @@ endTransaction</H3>
public void <B>endTransaction</B>()
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>End a database transaction, either performing a commit or a rollback (depending on whether
+<DD>End a database transaction, either performing a commit or a rollback (depending on whether
signalRollback() was called within the transaction).
<P>
<DD><DL>
@@ -1248,7 +1248,7 @@ constructOffsetLimitClause</H3>
public java.lang.String <B>constructOffsetLimitClause</B>(int offset,
int limit)</PRE>
<DL>
-<DD>Construct an offset/limit clause.
+<DD>Construct an offset/limit clause.
This method constructs an offset/limit clause in the proper manner for the database in question.
<P>
<DD><DL>
@@ -1265,7 +1265,7 @@ public abstract java.lang.String <B>cons
int limit,
boolean afterOrderBy)</PRE>
<DL>
-<DD>Construct an offset/limit clause.
+<DD>Construct an offset/limit clause.
This method constructs an offset/limit clause in the proper manner for the database in question.
<P>
<DD><DL>
@@ -1291,8 +1291,8 @@ getMaxInClause</H3>
<PRE>
public abstract int <B>getMaxInClause</B>()</PRE>
<DL>
-<DD>Obtain the maximum number of individual items that should be
- present in an IN clause. Exceeding this amount will potentially cause the query performance
+<DD>Obtain the maximum number of individual items that should be
+ present in an IN clause. Exceeding this amount will potentially cause the query performance
to drop.
<P>
<DD><DL>
@@ -1347,7 +1347,7 @@ protected <A HREF="../../../../../org/ap
<A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ILimitChecker.html" title="interface in org.apache.manifoldcf.core.interfaces">ILimitChecker</A> returnLimit)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>This method does NOT appear in any interface; it is here to
+<DD>This method does NOT appear in any interface; it is here to
service the cache object.
<P>
<DD><DL>
@@ -1364,9 +1364,9 @@ initializeConnection</H3>
protected void <B>initializeConnection</B>(java.sql.Connection connection)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Initialize the connection (for HSQLDB).
- HSQLDB has a great deal of session state, and no way to pool individual connections based on it.
- So, every time we pull a connection off the pool we have to execute a number of statements on it
+<DD>Initialize the connection (for HSQLDB).
+ HSQLDB has a great deal of session state, and no way to pool individual connections based on it.
+ So, every time we pull a connection off the pool we have to execute a number of statements on it
before it can work reliably for us. This is the abstraction that permits that to happen.
<P>
<DD><DL>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/MergedResultSet.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/MergedResultSet.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/MergedResultSet.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/MergedResultSet.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:23 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:07:57 EDT 2012 -->
<TITLE>
MergedResultSet
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
@@ -103,8 +103,8 @@ java.lang.Object
</PRE>
<P>
-This class merges several resultsets together to make what appears to be
- a single one. This is very useful when queries are broken up due to restrictions
+This class merges several resultsets together to make what appears to be
+ a single one. This is very useful when queries are broken up due to restrictions
in the length of an IN clause, but the results may need to be merged at the end.
<P>
@@ -334,8 +334,8 @@ getRows</H3>
<PRE>
public <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/IResultRow.html" title="interface in org.apache.manifoldcf.core.interfaces">IResultRow</A>[] <B>getRows</B>()</PRE>
<DL>
-<DD>Get an array of all the rows.
- This method is NOT preferred because it requires a new
+<DD>Get an array of all the rows.
+ This method is NOT preferred because it requires a new
array object to be constructed.
<P>
<DD><DL>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/QueryDescription.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/QueryDescription.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/QueryDescription.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/QueryDescription.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:23 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:07:57 EDT 2012 -->
<TITLE>
QueryDescription
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
@@ -290,7 +290,7 @@ This object is immutable, and is used as
<TD><CODE><B><A HREF="../../../../../org/apache/manifoldcf/core/database/QueryDescription.html#getObjectKeys()">getObjectKeys</A></B>()</CODE>
<BR>
- Get the cache keys for an object (which may or may not exist yet in
+ Get the cache keys for an object (which may or may not exist yet in
the cache).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -594,12 +594,12 @@ getObjectKeys</H3>
<PRE>
public <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/StringSet.html" title="class in org.apache.manifoldcf.core.interfaces">StringSet</A> <B>getObjectKeys</B>()</PRE>
<DL>
-<DD>Get the cache keys for an object (which may or may not exist yet in
+<DD>Get the cache keys for an object (which may or may not exist yet in
the cache). This method is called in order for cache manager to throw the correct locks.
<P>
<DD><DL>
-<DT><B>Returns:</B><DD>the object's cache keys, or null if the object should not
+<DT><B>Returns:</B><DD>the object's cache keys, or null if the object should not
be cached.</DL>
</DD>
</DL>
@@ -611,10 +611,10 @@ getCriticalSectionName</H3>
public java.lang.String <B>getCriticalSectionName</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ICacheDescription.html#getCriticalSectionName()">ICacheDescription</A></CODE></B></DD>
-<DD>Get the critical section name for this description object.
- This is used to synchronize creation of the described object,
- and thus is used only for objects that will be cached. This
- method does not need to return decent results for objects that
+<DD>Get the critical section name for this description object.
+ This is used to synchronize creation of the described object,
+ and thus is used only for objects that will be cached. This
+ method does not need to return decent results for objects that
are never cached.
<P>
<DD><DL>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/RRow.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/RRow.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/RRow.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/RRow.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:23 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:07:57 EDT 2012 -->
<TITLE>
RRow
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/RSet.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/RSet.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/RSet.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/RSet.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:23 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:07:57 EDT 2012 -->
<TITLE>
RSet
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
@@ -312,8 +312,8 @@ getRows</H3>
<PRE>
public <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/IResultRow.html" title="interface in org.apache.manifoldcf.core.interfaces">IResultRow</A>[] <B>getRows</B>()</PRE>
<DL>
-<DD>Get an array of all the rows.
- This method is NOT preferred because it requires a new
+<DD>Get an array of all the rows.
+ This method is NOT preferred because it requires a new
array object to be constructed.
<P>
<DD><DL>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/TransactionHandle.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/TransactionHandle.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/TransactionHandle.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/TransactionHandle.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:23 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:07:57 EDT 2012 -->
<TITLE>
TransactionHandle
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
@@ -100,9 +100,9 @@ java.lang.Object
</PRE>
<P>
-This class represents all the data that describes a transaction, including:
- (2) the previous transaction handle,
- (3) the unique transaction id,
+This class represents all the data that describes a transaction, including:
+ (2) the previous transaction handle,
+ (3) the unique transaction id,
(4) the cache keys that have been invalidated within this transaction.
<P>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/package-frame.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/package-frame.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/package-frame.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/package-frame.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:35 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:10 EDT 2012 -->
<TITLE>
org.apache.manifoldcf.core.database
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/package-summary.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/package-summary.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/package-summary.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/package-summary.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:35 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:10 EDT 2012 -->
<TITLE>
org.apache.manifoldcf.core.database
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
@@ -89,17 +89,17 @@ Package org.apache.manifoldcf.core.datab
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/manifoldcf/core/database/BaseObject.html" title="class in org.apache.manifoldcf.core.database">BaseObject</A></B></TD>
-<TD>This is the base paper object, which can represents all the fields of a database row -
+<TD>This is the base paper object, which can represents all the fields of a database row -
plus anything else that is added.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/manifoldcf/core/database/BaseTable.html" title="class in org.apache.manifoldcf.core.database">BaseTable</A></B></TD>
-<TD>This class is a base class that provides a common foundation for table managers
+<TD>This class is a base class that provides a common foundation for table managers
for various different tables in the system.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/manifoldcf/core/database/ConnectionFactory.html" title="class in org.apache.manifoldcf.core.database">ConnectionFactory</A></B></TD>
-<TD>This class creates a connection, and may at our discretion manage
+<TD>This class creates a connection, and may at our discretion manage
a connection pool someday.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -108,7 +108,7 @@ Package org.apache.manifoldcf.core.datab
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/manifoldcf/core/database/ConnectionFactory.PoolManager.html" title="class in org.apache.manifoldcf.core.database">ConnectionFactory.PoolManager</A></B></TD>
-<TD>This class abstracts from a connection pool, such that a static reference
+<TD>This class abstracts from a connection pool, such that a static reference
to an instance of this class will describe the entire body of connections.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -149,7 +149,7 @@ Package org.apache.manifoldcf.core.datab
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/manifoldcf/core/database/MergedResultSet.html" title="class in org.apache.manifoldcf.core.database">MergedResultSet</A></B></TD>
-<TD>This class merges several resultsets together to make what appears to be
+<TD>This class merges several resultsets together to make what appears to be
a single one.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -166,9 +166,9 @@ Package org.apache.manifoldcf.core.datab
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/manifoldcf/core/database/TransactionHandle.html" title="class in org.apache.manifoldcf.core.database">TransactionHandle</A></B></TD>
-<TD>This class represents all the data that describes a transaction, including:
- (2) the previous transaction handle,
- (3) the unique transaction id,
+<TD>This class represents all the data that describes a transaction, including:
+ (2) the previous transaction handle,
+ (3) the unique transaction id,
(4) the cache keys that have been invalidated within this transaction.</TD>
</TR>
</TABLE>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/package-tree.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/package-tree.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/package-tree.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/database/package-tree.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:35 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:10 EDT 2012 -->
<TITLE>
org.apache.manifoldcf.core.database Class Hierarchy
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">