sjero.net Git - linphone/blob - p2pproxy/dependencies-src/jxse-src-2.5/impl/src/net/jxta/impl/xindice/core/data/RecordSet.java

   1 package net.jxta.impl.xindice.core.data;
   2
   3
   4 /*
   5  * The Apache Software License, Version 1.1
   6  *
   7  *
   8  * Copyright (c) 1999 The Apache Software Foundation.  All rights reserved.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  *
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  *
  17  * 2. Redistributions in binary form must reproduce the above copyright
  18  *    notice, this list of conditions and the following disclaimer in
  19  *    the documentation and/or other materials provided with the
  20  *    distribution.
  21  *
  22  * 3. The end-user documentation included with the redistribution,
  23  *    if any, must include the following acknowledgment:
  24  *       "This product includes software developed by the
  25  *        Apache Software Foundation (http://www.apache.org/)."
  26  *    Alternately, this acknowledgment may appear in the software itself,
  27  *    if and wherever such third-party acknowledgments normally appear.
  28  *
  29  * 4. The names "Xindice" and "Apache Software Foundation" must
  30  *    not be used to endorse or promote products derived from this
  31  *    software without prior written permission. For written
  32  *    permission, please contact apache@apache.org.
  33  *
  34  * 5. Products derived from this software may not be called "Apache",
  35  *    nor may "Apache" appear in their name, without prior written
  36  *    permission of the Apache Software Foundation.
  37  *
  38  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  39  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  40  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  41  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  42  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  43  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  44  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  45  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  46  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  47  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  48  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  49  * SUCH DAMAGE.
  50  * ====================================================================
  51  *
  52  * This software consists of voluntary contributions made by many
  53  * individuals on behalf of the Apache Software Foundation and was
  54  * originally based on software copyright (c) 1999-2001, The dbXML
  55  * Group, L.L.C., http://www.dbxmlgroup.com.  For more
  56  * information on the Apache Software Foundation, please see
  57  * <http://www.apache.org/>.
  58  *
  59  */
  60
  61 import net.jxta.impl.xindice.core.DBException;
  62
  63 /**
  64  * RecordSet is an interface for iterating over a set of Records.
  65  * It is almost always returned by Filers.
  66  */
  67 public interface RecordSet {
  68
  69     /**
  70      * hasMoreRecords returns whether or not there are any Records
  71      * left in the set.
  72      *
  73      * @return Whether there are any more Records
  74      * @throws net.jxta.impl.xindice.core.filer.BTreeException if a DB exception occurs
  75      */
  76     boolean hasMoreRecords() throws DBException;
  77
  78     /**
  79      * getNextRecord returns the next Record in the set.
  80      *
  81      * @return The next Record
  82      * @throws net.jxta.impl.xindice.core.filer.BTreeException if a DB exception occurs
  83      */
  84     Record getNextRecord() throws DBException;
  85
  86     /**
  87      * getNextKey returns the next Record's Key, and skips the
  88      * RecordSet ahead to the next Record.
  89      *
  90      * @return The next Key
  91      * @throws net.jxta.impl.xindice.core.filer.BTreeException if a DB exception occurs
  92      */
  93     Key getNextKey() throws DBException;
  94
  95     /**
  96      * getNextValue returns the next Record's Value, and skips the
  97      * RecordSet ahead to the next Record.
  98      *
  99      * @return The next Value
 100      * @throws net.jxta.impl.xindice.core.filer.BTreeException if a DB exception occurs
 101      */
 102     Value getNextValue() throws DBException;
 103 }