ozonesortedset.java

Java的面向对象数据库系统的源代码

// You can redistribute this software and/or modify it under the terms of
// the Ozone Library License version 1 published by ozone-db.org.
//
// This file is
// Copyright (C) 2002-@year@ Leo Mekenkamp. All rights reserved.
// $Id: OzoneSortedSet.java,v 1.1 2002/10/24 15:41:16 per_nyfelt Exp $

package org.ozoneDB.collections;

import java.util.SortedSet;

/**
 * See the overall description on {@link org.ozoneDB.collections.OzoneCollection}.
 * @author <a href="mailto:ozoneATmekenkampD0Tcom">Leo Mekenkamp (mind the anti-sp@m)</a>
 */
public interface OzoneSortedSet extends OzoneSet, SortedSet {
    
    /**
     * <p>Returns a <code>SortedSet</code> that contains the same entries as this
     * persistent one; it is (by nature of the client-server enviromnent) always
     * a 'deep' copy of this <code>OzoneSortedSet</code>. I.e. the contents of 
     * this <code>OzoneSortedSet</code> instance are always copied to the client
     * by use of serialization.</p>
     * <p>Note that the difference of calling <code>iterator()</code>
     * compared to <code>getClientSortedSet().iterator()</code> is that in 
     * the first case you go through the real collection on the server and in 
     * the second case you go through a local copy on the client side.</p>
     */
    public SortedSet getClientSortedSet();
    
    /**
     * <p>Basically nothing more than a typecasted <code>HeadSet</code> method.
     * Because subsets are also <code>OzoneSortedSet</code>s, this method is
     * provided to do away with the need for a typecast.</p>
     */
    public OzoneSortedSet ozoneHeadSet(Object toElement);
    
    /**
     * <p>Basically nothing more than a typecasted <code>SubSet</code> method.
     * Because subsets are also <code>OzoneSortedSet</code>s, this method is
     * provided to do away with the need for a typecast.</p>
     */
    public OzoneSortedSet ozoneSubSet(Object fromElement, Object toElement);
    
    /**
     * <p>Basically nothing more than a typecasted <code>TailSet</code> method.</p>
     * Because subsets are also <code>OzoneSortedSet</code>s, this method is
     * provided to do away with the need for a typecast.</p>
     */
    public OzoneSortedSet ozoneTailSet(Object toElement);
    
}