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

   1 /*
   2  * The Apache Software License, Version 1.1
   3  *
   4  *
   5  * Copyright (c) 1999 The Apache Software Foundation.  All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  *
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in
  16  *    the documentation and/or other materials provided with the
  17  *    distribution.
  18  *
  19  * 3. The end-user documentation included with the redistribution,
  20  *    if any, must include the following acknowledgment:
  21  *       "This product includes software developed by the
  22  *        Apache Software Foundation (http://www.apache.org/)."
  23  *    Alternately, this acknowledgment may appear in the software itself,
  24  *    if and wherever such third-party acknowledgments normally appear.
  25  *
  26  * 4. The names "Xindice" and "Apache Software Foundation" must
  27  *    not be used to endorse or promote products derived from this
  28  *    software without prior written permission. For written
  29  *    permission, please contact apache@apache.org.
  30  *
  31  * 5. Products derived from this software may not be called "Apache",
  32  *    nor may "Apache" appear in their name, without prior written
  33  *    permission of the Apache Software Foundation.
  34  *
  35  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  36  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  37  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  38  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  39  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  42  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  43  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  44  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  45  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46  * SUCH DAMAGE.
  47  * ====================================================================
  48  *
  49  * This software consists of voluntary contributions made by many
  50  * individuals on behalf of the Apache Software Foundation and was
  51  * originally based on software copyright (c) 1999-2001, The dbXML
  52  * Group, L.L.C., http://www.dbxmlgroup.com.  For more
  53  * information on the Apache Software Foundation, please see
  54  * <http://www.apache.org/>.
  55  *
  56  */
  57 package net.jxta.impl.xindice.core.filer;
  58
  59 import net.jxta.impl.xindice.core.DBException;
  60 import net.jxta.impl.xindice.core.DBObject;
  61 import net.jxta.impl.xindice.core.data.Key;
  62 import net.jxta.impl.xindice.core.data.Record;
  63 import net.jxta.impl.xindice.core.data.RecordSet;
  64 import net.jxta.impl.xindice.core.data.Value;
  65 import net.jxta.impl.xindice.util.Named;
  66
  67 /**
  68  * Filer is the low-level file management interface for Xindice.  A Filer object
  69  * is implemented in order to provide a data source to the Xindice Collection
  70  * class.  Filers are developed to perform transparent storage and retrieval to
  71  * and from heterogenous data sources (such as FTP, HTTP, RDBMS, etc...)
  72  */
  73 public interface Filer extends Named, DBObject {
  74
  75     /**
  76      * readRecord returns a Record from the Filer based on the specified
  77      * Key.
  78      *
  79      * @param key The Record's Key
  80      * @return The returned Record
  81      * @throws net.jxta.impl.xindice.core.DBException if a db exception occurs
  82      */
  83     Record readRecord(Key key) throws DBException;
  84
  85     /**
  86      * readRecord returns a Record from the Filer at the specified
  87      * position. The Record's Key will be set to null.
  88      *
  89      * @param pos The Record's position
  90      * @return The returned Record
  91      * @throws net.jxta.impl.xindice.core.DBException if a db exception occurs
  92      */
  93     Record readRecord(long pos) throws DBException;
  94
  95     /**
  96      * writeRecord writes a Value to the Filer based on the specified Key.
  97      *
  98      * @param key The Record's Key
  99      * @param value The Record's Value
 100      * @return 0 if the Record could not be written, the starting
 101      * offset of the Record otherwise (used for indexing)
 102      * @throws net.jxta.impl.xindice.core.DBException if a db exception occurs
 103      */
 104     long writeRecord(Key key, Value value) throws DBException;
 105
 106     /**
 107      * deleteRecord removes a Record from the Filer based on the
 108      * specified Key.
 109      *
 110      * @param key The Record's Key
 111      * @return Whether or not the Record was deleted
 112      * @throws net.jxta.impl.xindice.core.DBException if a db exception occurs
 113      */
 114     boolean deleteRecord(Key key) throws DBException;
 115
 116     /**
 117      * getRecordCount returns the number of Records in the Filer.
 118      *
 119      * @return The Record count
 120      * @throws net.jxta.impl.xindice.core.DBException if a db exception occurs
 121      */
 122     long getRecordCount() throws DBException;
 123
 124     /**
 125      * getRecordSet returns a RecordSet object for the current Filer.
 126      *
 127      * @return The Filer Enumerator
 128      * @throws net.jxta.impl.xindice.core.DBException if a db exception occurs
 129      */
 130     RecordSet getRecordSet() throws DBException;
 131
 132     /**
 133      * flush forcefully flushes any unwritten buffers to disk.
 134      * @throws net.jxta.impl.xindice.core.DBException if a db exception occurs
 135      */
 136     void flush() throws DBException;
 137 }