org.bigml.binding.resources.Script 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.bigml.binding.utils.Utils;
import org.json.simple.JSONObject;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.File;


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

    // Logging
    Logger logger = LoggerFactory.getLogger(Script.class);
    
    /**
     * Constructor
     *
     * @deprecated
     */
	public Script() {
		super.init(null, null, null, null, null, 
				SCRIPT_RE, SCRIPT_PATH);
	}

	/**
	 * Constructor
	 *
	 * @deprecated
	 */
	public Script(final String apiUser, final String apiKey) {
		super.init(apiUser, apiKey, null, null, null, 
				SCRIPT_RE, SCRIPT_PATH);
	}
	
	/**
	 * Constructor
	 *
	 * @deprecated
	 */
	public Script(final String apiUser, final String apiKey,
			final CacheManager cacheManager) {
		super.init(apiUser, apiKey, null, null, null, 
				SCRIPT_RE, SCRIPT_PATH);
	}
	
    /**
     * Constructor
     *
     */
    public Script(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, SCRIPT_RE, SCRIPT_PATH);
    }

    /**
     * Creates a whizzml script from its source code.
     *
     * POST /andromeda/script?username=$BIGML_USERNAME;api_key=$BIGML_API_KEY;
     * HTTP/1.1 Host: bigml.io Content-Type: application/json
     *
     * @param source
     *            source code for the script. It can be either
     *              - string: source code
     *              - script id: the ID for an existing whizzml script
     *              - path: the path to a file containing the source code
     * @param args
     *            set of parameters for the new script. Optional
     * @param waitTime
     *            time (milliseconds) to wait for next check of FINISHED status
     *            for source before to start to create the script. Optional
     * @param retries
     *            number of times to try the operation. Optional
     *
     */
    public JSONObject create(String source, JSONObject args,
                             Integer waitTime, Integer retries) {

        if (source == null || source.length() == 0 ) {
            logger.info("A valid code string or a script id must be provided.");
            return null;
        }

        try {
            JSONObject requestObject = new JSONObject();
            if (args != null) {
                requestObject = args;
            }

            if (source.matches(SCRIPT_RE)) {
            		waitForResource(source, "scriptIsReady", waitTime, retries);
            	
                requestObject.put("origin", source);
                return createResource(resourceUrl, 
                		requestObject.toJSONString());
            }

            try {
                File file = new File(source);
                if (file.exists()) {
                    source = Utils.readFile(source);
                }
            } catch (Throwable e) {
                logger.error("Could not open the source code file " + source, e);
            }

            requestObject.put("source_code", source);
            return createResource(resourceUrl, 
            		requestObject.toJSONString());

        } catch (Throwable e) {
            logger.error("Error creating evaluation");
            return null;
        }
    }

}