• Home
• org.openml
• apiconnector
• 1.0.24
• source code
• Flow.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.openml.apiconnector.xml.Flow Maven / Gradle / Ivy

/*******************************************************************************
 * Copyright (C) 2017, Jan N. van Rijn 
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 
 * 2. 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.
 * 
 * 3. Neither the name of the copyright holder nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 * 
 * 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 HOLDER 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.
 ******************************************************************************/
package org.openml.apiconnector.xml;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import com.thoughtworks.xstream.annotations.XStreamAlias;
import com.thoughtworks.xstream.annotations.XStreamImplicit;

import org.apache.commons.lang3.ArrayUtils;

@XStreamAlias("oml:flow")
public class Flow extends OpenmlApiResponse {
	
	private static final long serialVersionUID = -778554189112252674L;

	@XStreamAlias("oml:id")
	private Integer id;
	
	@XStreamAlias("oml:uploader")
	private Integer uploader;
	
	@XStreamAlias("oml:name")
	private String name;
	
	@XStreamAlias("oml:custom_name")
	private String custom_name;

	@XStreamAlias("oml:class_name")
	private String class_name;
	
	@XStreamAlias("oml:version")
	private String version;
	
	@XStreamAlias("oml:external_version")
	private String external_version;

	@XStreamAlias("oml:description")
	private String description;

	@XStreamImplicit(itemFieldName = "oml:creator")
	private String[] creator;

	@XStreamImplicit(itemFieldName = "oml:contributor")
	private String[] contributor;

	@XStreamAlias("oml:upload_date")
	private String upload_date;

	@XStreamAlias("oml:licence")
	private String licence;

	@XStreamAlias("oml:language")
	private String language;
	
	@XStreamAlias("oml:full_description")
	private String full_description;

	@XStreamAlias("oml:installation_notes")
	private String installation_notes;

	@XStreamAlias("oml:dependencies")
	private String dependencies;
	
	@XStreamImplicit(itemFieldName="oml:parameter")
	private Parameter[] parameter;

	@XStreamImplicit
	@XStreamAlias("oml:component")
	private Component[] component;

	@XStreamImplicit(itemFieldName = "oml:tag")
	private String[] tag;
	
	@XStreamAlias("oml:source_url")
	private String source_url;
	
	@XStreamAlias("oml:binary_url")
	private String binary_url;

	@XStreamAlias("oml:source_format")
	private String source_format;
	
	@XStreamAlias("oml:binary_format")
	private String binary_format;

	@XStreamAlias("oml:source_md5")
	private String source_md5;

	@XStreamAlias("oml:binary_md5")
	private String binary_md5;

	public Flow(String name, String class_name, String external_version, String description, String language, String dependencies ) {
		this.name = name;
		this.class_name = class_name;
		this.external_version = external_version;
		this.description = description;
		this.language = language;
		this.dependencies = dependencies;
	}

	public Flow(String name, String custom_name, String class_name, 
			String external_version, String description,
			String[] creator, String[] contributor, String licence,
			String language, String full_description,
			String installation_notes, String dependencies, String[] tag) {
		super();
		this.name = name;
		this.custom_name = custom_name;
		this.class_name = class_name;
		this.external_version = external_version;
		this.description = description;
		this.creator = creator;
		this.contributor = contributor;
		this.licence = licence;
		this.language = language;
		this.full_description = full_description;
		this.installation_notes = installation_notes;
		this.dependencies = dependencies;
		this.tag = tag;
	}

	public Integer getId() {
		return id;
	}
	
	public void setName(String name) {
		this.name = name;
	}
	
	public String getCustom_name() {
		return custom_name;
	}

	public void setCustom_name(String custom_name) {
		this.custom_name = custom_name;
	}

	public String getClass_name() {
		return class_name;
	}

	public String getExternal_version() {
		return external_version;
	}
	
	public void setExternal_version(String external_version) {
		this.external_version = external_version;
	}

	public Integer getUploader() {
		return uploader;
	}

	public String getName() {
		return name;
	}
	
	public String getLastName() {
		return name.substring( name.lastIndexOf('.') + 1 );
	}

	public String getVersion() {
		return version;
	}

	public String getDescription() {
		return description;
	}
	
	public void setDescription(String description) {
		this.description = description;
	}

	public String[] getCreator() {
		return creator;
	}

	public String[] getContributor() {
		return contributor;
	}

	public String getUpload_date() {
		return upload_date;
	}

	public String getLicence() {
		return licence;
	}

	public String getLanguage() {
		return language;
	}

	public String getFull_description() {
		return full_description;
	}

	public String getInstallation_notes() {
		return installation_notes;
	}

	public String getDependencies() {
		return dependencies;
	}

	public Parameter[] getParameter() {
		return parameter;
	}

	public Component[] getComponent() {
		return component;
	}
	
	public String[] getTag() {
		return tag;
	}

	public String getSource_url() {
		return source_url;
	}

	public String getBinary_url() {
		return binary_url;
	}

	public String getSource_format() {
		return source_format;
	}

	public String getBinary_format() {
		return binary_format;
	}

	public String getSource_md5() {
		return source_md5;
	}

	public String getBinary_md5() {
		return binary_md5;
	}

	public void addTag(String new_tag) throws Exception {
		// check if tag is not already present
		if (tag != null) {
			if (Arrays.asList(tag).contains(new_tag) == true) {
				throw new Exception("Tag already exists.");
			}
		}
		tag = ArrayUtils.addAll(tag, new_tag);
	}

	public void addParameter(String name, String data_type, String default_value, String description) {
		Parameter p = new Parameter(name, data_type, default_value, description);
		this.parameter = ArrayUtils.add(this.parameter, p);
	}
	
	public void addParameter(Parameter p) {
		this.parameter = ArrayUtils.add(this.parameter, p);
	}
	
	public void addComponent(String identifier, Flow implementation) {
		Component c = new Component(identifier, implementation);
		this.component = ArrayUtils.add(this.component, c);
	}
	
	public boolean parameter_exists(String name) {
		if (parameter != null) {
			for (Parameter p : parameter) {
				if (p.getName().equals(name)) {
					return true;
				}
			}
		}
		return false;
	}
	
	public int countComponents() {
		int count = 1;
		if (getComponent() != null) {
			for (Flow.Component sub : getComponent()) {
				count += sub.getImplementation().countComponents();
			}
		}
		return count;
	}
	
	public int countParameters() {
		int count = 0;
		if (getParameter() != null) {
			count += getParameter().length;
		}
		if (getComponent() != null) {
			for (Flow.Component sub : getComponent()) {
				count += sub.getImplementation().countParameters();
			}
		}
		return count;
	}
	
	public Parameter[] getParametersRecursive() {
		List parameters = new ArrayList();
		if (getParameter() != null) {
			for (Parameter param : getParameter()) {
				// adds flow id to the parameter
				parameters.add(new Parameter(null, id, name + "_" + param.getName(), param.getName(), param.getData_type(), param.getDefault_value(), null));
			}
		}
		if (getComponent() != null) {
			for (Flow.Component sub : getComponent()) {
				parameters.addAll(Arrays.asList(sub.getImplementation().getParametersRecursive()));
			}
		}
		
		return parameters.toArray(new Parameter[parameters.size()]);
	}
	
	public Flow getSubImplementation(String identifier) throws Exception {
		if( component != null ) {
			for( Component p : component ) {
				if( p.identifier.equals(identifier)) {
					return p.getImplementation();
				}
			}
		}
		throw new Exception("Component with identifier " + identifier + " not found. ");
	}

	@XStreamAlias("oml:component")
	public static class Component {
		@XStreamAlias("oml:identifier")
		private String identifier;

		@XStreamAlias("oml:flow")
		private Flow flow;
		
		public Component( String identifier, Flow flow ) {
			this.identifier = identifier;
			this.flow = flow;
		}

		public String getIdentifier() {
			return identifier;
		}

		public Flow getImplementation() {
			return flow;
		}
	}
}