Author: vgritsenko
Date: Fri Nov 3 21:12:50 2006
New Revision: 471121
URL: http://svn.apache.org/viewvc?view=rev&rev=471121
Log:
javadoc
Modified:
xml/xindice/trunk/java/src/org/apache/xindice/core/filer/BTreeFiler.java
xml/xindice/trunk/java/src/org/apache/xindice/core/filer/HashFiler.java
xml/xindice/trunk/java/src/org/apache/xindice/core/filer/Paged.java
Modified:
xml/xindice/trunk/java/src/org/apache/xindice/core/filer/BTreeFiler.java
URL:
http://svn.apache.org/viewvc/xml/xindice/trunk/java/src/org/apache/xindice/core/filer/BTreeFiler.java?view=diff&rev=471121&r1=471120&r2=471121
==============================================================================
--- xml/xindice/trunk/java/src/org/apache/xindice/core/filer/BTreeFiler.java
(original)
+++ xml/xindice/trunk/java/src/org/apache/xindice/core/filer/BTreeFiler.java
Fri Nov 3 21:12:50 2006
@@ -40,6 +40,25 @@
/**
* BTreeFiler is a Filer implementation based on the BTree class.
*
+ * <br>
+ * BTreeFiler has folowing configuration attributes:
+ * <ul>
+ * <li><strong>pagesize</strong>: Size of the page used by the filer.
+ * Default page size is 4096 bytes. This parameter can be set only
+ * before paged file is created. Once it is created, this parameter
+ * can not be changed.</li>
+ * <li><strong>pagecount</strong>: Number of pages filer will be created
+ * with.</li>
+ * <li><strong>maxkeysize</strong>: Maximum allowed size of the key.
+ * Default maximum key size is 256 bytes.</li>
+ * <li><strong>max-descriptors</strong>: Defines maximum amount of
+ * simultaneously opened file descriptors this paged file can have.
+ * Several descriptors are needed to provide multithreaded access
+ * to the underlying file. Too large number will limit amount of
+ * collections you can open. Default value is 16
+ * (DEFAULT_DESCRIPTORS_MAX).</li>
+ * </ul>
+ *
* @version $Revision$, $Date$
*/
public final class BTreeFiler extends BTree
Modified:
xml/xindice/trunk/java/src/org/apache/xindice/core/filer/HashFiler.java
URL:
http://svn.apache.org/viewvc/xml/xindice/trunk/java/src/org/apache/xindice/core/filer/HashFiler.java?view=diff&rev=471121&r1=471120&r2=471121
==============================================================================
--- xml/xindice/trunk/java/src/org/apache/xindice/core/filer/HashFiler.java
(original)
+++ xml/xindice/trunk/java/src/org/apache/xindice/core/filer/HashFiler.java Fri
Nov 3 21:12:50 2006
@@ -45,6 +45,28 @@
* quite a bit more flexibility in its ability to retreive blocks of
* data and allocate Record space.
*
+ * <br/>
+ * HashFile has folowing configuration attributes:
+ * <ul>
+ * <li><strong>pagesize</strong>: Size of the page used by the paged file.
+ * Default page size is 4096 bytes. This parameter can be set only
+ * before paged file is created. Once it is created, this parameter
+ * can not be changed.</li>
+ * <li><strong>pagecount</strong>: This parameter has a special meaning
+ * for HashFiler. This determines the size of the hash table main
+ * storage, which is equal to the number of pages filer will be
+ * created with. The default is 1024. Please note that if made
+ * too small, it will affect efficiency of the hash table.</li>
+ * <li><strong>maxkeysize</strong>: Maximum allowed size of the key.
+ * Default maximum key size is 256 bytes.</li>
+ * <li><strong>max-descriptors</strong>: Defines maximum amount of
+ * simultaneously opened file descriptors this paged file can have.
+ * Several descriptors are needed to provide multithreaded access
+ * to the underlying file. Too large number will limit amount of
+ * collections you can open. Default value is 16
+ * (DEFAULT_DESCRIPTORS_MAX).</li>
+ * </ul>
+ *
* @deprecated This class has been temporarily deprecated by BTreeFiler.
* @version $Revision$, $Date$
*/
Modified: xml/xindice/trunk/java/src/org/apache/xindice/core/filer/Paged.java
URL:
http://svn.apache.org/viewvc/xml/xindice/trunk/java/src/org/apache/xindice/core/filer/Paged.java?view=diff&rev=471121&r1=471120&r2=471121
==============================================================================
--- xml/xindice/trunk/java/src/org/apache/xindice/core/filer/Paged.java
(original)
+++ xml/xindice/trunk/java/src/org/apache/xindice/core/filer/Paged.java Fri Nov
3 21:12:50 2006
@@ -13,7 +13,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*
- * CVS $Id$
+ * $Id$
*/
package org.apache.xindice.core.filer;
@@ -53,12 +53,15 @@
* BTree class and the HashFiler. It provides flexible paged I/O and
* page caching functionality.
*
- * Page has folowing configuration attributes:
+ * <br>
+ * Paged has folowing configuration attributes:
* <ul>
* <li><strong>pagesize</strong>: Size of the page used by the paged file.
* Default page size is 4096 bytes. This parameter can be set only
* before paged file is created. Once it is created, this parameter
* can not be changed.</li>
+ * <li><strong>pagecount</strong>: Number of pages filer will be created
+ * with.</li>
* <li><strong>maxkeysize</strong>: Maximum allowed size of the key.
* Default maximum key size is 256 bytes.</li>
* <li><strong>max-descriptors</strong>: Defines maximum amount of
@@ -1036,7 +1039,7 @@
}
/**
- * The number of pages in primary storage.
+ * The number of pages in primary/initial storage.
* This method should be called only while initializing Paged, not
during normal processing.
*/
public synchronized final void setPageCount(long pageCount) {
@@ -1050,7 +1053,7 @@
}
/**
- * The number of total pages in the file.
+ * The number of used pages in the file.
* This method should be called only while initializing Paged, not
during normal processing.
*/
public synchronized final void setTotalCount(long totalCount) {
@@ -1063,7 +1066,7 @@
return this.totalCount++;
}
- /** The number of total pages in the file */
+ /** The number of used pages in the file */
public synchronized final long getTotalCount() {
return totalCount;
}
