org.bigml.binding.resources.Project Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bigml-binding Show documentation
An open source Java client that gives you a simple binding to interact with BigML. You can use it to easily create, retrieve, list, update, and delete BigML resources.
There is a newer version: 2.1.1
Show newest version
package org.bigml.binding.resources;

import org.bigml.binding.BigMLClient;
import org.bigml.binding.utils.CacheManager;
import org.json.simple.JSONObject;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * This class is used by the BigML class as a mixin that provides the Project' REST calls.
 *
 * It should not be instantiated independently.
 *
 * Full API documentation on the API can be found from BigML at:
 * https://bigml.com/api/project
 *
 *
 */
public class Project extends AbstractResource {

    // Logging
    Logger logger = LoggerFactory.getLogger(Project.class);
    
    /**
     * Constructor
     *
     * @deprecated
     */
	public Project() {
		super.init(null, null, null, null, null, 
				PROJECT_RE, PROJECT_PATH);
	}

	/**
	 * Constructor
	 *
	 * @deprecated
	 */
	public Project(final String apiUser, final String apiKey) {
		super.init(apiUser, apiKey, null, null, null, 
				PROJECT_RE, PROJECT_PATH);
	}
	
	/**
	 * Constructor
	 *
	 * @deprecated
	 */
	public Project(final String apiUser, final String apiKey,
			final CacheManager cacheManager) {
		super.init(apiUser, apiKey, null, null, null, 
				PROJECT_RE, PROJECT_PATH);
	}
	
    /**
     * Constructor
     *
     */
    public Project(final BigMLClient bigmlClient,
    			   final String apiUser, final String apiKey, 
    			   final String project, final String organization,
    			   final CacheManager cacheManager) {
    		super.init(bigmlClient, apiUser, apiKey, project, organization,
    				   cacheManager, PROJECT_RE, PROJECT_PATH);
    }

    /**
     * Creates a project.
     *
     * Uses a remote resource to create a new project using the
     * arguments in `args`.
     *
     * If `wait_time` is higher than 0 then the project creation
     * request is not sent until the `sample` has been created successfuly.
     *
     * @param args
     *            set of parameters for the new project. Optional
     *
     */
    public JSONObject create(JSONObject args) {

        try {
            JSONObject requestObject = new JSONObject();
            requestObject.putAll(args);
            return createResource(resourceUrl, 
            		requestObject.toJSONString());
        } catch (Throwable e) {
            logger.error("Failed to generate the project.", e);
            return null;
        }
    }

    /**
     * Retrieves an project.
     *
     * GET /andromeda/project/id?username=$BIGML_USERNAME;api_key=$BIGML_API_KEY;
     * Host: bigml.io
     *
     * @param projectId
     *            a unique identifier in the form project/id where id is a string
     *            of 24 alpha-numeric chars.
     * @param queryString
     *            query for filtering.
     * @param apiUser
     *            API user
     * @param apiKey
     *            API key
     *
     */
    public JSONObject get(final String projectId, final String queryString,
                          final String apiUser, final String apiKey) {
        if (projectId == null || projectId.length() == 0
                || !(projectId.matches(PROJECT_RE))) {
            logger.info("Wrong project id");
            return null;
        }

        return getResource(BIGML_URL + projectId, queryString, apiUser, apiKey);
    }

    /**
     * Retrieves an project.
     *
     * GET /andromeda/project/id?username=$BIGML_USERNAME;api_key=$BIGML_API_KEY;
     * Host: bigml.io
     *
     * @param project
     *            a project JSONObject
     * @param queryString
     *            query for filtering
     * @param apiUser
     *            API user
     * @param apiKey
     *            API key
     *
     */
    public JSONObject get(final JSONObject project, final String queryString,
                          final String apiUser, final String apiKey) {
        String resourceId = (String) project.get("resource");
        return get(resourceId, queryString, apiUser, apiKey);
    }

}