net.sf.taverna.t2.activities.apiconsumer.servicedescriptions.ApiConsumerServiceDescription.java Source code

Java tutorial

Introduction

Here is the source code for net.sf.taverna.t2.activities.apiconsumer.servicedescriptions.ApiConsumerServiceDescription.java

Source

/*******************************************************************************
 * Copyright (C) 2007 The University of Manchester
 *
 *  Modifications to the initial code base are copyright of their
 *  respective authors, or their employers as appropriate.
 *
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public License
 *  as published by the Free Software Foundation; either version 2.1 of
 *  the License, or (at your option) 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 GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser 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
 ******************************************************************************/
package net.sf.taverna.t2.activities.apiconsumer.servicedescriptions;

import java.net.URI;
import java.util.Arrays;
import java.util.List;

import javax.swing.Icon;

import net.sf.taverna.t2.servicedescriptions.ServiceDescription;
import uk.org.taverna.scufl2.api.configurations.Configuration;

import com.fasterxml.jackson.databind.node.ArrayNode;
import com.fasterxml.jackson.databind.node.ObjectNode;

/**
 * @author alanrw
 * @author David Withers
 */
public class ApiConsumerServiceDescription extends ServiceDescription {

    public static final URI ACTIVITY_TYPE = URI.create("http://ns.taverna.org.uk/2010/activity/apiconsumer");

    static final String API_CONSUMER_SERVICE = "ApiConsumer service";

    /**
     * Enclosing API consumer this method belong's to
     * (from the XML API consumer definition file).
     */
    private String apiConsumerName;

    /**
     * Enclosing API consumer's description
     * (from the XML API consumer definition file).
     */
    private String apiConsumerDescription;

    /**
     * Method description.
     */
    private String description;

    /**
     * The name of the class the method will be invoked on.
     */
    private String className;

    /**
     * The name of the method to invoke.
     */
    private String methodName;

    /**
     * List of parameter names.
     */
    private String[] parameterNames;

    /**
     * List of parameter dimensions (0 for single object, 1 for a list of objects, etc.)
     */
    private int[] parameterDimensions;

    /**
     * List of parameter types.
     */
    private String[] parameterTypes;

    /**
     * Method's return parameter type.
     */
    private String returnType;

    /**
     * Method's return parameter dimension.
     */
    private int returnDimension;

    /**
     * Is the method to be invoked static?
     */
    private boolean isStatic;

    /**
     *    Is the method  to be invoked a contructor?
     */
    private boolean isConstructor;

    @Override
    public URI getActivityType() {
        return ACTIVITY_TYPE;
    }

    @Override
    public Configuration getActivityConfiguration() {
        Configuration configuration = new Configuration();
        configuration.setType(ACTIVITY_TYPE.resolve("#Config"));
        ObjectNode json = (ObjectNode) configuration.getJson();
        json.put("apiConsumerName", apiConsumerName);
        json.put("apiConsumerDescription", apiConsumerDescription);
        json.put("description", description);
        json.put("className", className);
        json.put("methodName", methodName);
        ArrayNode parameterNamesArray = json.arrayNode();
        for (String parameterName : parameterNames) {
            parameterNamesArray.add(parameterName);
        }
        json.put("parameterNames", parameterNamesArray);
        ArrayNode parameterTypesArray = json.arrayNode();
        for (String parameterType : parameterTypes) {
            parameterTypesArray.add(parameterType);
        }
        json.put("parameterTypes", parameterTypesArray);
        ArrayNode parameterDimensionsArray = json.arrayNode();
        for (int parameterDimension : parameterDimensions) {
            parameterDimensionsArray.add(parameterDimension);
        }
        json.put("parameterDimensions", parameterDimensionsArray);
        json.put("returnType", returnType);
        json.put("returnDimension", returnDimension);
        json.put("isMethodConstructor", isConstructor);
        json.put("isMethodStatic", isStatic);
        return configuration;
    }

    @Override
    public Icon getIcon() {
        return ApiConsumerActivityIcon.getApiConsumerIcon();
    }

    @Override
    protected List<Object> getIdentifyingData() {
        return Arrays.<Object>asList(getClassName(), getMethodName());
    }

    @Override
    public String getName() {
        return getMethodName();
    }

    @Override
    public List<? extends Comparable<?>> getPath() {
        List<String> result;
        result = Arrays.asList(API_CONSUMER_SERVICE + " : " + getApiConsumerName(), getClassName());
        return result;
    }

    /**
     * @return the apiConsumerName
     */
    public String getApiConsumerName() {
        return apiConsumerName;
    }

    /**
     * @param apiConsumerName the apiConsumerName to set
     */
    public void setApiConsumerName(String apiConsumerName) {
        this.apiConsumerName = apiConsumerName;
    }

    /**
     * @return the apiConsumerDescription
     */
    public String getApiConsumerDescription() {
        return apiConsumerDescription;
    }

    /**
     * @param apiConsumerDescription the apiConsumerDescription to set
     */
    public void setApiConsumerDescription(String apiConsumerDescription) {
        this.apiConsumerDescription = apiConsumerDescription;
    }

    /**
     * @return the description
     */
    public String getDescription() {
        return description;
    }

    /**
     * @param description the description to set
     */
    public void setDescription(String description) {
        this.description = description;
    }

    /**
     * @return the className
     */
    public String getClassName() {
        return className;
    }

    /**
     * @param className the className to set
     */
    public void setClassName(String className) {
        this.className = className;
    }

    /**
     * @return the methodName
     */
    public String getMethodName() {
        return methodName;
    }

    /**
     * @param methodName the methodName to set
     */
    public void setMethodName(String methodName) {
        this.methodName = methodName;
    }

    /**
     * @return the parameterNames
     */
    public String[] getParameterNames() {
        return parameterNames;
    }

    /**
     * @param parameterNames the parameterNames to set
     */
    public void setParameterNames(String[] parameterNames) {
        this.parameterNames = parameterNames;
    }

    /**
     * @return the parameterDimensions
     */
    public int[] getParameterDimensions() {
        return parameterDimensions;
    }

    /**
     * @param parameterDimensions the parameterDimensions to set
     */
    public void setParameterDimensions(int[] parameterDimensions) {
        this.parameterDimensions = parameterDimensions;
    }

    /**
     * @return the parameterTypes
     */
    public String[] getParameterTypes() {
        return parameterTypes;
    }

    /**
     * @param parameterTypes the parameterTypes to set
     */
    public void setParameterTypes(String[] parameterTypes) {
        this.parameterTypes = parameterTypes;
    }

    /**
     * @return the returnType
     */
    public String getReturnType() {
        return returnType;
    }

    /**
     * @param returnType the returnType to set
     */
    public void setReturnType(String returnType) {
        this.returnType = returnType;
    }

    /**
     * @return the returnDimension
     */
    public int getReturnDimension() {
        return returnDimension;
    }

    /**
     * @param returnDimension the returnDimension to set
     */
    public void setReturnDimension(int returnDimension) {
        this.returnDimension = returnDimension;
    }

    /**
     * @return the isStatic
     */
    public boolean isStatic() {
        return isStatic;
    }

    /**
     * @param isStatic the isStatic to set
     */
    public void setStatic(boolean isStatic) {
        this.isStatic = isStatic;
    }

    /**
     * @return the isConstructor
     */
    public boolean isConstructor() {
        return isConstructor;
    }

    /**
     * @param isConstructor the isConstructor to set
     */
    public void setConstructor(boolean isConstructor) {
        this.isConstructor = isConstructor;
    }

}