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 23:25:39 UTC
svn commit: r1345585 [12/33] - in /incubator/lcf/site/publish: ./ en_US/
ja_JP/ release/trunk/ release/trunk/api/activedirectory/
release/trunk/api/activedirectory/org/apache/manifoldcf/authorities/authorities/activedirectory/
release/trunk/api/alfresc...
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=1345585&r1=1345584&r2=1345585&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 21:24:51 2012
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:07:57 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:28 EDT 2012 -->
<TITLE>
Database
</TITLE>
@@ -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=1345585&r1=1345584&r2=1345585&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 21:24:51 2012
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:07:57 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:29 EDT 2012 -->
<TITLE>
MergedResultSet
</TITLE>
@@ -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=1345585&r1=1345584&r2=1345585&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 21:24:51 2012
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:07:57 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:29 EDT 2012 -->
<TITLE>
QueryDescription
</TITLE>
@@ -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=1345585&r1=1345584&r2=1345585&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 21:24:51 2012
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:07:57 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:29 EDT 2012 -->
<TITLE>
RRow
</TITLE>
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=1345585&r1=1345584&r2=1345585&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 21:24:51 2012
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:07:57 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:29 EDT 2012 -->
<TITLE>
RSet
</TITLE>
@@ -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=1345585&r1=1345584&r2=1345585&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 21:24:51 2012
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:07:57 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:29 EDT 2012 -->
<TITLE>
TransactionHandle
</TITLE>
@@ -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=1345585&r1=1345584&r2=1345585&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 21:24:51 2012
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:10 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:42 EDT 2012 -->
<TITLE>
org.apache.manifoldcf.core.database
</TITLE>
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=1345585&r1=1345584&r2=1345585&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 21:24:51 2012
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:10 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:42 EDT 2012 -->
<TITLE>
org.apache.manifoldcf.core.database
</TITLE>
@@ -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=1345585&r1=1345584&r2=1345585&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 21:24:51 2012
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:10 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:42 EDT 2012 -->
<TITLE>
org.apache.manifoldcf.core.database Class Hierarchy
</TITLE>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/i18n/MCFVelocityResourceLoader.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/i18n/MCFVelocityResourceLoader.html?rev=1345585&r1=1345584&r2=1345585&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/i18n/MCFVelocityResourceLoader.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/i18n/MCFVelocityResourceLoader.html Sat Jun 2 21:24:51 2012
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:07:59 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:30 EDT 2012 -->
<TITLE>
MCFVelocityResourceLoader
</TITLE>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/i18n/Messages.BundleKey.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/i18n/Messages.BundleKey.html?rev=1345585&r1=1345584&r2=1345585&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/i18n/Messages.BundleKey.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/i18n/Messages.BundleKey.html Sat Jun 2 21:24:51 2012
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:07:59 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:30 EDT 2012 -->
<TITLE>
Messages.BundleKey
</TITLE>
@@ -103,7 +103,7 @@ java.lang.Object
</PRE>
<P>
-Class to help keep track of the missing resource bundles we've already complained about,
+Class to help keep track of the missing resource bundles we've already complained about,
so we don't fill up the standard out log with repetitive stuff.
<P>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/i18n/Messages.MessageKey.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/i18n/Messages.MessageKey.html?rev=1345585&r1=1345584&r2=1345585&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/i18n/Messages.MessageKey.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/i18n/Messages.MessageKey.html Sat Jun 2 21:24:51 2012
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:07:59 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:30 EDT 2012 -->
<TITLE>
Messages.MessageKey
</TITLE>
@@ -103,7 +103,7 @@ java.lang.Object
</PRE>
<P>
-Class to help keep track of the missing messages we've already complained about,
+Class to help keep track of the missing messages we've already complained about,
so we don't fill up the standard out log with repetitive stuff.
<P>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/i18n/Messages.ResourceKey.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/i18n/Messages.ResourceKey.html?rev=1345585&r1=1345584&r2=1345585&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/i18n/Messages.ResourceKey.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/i18n/Messages.ResourceKey.html Sat Jun 2 21:24:51 2012
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:07:59 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:30 EDT 2012 -->
<TITLE>
Messages.ResourceKey
</TITLE>
@@ -103,7 +103,7 @@ java.lang.Object
</PRE>
<P>
-Class to help keep track of the missing resources we've already complained about,
+Class to help keep track of the missing resources we've already complained about,
so we don't fill up the standard out log with repetitive stuff.
<P>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/i18n/Messages.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/i18n/Messages.html?rev=1345585&r1=1345584&r2=1345585&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/i18n/Messages.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/i18n/Messages.html Sat Jun 2 21:24:51 2012
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:07:59 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:30 EDT 2012 -->
<TITLE>
Messages
</TITLE>
@@ -120,7 +120,7 @@ java.lang.Object
<TD><CODE><B><A HREF="../../../../../org/apache/manifoldcf/core/i18n/Messages.BundleKey.html" title="class in org.apache.manifoldcf.core.i18n">Messages.BundleKey</A></B></CODE>
<BR>
- Class to help keep track of the missing resource bundles we've already complained about,
+ Class to help keep track of the missing resource bundles we've already complained about,
so we don't fill up the standard out log with repetitive stuff.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -129,7 +129,7 @@ java.lang.Object
<TD><CODE><B><A HREF="../../../../../org/apache/manifoldcf/core/i18n/Messages.MessageKey.html" title="class in org.apache.manifoldcf.core.i18n">Messages.MessageKey</A></B></CODE>
<BR>
- Class to help keep track of the missing messages we've already complained about,
+ Class to help keep track of the missing messages we've already complained about,
so we don't fill up the standard out log with repetitive stuff.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -138,7 +138,7 @@ java.lang.Object
<TD><CODE><B><A HREF="../../../../../org/apache/manifoldcf/core/i18n/Messages.ResourceKey.html" title="class in org.apache.manifoldcf.core.i18n">Messages.ResourceKey</A></B></CODE>
<BR>
- Class to help keep track of the missing resources we've already complained about,
+ Class to help keep track of the missing resources we've already complained about,
so we don't fill up the standard out log with repetitive stuff.</TD>
</TR>
</TABLE>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/i18n/package-frame.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/i18n/package-frame.html?rev=1345585&r1=1345584&r2=1345585&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/i18n/package-frame.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/i18n/package-frame.html Sat Jun 2 21:24:51 2012
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:10 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:42 EDT 2012 -->
<TITLE>
org.apache.manifoldcf.core.i18n
</TITLE>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/i18n/package-summary.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/i18n/package-summary.html?rev=1345585&r1=1345584&r2=1345585&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/i18n/package-summary.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/i18n/package-summary.html Sat Jun 2 21:24:51 2012
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:10 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:42 EDT 2012 -->
<TITLE>
org.apache.manifoldcf.core.i18n
</TITLE>
@@ -97,17 +97,17 @@ Package org.apache.manifoldcf.core.i18n
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/manifoldcf/core/i18n/Messages.BundleKey.html" title="class in org.apache.manifoldcf.core.i18n">Messages.BundleKey</A></B></TD>
-<TD>Class to help keep track of the missing resource bundles we've already complained about,
+<TD>Class to help keep track of the missing resource bundles we've already complained about,
so we don't fill up the standard out log with repetitive stuff.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/manifoldcf/core/i18n/Messages.MessageKey.html" title="class in org.apache.manifoldcf.core.i18n">Messages.MessageKey</A></B></TD>
-<TD>Class to help keep track of the missing messages we've already complained about,
+<TD>Class to help keep track of the missing messages we've already complained about,
so we don't fill up the standard out log with repetitive stuff.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/manifoldcf/core/i18n/Messages.ResourceKey.html" title="class in org.apache.manifoldcf.core.i18n">Messages.ResourceKey</A></B></TD>
-<TD>Class to help keep track of the missing resources we've already complained about,
+<TD>Class to help keep track of the missing resources we've already complained about,
so we don't fill up the standard out log with repetitive stuff.</TD>
</TR>
</TABLE>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/i18n/package-tree.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/i18n/package-tree.html?rev=1345585&r1=1345584&r2=1345585&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/i18n/package-tree.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/i18n/package-tree.html Sat Jun 2 21:24:51 2012
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:10 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:42 EDT 2012 -->
<TITLE>
org.apache.manifoldcf.core.i18n Class Hierarchy
</TITLE>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/BinaryInput.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/BinaryInput.html?rev=1345585&r1=1345584&r2=1345585&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/BinaryInput.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/BinaryInput.html Sat Jun 2 21:24:51 2012
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:07:58 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:29 EDT 2012 -->
<TITLE>
BinaryInput
</TITLE>
@@ -103,9 +103,9 @@ java.lang.Object
</PRE>
<P>
-This class represents a lightweight length-determined stream. It is used
- as a parameter in parameterized queries that use blobs.
- There are no implied semantics in this class around managing the stream itself.
+This class represents a lightweight length-determined stream. It is used
+ as a parameter in parameterized queries that use blobs.
+ There are no implied semantics in this class around managing the stream itself.
These semantics must be handled by a derived class.
<P>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/CacheKeyFactory.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/CacheKeyFactory.html?rev=1345585&r1=1345584&r2=1345585&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/CacheKeyFactory.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/CacheKeyFactory.html Sat Jun 2 21:24:51 2012
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:07:58 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:29 EDT 2012 -->
<TITLE>
CacheKeyFactory
</TITLE>
@@ -103,7 +103,7 @@ java.lang.Object
</PRE>
<P>
-This class just represents a central place where cache keys are assembled.
+This class just represents a central place where cache keys are assembled.
All methods are static.
<P>
@@ -180,7 +180,7 @@ This class just represents a central pla
java.lang.String databaseName)</CODE>
<BR>
- Construct a key that is database specific, and applies to queries
+ Construct a key that is database specific, and applies to queries
made against a specific table name.</TD>
</TR>
</TABLE>
@@ -248,12 +248,12 @@ makeDatabaseKey</H3>
public static java.lang.String <B>makeDatabaseKey</B>(java.lang.String keyName,
java.lang.String databaseName)</PRE>
<DL>
-<DD>Construct a key that is database specific.
- Typically, this
- method is not called directly; it gets invoked by other key construction
- methods.
- Overall, it will be called last in a compositional sequence that looks
- conceptually like this:
+<DD>Construct a key that is database specific.
+ Typically, this
+ method is not called directly; it gets invoked by other key construction
+ methods.
+ Overall, it will be called last in a compositional sequence that looks
+ conceptually like this:
makeDatabaseKey(makeTableKey(makeThingsTableTypeKey(typeX),"Things"),databaseName);
<P>
<DD><DL>
@@ -270,7 +270,7 @@ public static java.lang.String <B>makeTa
java.lang.String tableName,
java.lang.String databaseName)</PRE>
<DL>
-<DD>Construct a key that is database specific, and applies to queries
+<DD>Construct a key that is database specific, and applies to queries
made against a specific table name.
<P>
<DD><DL>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/CacheManagerFactory.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/CacheManagerFactory.html?rev=1345585&r1=1345584&r2=1345585&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/CacheManagerFactory.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/CacheManagerFactory.html Sat Jun 2 21:24:51 2012
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:07:58 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:29 EDT 2012 -->
<TITLE>
CacheManagerFactory
</TITLE>
@@ -189,7 +189,7 @@ make</H3>
public static <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ICacheManager.html" title="interface in org.apache.manifoldcf.core.interfaces">ICacheManager</A> <B>make</B>(<A HREF="../../../../../org/apache/manifoldcf/core/interfaces/IThreadContext.html" title="interface in org.apache.manifoldcf.core.interfaces">IThreadContext</A> context)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Return a cache manager instance that any client can use to obtain cache management services.
+<DD>Return a cache manager instance that any client can use to obtain cache management services.
This service will use the lock manager, so it needs to have a thread context.
<P>
<DD><DL>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/CharacterInput.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/CharacterInput.html?rev=1345585&r1=1345584&r2=1345585&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/CharacterInput.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/CharacterInput.html Sat Jun 2 21:24:51 2012
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:07:58 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:29 EDT 2012 -->
<TITLE>
CharacterInput
</TITLE>
@@ -103,9 +103,9 @@ java.lang.Object
</PRE>
<P>
-This class represents a lightweight length-determined character stream. It is used
- as a parameter in parameterized queries that use strings.
- There are no implied semantics in this class around managing the stream itself.
+This class represents a lightweight length-determined character stream. It is used
+ as a parameter in parameterized queries that use strings.
+ There are no implied semantics in this class around managing the stream itself.
These semantics must be handled by a derived class.
<P>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ClauseDescription.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ClauseDescription.html?rev=1345585&r1=1345584&r2=1345585&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ClauseDescription.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ClauseDescription.html Sat Jun 2 21:24:51 2012
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:07:58 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:29 EDT 2012 -->
<TITLE>
ClauseDescription
</TITLE>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ColumnDescription.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ColumnDescription.html?rev=1345585&r1=1345584&r2=1345585&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ColumnDescription.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ColumnDescription.html Sat Jun 2 21:24:51 2012
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:07:58 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:29 EDT 2012 -->
<TITLE>
ColumnDescription
</TITLE>
@@ -362,11 +362,11 @@ public <B>ColumnDescription</B>(java.lan
java.lang.String referenceColumn,
boolean referenceCascade)</PRE>
<DL>
-<DD>Create a column type description.
+<DD>Create a column type description.
Use the output of this method in the columnMap with performCreate().
<P>
<DL>
-<DT><B>Parameters:</B><DD><CODE>typeString</CODE> - is a type specification<DD><CODE>isPrimaryKey</CODE> - describes whether the column is a primary key<DD><CODE>isNull</CODE> - describes whether the column is nullable<DD><CODE>referenceTable</CODE> - describes the reference table, if any.<DD><CODE>referenceCascade</CODE> - is true if deletes should be cascaded.
+<DT><B>Parameters:</B><DD><CODE>typeString</CODE> - is a type specification<DD><CODE>isPrimaryKey</CODE> - describes whether the column is a primary key<DD><CODE>isNull</CODE> - describes whether the column is nullable<DD><CODE>referenceTable</CODE> - describes the reference table, if any.<DD><CODE>referenceCascade</CODE> - is true if deletes should be cascaded.
returns a column description object.</DL>
</DL>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ConfigNode.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ConfigNode.html?rev=1345585&r1=1345584&r2=1345585&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ConfigNode.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ConfigNode.html Sat Jun 2 21:24:51 2012
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:07:58 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:29 EDT 2012 -->
<TITLE>
ConfigNode
</TITLE>
@@ -104,7 +104,7 @@ java.lang.Object
</PRE>
<P>
-This class represents a node in a repository configuration structure. Its existence apart from ConfigurationNode is
+This class represents a node in a repository configuration structure. Its existence apart from ConfigurationNode is
largely a relic.
<P>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ConfigParams.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ConfigParams.html?rev=1345585&r1=1345584&r2=1345585&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ConfigParams.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ConfigParams.html Sat Jun 2 21:24:51 2012
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:07:58 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:29 EDT 2012 -->
<TITLE>
ConfigParams
</TITLE>
@@ -104,7 +104,7 @@ java.lang.Object
</PRE>
<P>
-This class represents a set of configuration parameters, with structure, which is a generalized hierarchy of nodes that
+This class represents a set of configuration parameters, with structure, which is a generalized hierarchy of nodes that
can be interpreted by a repository or authority connector in an appropriate way.
<P>
@@ -404,7 +404,7 @@ public <B>ConfigParams</B>(java.util.Map
<DD>Constructor.
<P>
<DL>
-<DT><B>Parameters:</B><DD><CODE>map</CODE> - is the initialized (mutable) map describing the name/value configuration parameters.
+<DT><B>Parameters:</B><DD><CODE>map</CODE> - is the initialized (mutable) map describing the name/value configuration parameters.
This method of setting up a ConfigParams object will go away when the parameters are all in XML.</DL>
</DL>
<HR>
@@ -567,7 +567,7 @@ public void <B>setParameter</B>(java.lan
<DD>Set a parameter value.
<P>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>key</CODE> - is the name of the parameter.<DD><CODE>value</CODE> - is the new value, or null if we should
+<DT><B>Parameters:</B><DD><CODE>key</CODE> - is the name of the parameter.<DD><CODE>value</CODE> - is the new value, or null if we should
delete the value.</DL>
</DD>
</DL>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/Configuration.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/Configuration.html?rev=1345585&r1=1345584&r2=1345585&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/Configuration.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/Configuration.html Sat Jun 2 21:24:51 2012
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:07:58 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:29 EDT 2012 -->
<TITLE>
Configuration
</TITLE>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ConfigurationNode.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ConfigurationNode.html?rev=1345585&r1=1345584&r2=1345585&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ConfigurationNode.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ConfigurationNode.html Sat Jun 2 21:24:51 2012
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:07:58 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:29 EDT 2012 -->
<TITLE>
ConfigurationNode
</TITLE>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/DBInterfaceFactory.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/DBInterfaceFactory.html?rev=1345585&r1=1345584&r2=1345585&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/DBInterfaceFactory.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/DBInterfaceFactory.html Sat Jun 2 21:24:51 2012
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:07:58 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:29 EDT 2012 -->
<TITLE>
DBInterfaceFactory
</TITLE>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ICacheClass.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ICacheClass.html?rev=1345585&r1=1345584&r2=1345585&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ICacheClass.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ICacheClass.html Sat Jun 2 21:24:51 2012
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:07:58 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:29 EDT 2012 -->
<TITLE>
ICacheClass
</TITLE>
@@ -99,7 +99,7 @@ Interface ICacheClass</H2>
</PRE>
<P>
-This interface represents an object class. It provides methods that permit
+This interface represents an object class. It provides methods that permit
the cache manager to learn about the LRU properties of a cached object.
<P>
@@ -187,8 +187,8 @@ getClassName</H3>
<PRE>
java.lang.String <B>getClassName</B>()</PRE>
<DL>
-<DD>Get the name of the object class.
- This determines the set of objects that are treated in the same
+<DD>Get the name of the object class.
+ This determines the set of objects that are treated in the same
LRU pool.
<P>
<DD><DL>
@@ -207,7 +207,7 @@ int <B>getMaxLRUCount</B>()</PRE>
<P>
<DD><DL>
-<DT><B>Returns:</B><DD>the maximum number of the objects of the particular class
+<DT><B>Returns:</B><DD>the maximum number of the objects of the particular class
allowed.</DL>
</DD>
</DL>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ICacheCreateHandle.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ICacheCreateHandle.html?rev=1345585&r1=1345584&r2=1345585&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ICacheCreateHandle.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ICacheCreateHandle.html Sat Jun 2 21:24:51 2012
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:07:58 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:29 EDT 2012 -->
<TITLE>
ICacheCreateHandle
</TITLE>
@@ -99,7 +99,7 @@ Interface ICacheCreateHandle</H2>
</PRE>
<P>
-This is a handle created by the cache manager, which describes the current status of a cache
+This is a handle created by the cache manager, which describes the current status of a cache
lookup/create session.
<P>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ICacheDescription.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ICacheDescription.html?rev=1345585&r1=1345584&r2=1345585&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ICacheDescription.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ICacheDescription.html Sat Jun 2 21:24:51 2012
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:07:58 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:29 EDT 2012 -->
<TITLE>
ICacheDescription
</TITLE>
@@ -99,12 +99,12 @@ Interface ICacheDescription</H2>
</PRE>
<P>
-This interface represents objects that describe cacheable objects.
- Implementors of this interface should ideally be immutable, if they
- are used to describe objects that are placed in cache.
- Note well: The getCriticalSectionName() method described by this interface is
- meant to return the name of a critical section. This should
- be distinguishable from other critical sections in the system;
+This interface represents objects that describe cacheable objects.
+ Implementors of this interface should ideally be immutable, if they
+ are used to describe objects that are placed in cache.
+ Note well: The getCriticalSectionName() method described by this interface is
+ meant to return the name of a critical section. This should
+ be distinguishable from other critical sections in the system;
it should therefore have the classname as a component.
<P>
@@ -168,7 +168,7 @@ This interface represents objects that d
<TD><CODE><B><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ICacheDescription.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>
</TABLE>
@@ -209,12 +209,12 @@ getObjectKeys</H3>
<PRE>
<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>
@@ -225,10 +225,10 @@ getCriticalSectionName</H3>
<PRE>
java.lang.String <B>getCriticalSectionName</B>()</PRE>
<DL>
-<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>
@@ -243,12 +243,12 @@ getObjectClass</H3>
<PRE>
<A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ICacheClass.html" title="interface in org.apache.manifoldcf.core.interfaces">ICacheClass</A> <B>getObjectClass</B>()</PRE>
<DL>
-<DD>Get the object class for an object. The object class is used to determine
+<DD>Get the object class for an object. The object class is used to determine
the group of objects treated in the same LRU manner.
<P>
<DD><DL>
-<DT><B>Returns:</B><DD>the newly created object's object class, or null if there is no
+<DT><B>Returns:</B><DD>the newly created object's object class, or null if there is no
such class, and LRU behavior is not desired.</DL>
</DD>
</DL>
@@ -259,13 +259,13 @@ getObjectExpirationTime</H3>
<PRE>
long <B>getObjectExpirationTime</B>(long currentTime)</PRE>
<DL>
-<DD>Obtain an expiration time for an object, in milliseconds since epoch.
- The cache manager will call this method whenever the object is being looked up,
+<DD>Obtain an expiration time for an object, in milliseconds since epoch.
+ The cache manager will call this method whenever the object is being looked up,
so that its expiration timestamps can be properly updated to a new time.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>currentTime</CODE> - is the time of the lookup, in milliseconds since epoch.
-<DT><B>Returns:</B><DD>a time in milliseconds since epoch for the object to expire, or -1 if there is no expiration
+<DT><B>Returns:</B><DD>a time in milliseconds since epoch for the object to expire, or -1 if there is no expiration
desired.</DL>
</DD>
</DL>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ICacheExecutor.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ICacheExecutor.html?rev=1345585&r1=1345584&r2=1345585&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ICacheExecutor.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ICacheExecutor.html Sat Jun 2 21:24:51 2012
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:07:58 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:29 EDT 2012 -->
<TITLE>
ICacheExecutor
</TITLE>
@@ -99,23 +99,23 @@ Interface ICacheExecutor</H2>
</PRE>
<P>
-This interface describes an object designed to be instantiated solely for the purpose of
- running inside the global cache manager's execution method. The cache manager will
- perform all synchronization, and for objects being accessed will call either the create*()
- family of methods below, or
- the exists() method, if the object was found in the cache. For all existing objects being
- invalidated,
- the destroy() method will be called.
- It IS legal to specify the same object for both read and invalidate! In this case, both
- the create() or exists() sequence AND the destroy() method will be called.
- Finally, after this has been
- done for all of the requested objects, the execute() method will be called.
-
- Users of the cache manager will need to create objects implementing this interface when they want to
- operate on a set of cached objects.
- NOTE: Objects that are created by a cache executor must obey the following rule: A given objectDescription
- must always have the same invalidation keys, regardless of which cache executor object creates them,
- and regardless of WHEN the object is instantiated. This is required in order to ensure that the locks
+This interface describes an object designed to be instantiated solely for the purpose of
+ running inside the global cache manager's execution method. The cache manager will
+ perform all synchronization, and for objects being accessed will call either the create*()
+ family of methods below, or
+ the exists() method, if the object was found in the cache. For all existing objects being
+ invalidated,
+ the destroy() method will be called.
+ It IS legal to specify the same object for both read and invalidate! In this case, both
+ the create() or exists() sequence AND the destroy() method will be called.
+ Finally, after this has been
+ done for all of the requested objects, the execute() method will be called.
+
+ Users of the cache manager will need to create objects implementing this interface when they want to
+ operate on a set of cached objects.
+ NOTE: Objects that are created by a cache executor must obey the following rule: A given objectDescription
+ must always have the same invalidation keys, regardless of which cache executor object creates them,
+ and regardless of WHEN the object is instantiated. This is required in order to ensure that the locks
thrown by the cache manager are correct.
<P>
@@ -172,7 +172,7 @@ This interface describes an object desig
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>
</TABLE>
@@ -214,14 +214,14 @@ create</H3>
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 set of new objects to operate on and cache. This method is called only
- if the specified object(s) are NOT available in the cache. The specified objects
- should be created and returned; if they are not created, it means that the
+<DD>Create a set of new objects to operate on and cache. This method is called only
+ if the specified object(s) are NOT available in the cache. The specified objects
+ should be created and returned; if they are not created, it means that the
execution cannot proceed, and the execute() method will not be called.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>objectDescriptions</CODE> - is the set of unique identifier of the object.
-<DT><B>Returns:</B><DD>the newly created objects to cache, or null, if any object cannot be created.
+<DT><B>Returns:</B><DD>the newly created objects to cache, or null, if any object cannot be created.
The order of the returned objects must correspond to the order of the object descriptinos.
<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>
@@ -236,9 +236,9 @@ 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>
@@ -255,7 +255,7 @@ execute</H3>
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/interfaces/ICacheHandle.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ICacheHandle.html?rev=1345585&r1=1345584&r2=1345585&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ICacheHandle.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ICacheHandle.html Sat Jun 2 21:24:51 2012
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:07:58 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:29 EDT 2012 -->
<TITLE>
ICacheHandle
</TITLE>
@@ -99,7 +99,7 @@ Interface ICacheHandle</H2>
</PRE>
<P>
-This is a handle created by the cache manager, which describes the current status of a cache
+This is a handle created by the cache manager, which describes the current status of a cache
operation.
<P>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ICacheManager.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ICacheManager.html?rev=1345585&r1=1345584&r2=1345585&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ICacheManager.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/core/interfaces/ICacheManager.html Sat Jun 2 21:24:51 2012
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:07:58 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:29 EDT 2012 -->
<TITLE>
ICacheManager
</TITLE>
@@ -99,7 +99,7 @@ Interface ICacheManager</H2>
</PRE>
<P>
-This interface describes the functionality in the cache manager. It is not meant to have multiple implementations, but
+This interface describes the functionality in the cache manager. It is not meant to have multiple implementations, but
merely to provide general abstract cross-cluster cache management services.
<P>
@@ -176,7 +176,7 @@ This interface describes the functionali
java.lang.String transactionID)</CODE>
<BR>
- Locate or create a set of objects in the cached object pool, and/or destroy and invalidate
+ Locate or create a set of objects in the cached object pool, and/or destroy and invalidate
the same or other objects.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -281,29 +281,29 @@ void <B>findObjectsAndExecute</B>(<A HRE
java.lang.String transactionID)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Locate or create a set of objects in the cached object pool, and/or destroy and invalidate
- the same or other objects.
-
- For each "locate" object
- described below, one of two things will happen: the execObject's exists() method
- will be called (if the object exists in the cache already), or the execObject's create*()
- family of methods will be called. When all objects have been declared to the execObject,
- finally the execute() method will be called. In both cases, all objects are considered
- to be locked, and cannot be invalidated until the lock is cleared (after the end of the called method).
-
- For the invalidation descriptions, the execObject's destroy() method will be called instead.
- The object will be invalidated from the cache at the end of the findObjectsAndExecute() operation.
-
- It is perfectly legal to include an object that will be invalidated in the locate set!
-
- If an error occurs during object creation, the execute() method will NOT be called. If the
+<DD>Locate or create a set of objects in the cached object pool, and/or destroy and invalidate
+ the same or other objects.
+
+ For each "locate" object
+ described below, one of two things will happen: the execObject's exists() method
+ will be called (if the object exists in the cache already), or the execObject's create*()
+ family of methods will be called. When all objects have been declared to the execObject,
+ finally the execute() method will be called. In both cases, all objects are considered
+ to be locked, and cannot be invalidated until the lock is cleared (after the end of the called method).
+
+ For the invalidation descriptions, the execObject's destroy() method will be called instead.
+ The object will be invalidated from the cache at the end of the findObjectsAndExecute() operation.
+
+ It is perfectly legal to include an object that will be invalidated in the locate set!
+
+ If an error occurs during object creation, the execute() method will NOT be called. If the
execute() method has an error, the objects that were created will still be recorded in the cache.
<P>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>locateObjectDescriptions</CODE> - is a set of description objects that uniquely describe the objects needed.
- May be null if no objects are desired.<DD><CODE>invalidateKeys</CODE> - are the keys to invalidate after successful execution. May be null.<DD><CODE>execObject</CODE> - is the cache execution object whose create() or execute() methods will
- be called. May be null if no in-section logic is desired, and no objects are specified.<DD><CODE>transactionID</CODE> - is the current transaction identifier, or null. Objects created within this call
- will be associated with this transaction; they will be purged from the cache should the transaction
+<DT><B>Parameters:</B><DD><CODE>locateObjectDescriptions</CODE> - is a set of description objects that uniquely describe the objects needed.
+ May be null if no objects are desired.<DD><CODE>invalidateKeys</CODE> - are the keys to invalidate after successful execution. May be null.<DD><CODE>execObject</CODE> - is the cache execution object whose create() or execute() methods will
+ be called. May be null if no in-section logic is desired, and no objects are specified.<DD><CODE>transactionID</CODE> - is the current transaction identifier, or null. Objects created within this call
+ will be associated with this transaction; they will be purged from the cache should the transaction
be rolled back.
<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>
@@ -319,19 +319,19 @@ enterCache</H3>
java.lang.String transactionID)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Second way of doing cache management.
- Basically, this approach breaks the findObjectsAndExecute() method down into bite-sized chunks.
- The goal is additional flexibility, and an executor object does not need to be defined.
- Pretty much everything else is identical. The objects returned by the manager methods
- provide context control and enforce the proper ordering and nesting.
- This method enters the cacher and builds a cache handle. Once a cache handle is
- returned, the calling code MUST, under all circumstances, leave the cache using the
+<DD>Second way of doing cache management.
+ Basically, this approach breaks the findObjectsAndExecute() method down into bite-sized chunks.
+ The goal is additional flexibility, and an executor object does not need to be defined.
+ Pretty much everything else is identical. The objects returned by the manager methods
+ provide context control and enforce the proper ordering and nesting.
+ This method enters the cacher and builds a cache handle. Once a cache handle is
+ returned, the calling code MUST, under all circumstances, leave the cache using the
same handle.
<P>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>locateObjectDescriptions</CODE> - is a set of description objects that uniquely describe the objects needed.
- May be null if no objects are desired.<DD><CODE>invalidateKeys</CODE> - are the keys to invalidate after successful execution. May be null.<DD><CODE>transactionID</CODE> - is the current transaction identifier, or null. Objects created within this block
- will be associated with this transaction; they will be purged from the cache should the transaction
+<DT><B>Parameters:</B><DD><CODE>locateObjectDescriptions</CODE> - is a set of description objects that uniquely describe the objects needed.
+ May be null if no objects are desired.<DD><CODE>invalidateKeys</CODE> - are the keys to invalidate after successful execution. May be null.<DD><CODE>transactionID</CODE> - is the current transaction identifier, or null. Objects created within this block
+ will be associated with this transaction; they will be purged from the cache should the transaction
be rolled back.
<DT><B>Returns:</B><DD>a cache handle.
<DT><B>Throws:</B>
@@ -346,8 +346,8 @@ enterCreateSection</H3>
<A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ICacheCreateHandle.html" title="interface in org.apache.manifoldcf.core.interfaces">ICacheCreateHandle</A> <B>enterCreateSection</B>(<A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ICacheHandle.html" title="interface in org.apache.manifoldcf.core.interfaces">ICacheHandle</A> handle)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Enter a creation critical section. This insures that only one thread is
- creating the specified objects at a time. This MUST be paired with
+<DD>Enter a creation critical section. This insures that only one thread is
+ creating the specified objects at a time. This MUST be paired with
a leaveCreateSection() method call, whatever happens.
<P>
<DD><DL>
@@ -365,8 +365,8 @@ java.lang.Object <B>lookupObject</B>(<A
<A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ICacheDescription.html" title="interface in org.apache.manifoldcf.core.interfaces">ICacheDescription</A> objectDescription)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Lookup an object. Returns null if object not found. If it is found,
- object's LRU and expiration info are updated. The objectDescription passed
+<DD>Lookup an object. Returns null if object not found. If it is found,
+ object's LRU and expiration info are updated. The objectDescription passed
MUST be one of the ones specified in the enclosing enterCache() method.
<P>
<DD><DL>
@@ -385,7 +385,7 @@ void <B>saveObject</B>(<A HREF="../../..
java.lang.Object object)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Save a newly created object. The object MUST be one of those identified in the
+<DD>Save a newly created object. The object MUST be one of those identified in the
enterCache() method.
<P>
<DD><DL>
@@ -451,7 +451,7 @@ void <B>startTransaction</B>(java.lang.S
java.lang.String enclosingTransactionID)
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 cache transaction.
+<DD>Begin a cache transaction.
This keeps track of the relationship between objects cached within transactions.
<P>
<DD><DL>
@@ -468,9 +468,9 @@ commitTransaction</H3>
void <B>commitTransaction</B>(java.lang.String transactionID)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Commit a cache transaction.
- This method MUST be called when a transaction successfully ends, or open locks will not be closed!!!
- All cache activity that has taken place inside the transaction will be resolved, and the cache locks
+<DD>Commit a cache transaction.
+ This method MUST be called when a transaction successfully ends, or open locks will not be closed!!!
+ All cache activity that has taken place inside the transaction will be resolved, and the cache locks
held open will be released.
<P>
<DD><DL>
@@ -487,8 +487,8 @@ rollbackTransaction</H3>
void <B>rollbackTransaction</B>(java.lang.String transactionID)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Roll back a cache transaction.
- This method releases all objects cached against the ending transaction ID, and releases all locks
+<DD>Roll back a cache transaction.
+ This method releases all objects cached against the ending transaction ID, and releases all locks
held for the transaction.
<P>
<DD><DL>