taverna-provenanceconnector/src/main/java/org/apache/taverna/provenance/api/Query.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.taverna.provenance.api;

import java.util.List;

import org.apache.taverna.provenance.lineageservice.utils.ProvenanceProcessor;
import org.apache.taverna.provenance.lineageservice.utils.QueryPort;

/**
 * Bean encapsulating one provenance query, consisting of the following
 * elements:
 * <ul>
 * <li>static scope: the (single) name of the workflow whose run(s) are queried
 * <li>dynamic scope: a list of workflow run IDs.
 * <li>a list of &lt;select> variables, encoded as List&lt;{@link QueryPort}>
 * <li>a list of &lt;target> processors, encoded as List&lt;
 * {@link ProvenanceProcessor}>
 * </ul>
 *
 * @author Paolo Missier
 */
public class Query {
	private String workflowName;
	private List<QueryPort> targetPorts;
	private List<String> runIDList;
	private List<ProvenanceProcessor> selectedProcessors;

	@Override
	public String toString() {
		StringBuilder sb = new StringBuilder();
		sb.append("\n **** QUERY SCOPE: ****\n").append("\tworkflow name: ")
				.append(getWorkflowName()).append("\n\truns: ");
		for (String r : getRunIDList())
			sb.append("\n\t").append(r);
		sb.append("\n**** TARGET PORTS: ****\n");
		for (QueryPort v : getTargetPorts())
			sb.append("\n\t").append(v);
		sb.append("\n\n**** SELECTED PROCESSORS: **** ");
		for (ProvenanceProcessor pp : getSelectedProcessors())
			sb.append("\n\t").append(pp);
		return sb.toString();
	}

	/**
	 * @return the targetVars
	 */
	public List<QueryPort> getTargetPorts() {
		return targetPorts;
	}

	/**
	 * @param targetVars
	 *            the targetVars to set
	 */
	public void setTargetPorts(List<QueryPort> targetVars) {
		this.targetPorts = targetVars;
	}

	/**
	 * @return the selectedProcessors
	 */
	public List<ProvenanceProcessor> getSelectedProcessors() {
		return selectedProcessors;
	}

	/**
	 * @param selectedProcessors
	 *            the selectedProcessors to set
	 */
	public void setFocus(List<ProvenanceProcessor> selectedProcessors) {
		this.selectedProcessors = selectedProcessors;
	}

	/**
	 * @return the runIDList
	 */
	public List<String> getRunIDList() {
		return runIDList;
	}

	/**
	 * @param runIDList
	 *            the runIDList to set
	 */
	public void setRunIDList(List<String> runIDList) {
		this.runIDList = runIDList;
	}

	/**
	 * @return the workflowName
	 */
	public String getWorkflowName() {
		return workflowName;
	}

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