mirror of
https://github.com/ChronosX88/FreePastry.git
synced 2025-01-16 01:26:27 +00:00
554 lines
23 KiB
HTML
554 lines
23 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!--NewPage-->
|
|
<HTML>
|
|
<HEAD>
|
|
<!-- Generated by javadoc (build 1.6.0_07) on Fri Mar 13 20:01:03 CET 2009 -->
|
|
<TITLE>
|
|
Catalog (Rice Pastry - API Specifications)
|
|
</TITLE>
|
|
|
|
<META NAME="date" CONTENT="2009-03-13">
|
|
|
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
|
|
|
<SCRIPT type="text/javascript">
|
|
function windowTitle()
|
|
{
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
|
parent.document.title="Catalog (Rice Pastry - API Specifications)";
|
|
}
|
|
}
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
</NOSCRIPT>
|
|
|
|
</HEAD>
|
|
|
|
<BODY BGCOLOR="white" onload="windowTitle();">
|
|
<HR>
|
|
|
|
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<A NAME="navbar_top"><!-- --></A>
|
|
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
|
<TR>
|
|
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
<A NAME="navbar_top_firstrow"><!-- --></A>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
|
<TR ALIGN="center" VALIGN="top">
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Catalog.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
Rice Pastry API</EM>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../rice/persistence/Cache.html" title="interface in rice.persistence"><B>PREV CLASS</B></A>
|
|
<A HREF="../../rice/persistence/EmptyCache.html" title="class in rice.persistence"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../index.html?rice/persistence/Catalog.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="Catalog.html" target="_top"><B>NO FRAMES</B></A>
|
|
<SCRIPT type="text/javascript">
|
|
<!--
|
|
if(window==top) {
|
|
document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
|
|
}
|
|
//-->
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
|
|
</NOSCRIPT>
|
|
|
|
|
|
</FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="skip-navbar_top"></A>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
|
|
<HR>
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<H2>
|
|
<FONT SIZE="-1">
|
|
rice.persistence</FONT>
|
|
<BR>
|
|
Interface Catalog</H2>
|
|
<DL>
|
|
<DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../rice/persistence/Cache.html" title="interface in rice.persistence">Cache</A>, <A HREF="../../rice/persistence/Storage.html" title="interface in rice.persistence">Storage</A>, <A HREF="../../rice/persistence/StorageManager.html" title="interface in rice.persistence">StorageManager</A></DD>
|
|
</DL>
|
|
<DL>
|
|
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../rice/persistence/EmptyCache.html" title="class in rice.persistence">EmptyCache</A>, <A HREF="../../rice/persistence/LRUCache.html" title="class in rice.persistence">LRUCache</A>, <A HREF="../../rice/persistence/MemoryStorage.html" title="class in rice.persistence">MemoryStorage</A>, <A HREF="../../rice/persistence/PersistentStorage.html" title="class in rice.persistence">PersistentStorage</A>, <A HREF="../../rice/persistence/StorageManagerImpl.html" title="class in rice.persistence">StorageManagerImpl</A></DD>
|
|
</DL>
|
|
<HR>
|
|
<DL>
|
|
<DT><PRE>public interface <B>Catalog</B></DL>
|
|
</PRE>
|
|
|
|
<P>
|
|
This interface is the abstraction of something which holds objects
|
|
which are available for lookup. This interface does not, however,
|
|
specify how the objects are inserted, and makes NO guarantees as to
|
|
whether objects available at a given point in time will be available
|
|
at a later time.
|
|
|
|
Implementations of the Catalog interface are designed to be interfaces
|
|
which specify how objects are inserted and stored, and are designed to
|
|
include a cache and persistent storage interface.
|
|
<P>
|
|
|
|
<P>
|
|
<HR>
|
|
|
|
<P>
|
|
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
|
|
<A NAME="method_summary"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|
<B>Method Summary</B></FONT></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> boolean</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../rice/persistence/Catalog.html#exists(rice.p2p.commonapi.Id)">exists</A></B>(<A HREF="../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> id)</CODE>
|
|
|
|
<BR>
|
|
Returns whether or not an object is present in the location <code>id</code>.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../rice/persistence/Catalog.html#flush(rice.Continuation)">flush</A></B>(<A HREF="../../rice/Continuation.html" title="interface in rice">Continuation</A> c)</CODE>
|
|
|
|
<BR>
|
|
Method which is used to erase all data stored in the Catalog.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> java.io.Serializable</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../rice/persistence/Catalog.html#getMetadata(rice.p2p.commonapi.Id)">getMetadata</A></B>(<A HREF="../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> id)</CODE>
|
|
|
|
<BR>
|
|
Returns the metadata associated with the provided object, or null if
|
|
no metadata exists.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../rice/persistence/Catalog.html#getObject(rice.p2p.commonapi.Id, rice.Continuation)">getObject</A></B>(<A HREF="../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> id,
|
|
<A HREF="../../rice/Continuation.html" title="interface in rice">Continuation</A> c)</CODE>
|
|
|
|
<BR>
|
|
Returns the object identified by the given id, or <code>null</code> if
|
|
there is no corresponding object (through receiveResult on c).</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> int</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../rice/persistence/Catalog.html#getSize()">getSize</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Returns the number of Ids currently stored in the catalog</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> long</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../rice/persistence/Catalog.html#getTotalSize()">getTotalSize</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Returns the total size of the stored data in bytes.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../rice/persistence/Catalog.html#rename(rice.p2p.commonapi.Id, rice.p2p.commonapi.Id, rice.Continuation)">rename</A></B>(<A HREF="../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> oldId,
|
|
<A HREF="../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> newId,
|
|
<A HREF="../../rice/Continuation.html" title="interface in rice">Continuation</A> c)</CODE>
|
|
|
|
<BR>
|
|
Renames the given object to the new id.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../rice/p2p/commonapi/IdSet.html" title="interface in rice.p2p.commonapi">IdSet</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../rice/persistence/Catalog.html#scan()">scan</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return all objects currently stored by this catalog
|
|
|
|
NOTE: This method blocks so if the behavior of this method changes and
|
|
no longer stored in memory, this method may be deprecated.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../rice/p2p/commonapi/IdSet.html" title="interface in rice.p2p.commonapi">IdSet</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../rice/persistence/Catalog.html#scan(rice.p2p.commonapi.IdRange)">scan</A></B>(<A HREF="../../rice/p2p/commonapi/IdRange.html" title="interface in rice.p2p.commonapi">IdRange</A> range)</CODE>
|
|
|
|
<BR>
|
|
Return the objects identified by the given range of ids.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> java.util.SortedMap</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../rice/persistence/Catalog.html#scanMetadata()">scanMetadata</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Returns a map which contains keys mapping ids to the associated
|
|
metadata.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> java.util.SortedMap</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../rice/persistence/Catalog.html#scanMetadata(rice.p2p.commonapi.IdRange)">scanMetadata</A></B>(<A HREF="../../rice/p2p/commonapi/IdRange.html" title="interface in rice.p2p.commonapi">IdRange</A> range)</CODE>
|
|
|
|
<BR>
|
|
Returns a map which contains keys mapping ids to the associated
|
|
metadata.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> java.util.SortedMap</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../rice/persistence/Catalog.html#scanMetadataValuesHead(java.lang.Object)">scanMetadataValuesHead</A></B>(java.lang.Object value)</CODE>
|
|
|
|
<BR>
|
|
Returns the submapping of ids which have metadata less than the provided
|
|
value.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> java.util.SortedMap</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../rice/persistence/Catalog.html#scanMetadataValuesNull()">scanMetadataValuesNull</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Returns the submapping of ids which have metadata null</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../rice/persistence/Catalog.html#setMetadata(rice.p2p.commonapi.Id, java.io.Serializable, rice.Continuation)">setMetadata</A></B>(<A HREF="../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> id,
|
|
java.io.Serializable metadata,
|
|
<A HREF="../../rice/Continuation.html" title="interface in rice">Continuation</A> command)</CODE>
|
|
|
|
<BR>
|
|
Updates the metadata stored under the given key to be the provided
|
|
value.</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<P>
|
|
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
|
|
<A NAME="method_detail"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
|
<B>Method Detail</B></FONT></TH>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<A NAME="exists(rice.p2p.commonapi.Id)"><!-- --></A><H3>
|
|
exists</H3>
|
|
<PRE>
|
|
boolean <B>exists</B>(<A HREF="../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> id)</PRE>
|
|
<DL>
|
|
<DD>Returns whether or not an object is present in the location <code>id</code>.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>id</CODE> - The id of the object in question.
|
|
<DT><B>Returns:</B><DD>Whether or not an object is present at id.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getObject(rice.p2p.commonapi.Id, rice.Continuation)"><!-- --></A><H3>
|
|
getObject</H3>
|
|
<PRE>
|
|
void <B>getObject</B>(<A HREF="../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> id,
|
|
<A HREF="../../rice/Continuation.html" title="interface in rice">Continuation</A> c)</PRE>
|
|
<DL>
|
|
<DD>Returns the object identified by the given id, or <code>null</code> if
|
|
there is no corresponding object (through receiveResult on c).
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>id</CODE> - The id of the object in question.<DD><CODE>c</CODE> - The command to run once the operation is complete</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getMetadata(rice.p2p.commonapi.Id)"><!-- --></A><H3>
|
|
getMetadata</H3>
|
|
<PRE>
|
|
java.io.Serializable <B>getMetadata</B>(<A HREF="../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> id)</PRE>
|
|
<DL>
|
|
<DD>Returns the metadata associated with the provided object, or null if
|
|
no metadata exists. The metadata must be stored in memory, so this
|
|
operation is guaranteed to be fast and non-blocking.
|
|
|
|
The metadata returned from this method must *NOT* be mutated in any way,
|
|
as the actual reference to the internal object is returned. Mutating
|
|
this metadata may make the internal indices incorrect, resulting
|
|
in undefined behavior. Changing the metadata should be done by creating
|
|
a new metadata object and calling setMetadata().
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>id</CODE> - The id for which the metadata is needed
|
|
<DT><B>Returns:</B><DD>The metadata, or null if none exists</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setMetadata(rice.p2p.commonapi.Id, java.io.Serializable, rice.Continuation)"><!-- --></A><H3>
|
|
setMetadata</H3>
|
|
<PRE>
|
|
void <B>setMetadata</B>(<A HREF="../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> id,
|
|
java.io.Serializable metadata,
|
|
<A HREF="../../rice/Continuation.html" title="interface in rice">Continuation</A> command)</PRE>
|
|
<DL>
|
|
<DD>Updates the metadata stored under the given key to be the provided
|
|
value. As this may require a disk access, the requestor must
|
|
also provide a continuation to return the result to.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>id</CODE> - The id for the metadata<DD><CODE>metadata</CODE> - The metadata to store<DD><CODE>c</CODE> - The command to run once the operation is complete</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="rename(rice.p2p.commonapi.Id, rice.p2p.commonapi.Id, rice.Continuation)"><!-- --></A><H3>
|
|
rename</H3>
|
|
<PRE>
|
|
void <B>rename</B>(<A HREF="../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> oldId,
|
|
<A HREF="../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> newId,
|
|
<A HREF="../../rice/Continuation.html" title="interface in rice">Continuation</A> c)</PRE>
|
|
<DL>
|
|
<DD>Renames the given object to the new id. This method is potentially faster
|
|
than store/cache and unstore/uncache.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>oldId</CODE> - The id of the object in question.<DD><CODE>newId</CODE> - The new id of the object in question.<DD><CODE>c</CODE> - The command to run once the operation is complete</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="scan(rice.p2p.commonapi.IdRange)"><!-- --></A><H3>
|
|
scan</H3>
|
|
<PRE>
|
|
<A HREF="../../rice/p2p/commonapi/IdSet.html" title="interface in rice.p2p.commonapi">IdSet</A> <B>scan</B>(<A HREF="../../rice/p2p/commonapi/IdRange.html" title="interface in rice.p2p.commonapi">IdRange</A> range)</PRE>
|
|
<DL>
|
|
<DD>Return the objects identified by the given range of ids. The IdSet
|
|
returned contains the Ids of the stored objects. The range is
|
|
partially inclusive, the lower range is inclusive, and the upper
|
|
exclusive.
|
|
|
|
NOTE: This method blocks so if the behavior of this method changes and
|
|
no longer stored in memory, this method may be deprecated.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>range</CODE> - The range to query
|
|
<DT><B>Returns:</B><DD>The idset containing the keys</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="scan()"><!-- --></A><H3>
|
|
scan</H3>
|
|
<PRE>
|
|
<A HREF="../../rice/p2p/commonapi/IdSet.html" title="interface in rice.p2p.commonapi">IdSet</A> <B>scan</B>()</PRE>
|
|
<DL>
|
|
<DD>Return all objects currently stored by this catalog
|
|
|
|
NOTE: This method blocks so if the behavior of this method changes and
|
|
no longer stored in memory, this method may be deprecated.
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The idset containing the keys</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="scanMetadata(rice.p2p.commonapi.IdRange)"><!-- --></A><H3>
|
|
scanMetadata</H3>
|
|
<PRE>
|
|
java.util.SortedMap <B>scanMetadata</B>(<A HREF="../../rice/p2p/commonapi/IdRange.html" title="interface in rice.p2p.commonapi">IdRange</A> range)</PRE>
|
|
<DL>
|
|
<DD>Returns a map which contains keys mapping ids to the associated
|
|
metadata.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>range</CODE> - The range to query
|
|
<DT><B>Returns:</B><DD>The map containing the keys</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="scanMetadata()"><!-- --></A><H3>
|
|
scanMetadata</H3>
|
|
<PRE>
|
|
java.util.SortedMap <B>scanMetadata</B>()</PRE>
|
|
<DL>
|
|
<DD>Returns a map which contains keys mapping ids to the associated
|
|
metadata.
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The treemap mapping ids to metadata</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="scanMetadataValuesHead(java.lang.Object)"><!-- --></A><H3>
|
|
scanMetadataValuesHead</H3>
|
|
<PRE>
|
|
java.util.SortedMap <B>scanMetadataValuesHead</B>(java.lang.Object value)</PRE>
|
|
<DL>
|
|
<DD>Returns the submapping of ids which have metadata less than the provided
|
|
value.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>value</CODE> - The maximal metadata value
|
|
<DT><B>Returns:</B><DD>The submapping</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="scanMetadataValuesNull()"><!-- --></A><H3>
|
|
scanMetadataValuesNull</H3>
|
|
<PRE>
|
|
java.util.SortedMap <B>scanMetadataValuesNull</B>()</PRE>
|
|
<DL>
|
|
<DD>Returns the submapping of ids which have metadata null
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The submapping</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getSize()"><!-- --></A><H3>
|
|
getSize</H3>
|
|
<PRE>
|
|
int <B>getSize</B>()</PRE>
|
|
<DL>
|
|
<DD>Returns the number of Ids currently stored in the catalog
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The number of ids in the catalog</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getTotalSize()"><!-- --></A><H3>
|
|
getTotalSize</H3>
|
|
<PRE>
|
|
long <B>getTotalSize</B>()</PRE>
|
|
<DL>
|
|
<DD>Returns the total size of the stored data in bytes.
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The total storage size</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="flush(rice.Continuation)"><!-- --></A><H3>
|
|
flush</H3>
|
|
<PRE>
|
|
void <B>flush</B>(<A HREF="../../rice/Continuation.html" title="interface in rice">Continuation</A> c)</PRE>
|
|
<DL>
|
|
<DD>Method which is used to erase all data stored in the Catalog.
|
|
Use this method with care!
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>c</CODE> - The command to run once done</DL>
|
|
</DD>
|
|
</DL>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<HR>
|
|
|
|
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<A NAME="navbar_bottom"><!-- --></A>
|
|
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
|
<TR>
|
|
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
|
<TR ALIGN="center" VALIGN="top">
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Catalog.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
Rice Pastry API</EM>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../rice/persistence/Cache.html" title="interface in rice.persistence"><B>PREV CLASS</B></A>
|
|
<A HREF="../../rice/persistence/EmptyCache.html" title="class in rice.persistence"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../index.html?rice/persistence/Catalog.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="Catalog.html" target="_top"><B>NO FRAMES</B></A>
|
|
<SCRIPT type="text/javascript">
|
|
<!--
|
|
if(window==top) {
|
|
document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
|
|
}
|
|
//-->
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
|
|
</NOSCRIPT>
|
|
|
|
|
|
</FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="skip-navbar_bottom"></A>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
|
|
<HR>
|
|
<i>Copyright © 2001-2005 - Rice Pastry.</i>
|
|
</BODY>
|
|
</HTML>
|