REInterface.java

Go to the documentation of this file.

/* \file REInterface.java
 * \brief Interface definition for the RoboEarth DB
 *
 * The interface definition for interacting with the RoboEarth DB. It provides 
 * means to download/upload/update/delete/query action recipes, object models 
 * and environments.
 * 
 * This file is part of the RoboEarth ROS re_comm_core package.
 * 
 * It was originally created for <a href="http://www.roboearth.org/">RoboEarth</a>.
 * The research leading to these results has received funding from the 
 * European Union Seventh Framework Programme FP7/2007-2013 
 * under grant agreement no248942 RoboEarth.
 *
 * Copyright (C) 2010 by 
 * <a href=" mailto:perzylo@cs.tum.edu">Alexander Perzylo</a>
 * Technische Universitaet Muenchen
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 *    <UL>
 *     <LI> Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     <LI> Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     <LI> Neither the name of Willow Garage, Inc. nor the names of its
 *       contributors may be used to endorse or promote products derived from
 *       this software without specific prior written permission.
 *    </UL>
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * \author Alexander Perzylo
 * \version 1.0
 * \date 2010
 * \image html http://www.roboearth.org/sites/default/files/RoboEarth.org_logo.gif
 * \image latex http://www.roboearth.org/sites/default/files/RoboEarth.org_logo.gif
 */
package roboearth.wp5.conn;

import java.io.File;
import java.util.ArrayList;

import org.semanticweb.owlapi.model.OWLOntology;

public interface REInterface {

        public String requestActionRecipe(String uid);

        public String requestEnvironment(String uid, ArrayList<String> outFilenames, 
                        ArrayList<String> outFileURLs);

        public String requestObject(String uid, ArrayList<String> outFilenames, 
                        ArrayList<String> outFileURLs);
        
        public String requestRobot(String uid);
        
        public File requestObjectBinaryFile(String objectUID, String filename, String targetPath);

        public byte[] requestObjectBinaryFile(String objectUID, String filename);
        
        public File requestEnvironmentBinaryFile(String envUID, String filename, String targetPath);
        
        public byte[] requestEnvironmentBinaryFile(String envUID, String filename);
        
        public boolean submitActionRecipe(OWLOntology actionRecipe,
                        String cls, String id, String description);     
        
        public boolean submitActionRecipe(String actionRecipe,
                        String cls, String id, String description);

        public boolean submitEnvironment(OWLOntology env, String cls, String id,
                        String description);

        @Deprecated
        public boolean submitEnvironment(OWLOntology env, String cls, String id, 
                        String description, ArrayList<File> binaryFiles);
        
        @Deprecated
        public boolean submitEnvironment(OWLOntology env, String cls, String id, 
                        String description, ArrayList<byte[]> binaryData, 
                        ArrayList<String> filenames);
        
        public boolean submitEnvironment(String env, String cls, String id,
                        String description);

        public boolean submitEnvironment(String env, String cls, String id, 
                        String description, ArrayList<File> binaryFiles);
        
        public boolean submitEnvironment(String env, String cls, String id, 
                        String description, ArrayList<byte[]> binaryData, 
                        ArrayList<String> filenames);

        public boolean submitObject(OWLOntology objectOwl, String cls, String id, 
                        String description);
        
        public boolean submitObject(String objectOwl, String cls, String id, 
                        String description);

        public boolean submitObject(OWLOntology objectOwl, String cls, String id, 
                        String description, ArrayList<File> binaryFiles);
        
        public boolean submitObject(String objectOwl, String cls, String id, 
                        String description, ArrayList<File> binaryFiles);

        public boolean submitObject(OWLOntology objectOwl, String cls, String id, 
                        String description, ArrayList<byte[]> binaryData, 
                        ArrayList<String> filenames);
        
        public boolean submitObject(String objectOwl, String cls, String id, 
                        String description, ArrayList<byte[]> binaryData, 
                        ArrayList<String> filenames);
        
        public boolean submitObjectBinaryFile(String uid, File file);

        public boolean submitObjectBinaryFile(String uid, byte[] data, String filename);
        
        public boolean submitEnvironmentBinaryFile(String uid, File file);
        
        public boolean submitEnvironmentBinaryFile(String uid, byte[] data, String filename);
        
        public boolean deleteActionRecipe(String uid);

        public boolean deleteEnvironment(String uid);

        public boolean deleteObject(String uid);

        public boolean deleteObjectBinaryFile(String uid, String filename);
        
        public boolean deleteEnvironmentBinaryFile(String uid, String filename);
        
        public String[] searchActionRecipes(String searchID, ArrayList<String> outUIDs);
        
        public String[] searchEnvironments(String searchID, ArrayList<String> outUIDs, 
                        ArrayList<ArrayList<String>> outFilenames, 
                        ArrayList<ArrayList<String>> outFileURLs);
        
        public String[] searchObjects(String searchID, ArrayList<String> outUIDs, 
                        ArrayList<ArrayList<String>> outFilenames, 
                        ArrayList<ArrayList<String>> outFileURLs);
        
        public String queryActionRecipeDB(String seRQLquery);

        public String queryEnvironmentDB(String seRQLquery);
        
        public String queryObjectDB(String seRQLquery);

        public boolean updateActionRecipe(String uid, OWLOntology actionRecipe, String description);

        public boolean updateActionRecipe(String uid, String actionRecipe, String description);

        public boolean updateEnvironment(String uid, OWLOntology env, String description);

        public boolean updateEnvironment(String uid, String env, String description);

        public boolean updateObject(String uid, OWLOntology objectOwl, String description);

        public boolean updateObject(String uid, String objectOwl, String description);
        
        public boolean updateObjectBinaryFile(String uid, File file);
        
        public boolean updateObjectBinaryFile(String uid, byte[] data, String filename);
        
        public boolean updateEnvironmentBinaryFile(String uid, File file);
        
        public boolean updateEnvironmentBinaryFile(String uid, byte[] data, String filename);

        
        public ArrayList<byte[]> request2dMap(String envUid, OWLOntology srdl, String baseScannerLink, String simpleMapNameWithoutExt);
        public ArrayList<byte[]> requestProjected2dMap(String envUid, double minZ, double maxZ, String simpleMapNameWithoutExt);

}