ozonemap.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: OzoneMap.java,v 1.2 2003/01/27 17:41:36 leomekenkamp Exp $

package org.ozoneDB.collections;

import java.io.Serializable;
import java.util.Map;
import org.ozoneDB.OzoneRemote;

/**
 * See the overall description on {@link org.ozoneDB.collections.OzoneCollection}.
 * <br/>Although a <code>Map</code> is technically not a <code>Collection</code>,
 * there are enough similarities to justify placing the <code>OzoneMap</code>
 * and its derived classes and interfaces into the <code>org.ozoneDB.collections</code>
 * package.
 * @author <a href="mailto:ozoneATmekenkampD0Tcom">Leo Mekenkamp (mind the anti-sp@m)</a>
 */
public interface OzoneMap extends Map, OzoneRemote {
    
    public void clear(); /*update*/
    
    public Object put(Object key, Object value); /*update*/

    public void putAll(Map map); /*update*/
    
    public Object remove(Object key); /*update*/
    
    /**
     * <p>Returns a <code>Map</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>OzoneMap</code>. I.e. the contents of 
     * this <code>OzoneMap</code> instance are always copied to the client
     * by use of serialization.</p>
     */
    public Map getClientMap();
    
    /**
     * Basically nothing more than a typecasted call to <code>keySet()</code>, 
     * as key sets are ozone objects themselves.
     *
     * @return OzoneSet containing all keys in this map
     */
    public OzoneSet ozoneKeySet();
    
    /**
     * Basically nothing more than a typecasted call to <code>entrySet()</code>, 
     * as an entry set is an ozone objects ifself.
     *
     * @return OzoneSet containing all keys in this map
     */
    public OzoneSet ozoneEntrySet();
    
    /**
     * Basically nothing more than a typecasted call to <code>values()</code>, 
     * as the values collection is am ozone object itself.
     *
     * @return OzoneSet containing all keys in this map
     */
    public OzoneCollection ozoneValues();
    
    /**
     *
     * @author <a href="mailto:ozoneATmekenkampD0Tcom">Leo Mekenkamp (mind the anti-sp@m)</a>
     */
    interface Node extends Map.Entry, Serializable {

        public void setKey(Object key);

    }
    
}