org.integratedmodelling.api.persistence.IKbox Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of klab-api Show documentation
The newest version!
/*******************************************************************************
 *  Copyright (C) 2007, 2015:
 *  
 *    - Ferdinando Villa 
 *    - integratedmodelling.org
 *    - any other authors listed in @author annotations
 *
 *    All rights reserved. This file is part of the k.LAB software suite,
 *    meant to enable modular, collaborative, integrated 
 *    development of interoperable data and model components. For
 *    details, see http://integratedmodelling.org.
 *    
 *    This program is free software; you can redistribute it and/or
 *    modify it under the terms of the Affero General Public License 
 *    Version 3 or any later version.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but without any warranty; without even the implied warranty of
 *    merchantability or fitness for a particular purpose.  See the
 *    Affero General Public License for more details.
 *  
 *     You should have received a copy of the Affero General Public License
 *     along with this program; if not, write to the Free Software
 *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *     The license is also available at: https://www.gnu.org/licenses/agpl.html
 *******************************************************************************/
package org.integratedmodelling.api.persistence;

import java.util.List;

import org.integratedmodelling.exceptions.KlabException;

/**
 * Overhaul of the old semantically-driven kbox. An object persister that knows about semantics but
 * does not need it.
 * 
 * @author Ferd
 */
public interface IKbox {

    /**
     * Query kbox. The list returned should be read-only and of course implement lazy access. 
     * Sorting, grouping or any other query option should be specified within the query
     * object, using metadata or other strategy.
     * 
     * @param query
     * @return list of deserialized objects
     * @throws KlabException
     */
    public  List query(IQuery query, Class cls) throws KlabException;

    /**
     * Store object, return handle. Any object can be passed, as long as it can be
     * annotated. Return an ID that can be passed to retrieve() to reconstruct the
     * object.
     * 
     * @param o
     * @return id of serialized object
     * @throws KlabException
     */
    public abstract long store(Object o) throws KlabException;

//    /**
//     * Retrieve the object pointed to by this id, or null if it's not there.
//     * 
//     * @param id
//     * @return deserialized object or null
//     * @throws KlabException
//     */
//    public abstract Object retrieve(long id) throws KlabException;

    /**
     * Remove object identified by handle
     * 
     * @param id
     * @throws KlabException
     */
    public abstract void remove(long id) throws KlabException;

    /**
     * Remove all objects matching the query.
     * 
     * @param query
     * @throws KlabException 
     */
    public abstract void remove(IQuery query) throws KlabException;

    /**
     * Remove everything in kbox.
     * 
     * @throws KlabException
     */
    public abstract void clear() throws KlabException;

     T retrieve(long id, Class cls) throws KlabException;

}