org.daisy.pipeline.client.models.Job Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of clientlib-java Show documentation
A Java library for communicating with the DAISY Pipeline 2.
There is a newer version: 5.0.1
package org.daisy.pipeline.client.models;

import java.net.URISyntaxException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

import org.daisy.pipeline.client.Pipeline2WS;
import org.daisy.pipeline.client.Pipeline2WSException;
import org.daisy.pipeline.client.Pipeline2WSResponse;
import org.daisy.pipeline.client.models.job.JobResult;
import org.daisy.pipeline.client.models.job.Message;
import org.daisy.pipeline.utils.XPath;
import org.w3c.dom.Document;
import org.w3c.dom.Node;

/**
 * A representation of a Pipeline 2 job.
 * 
 * @author jostein
 */
public class Job {
	
	public enum Status { IDLE, RUNNING, DONE, ERROR, VALIDATION_FAIL };
	
	public String id;
	public String href; // xs:anyURI
	public Status status;
	
	public Script script;
	public Node messages;
	public String logHref;
	public Node results;
	
	/**
	 * Create an empty representation of a job.
	 */
	public Job() {
		script = new Script();
	}
	
	/**
	 * Parse the job described by the provided Pipeline2WSResponse.
	 * 
	 * @param response
	 * @throws Pipeline2WSException
	 */
	public Job(Pipeline2WSResponse response) throws Pipeline2WSException {
		this();
		if (response.status != 200)
			throw new Pipeline2WSException(response.status+" "+response.statusName+": "+response.statusDescription);
		parseJobXml(response.asXml());
	}
	
	/**
	 * Parse the job described by the provided XML document/node.
	 * Example: http://daisy-pipeline.googlecode.com/hg/webservice/samples/xml-formats/job.xml
	 * 
	 * @param jobXml
	 * @throws Pipeline2WSException
	 */
	public Job(Node jobXml) throws Pipeline2WSException {
		this();
		parseJobXml(jobXml);
	}
	
	/**
	 * Get the job result matching the given href without parsing the entire jobXml.
	 * 
	 * @param jobXml
	 * @param href
	 * @param base
	 * @return
	 * @throws Pipeline2WSException
	 * @throws URISyntaxException
	 */
	public static JobResult getResultFromHref(Node jobXml, String href) throws Pipeline2WSException {
		if (href == null) {
			href = "";
		}
		
		if (jobXml instanceof Document) {
			jobXml = XPath.selectNode("/d:job", jobXml, Pipeline2WS.ns);
		}
		
		String base = XPath.selectText("@href", jobXml, Pipeline2WS.ns) + "/result";
		if (!"".equals(href)) {
			base += "/"; 
		}
		String fullHref = base + href;
		
		Node resultNode = XPath.selectNode("d:results//descendant-or-self::*[@href='"+fullHref.replaceAll("'", "''").replaceAll(" ", "%20")+"']", jobXml, Pipeline2WS.ns);
		if (resultNode != null) {
			return JobResult.parseResultXml(resultNode, base);
		}
		return null;
	}
	
	private void parseJobXml(Node jobXml) throws Pipeline2WSException {
		// select root element if the node is a document node
		if (jobXml instanceof Document)
			jobXml = XPath.selectNode("/d:job", jobXml, Pipeline2WS.ns);
		
		id = XPath.selectText("@id", jobXml, Pipeline2WS.ns);
		href = XPath.selectText("@href", jobXml, Pipeline2WS.ns);
		String status = XPath.selectText("@status", jobXml, Pipeline2WS.ns);
		for (Status s : Status.values()) {
			if (s.toString().equals(status)) {
				this.status = s;
				break;
			}
		}
		script.id = XPath.selectText("d:script/@id", jobXml, Pipeline2WS.ns);
		script.href = XPath.selectText("d:script/@href", jobXml, Pipeline2WS.ns);
		script.nicename = XPath.selectText("d:script/d:nicename", jobXml, Pipeline2WS.ns);
		script.desc = XPath.selectText("d:script/d:description", jobXml, Pipeline2WS.ns);
		logHref = XPath.selectText("d:log/@href", jobXml, Pipeline2WS.ns);
		
		this.results = XPath.selectNode("d:results", jobXml, Pipeline2WS.ns);
		this.messages = XPath.selectNode("d:messages", jobXml, Pipeline2WS.ns);
	}
	
	/**
	 * Get a list of all messages for the job.
	 * @return
	 * @throws Pipeline2WSException
	 */
	public List getMessagesAsList() throws Pipeline2WSException {
		List messageList = new ArrayList();
		List messageNodes = XPath.selectNodes("d:message", this.messages, Pipeline2WS.ns);
		
		for (Node messageNode : messageNodes) {
			messageList.add(new Message(
				XPath.selectText("@level", messageNode, Pipeline2WS.ns),
				XPath.selectText("@sequence", messageNode, Pipeline2WS.ns),
				XPath.selectText(".", messageNode, Pipeline2WS.ns)
			));
		}
		Collections.sort(messageList);
		
		return messageList;
	}
	
	/**
	 * Get a nested structure of JobResult objects.
	 * 
	 * @return The returned JobResult represents "all results".
	 *         It contains a list of JobResults representing each output,
	 *         which in turn contains a list of JobResults representing
	 *         each file contained within the respective output.
	 *         This structure matches the one in the job XML.
	 * @throws Pipeline2WSException
	 */
	public JobResult getResults() throws Pipeline2WSException {
		JobResult outputs = JobResult.parseResultXml(this.results, href);
		outputs.results = new ArrayList();
		
		List outputNodes = XPath.selectNodes("d:result", this.results, Pipeline2WS.ns);
		for (Node outputNode : outputNodes) {
			JobResult output = JobResult.parseResultXml(outputNode, href);
			output.results = new ArrayList();
			
			List fileNodes = XPath.selectNodes("d:result", outputNode, Pipeline2WS.ns);
			for (Node fileNode : fileNodes) {
				JobResult file = JobResult.parseResultXml(fileNode, href);
				output.results.add(file);
			}
			Collections.sort(output.results);
			
			outputs.results.add(output);
		}
		
		return outputs;
	}
	
	/**
	 * Parse the list of jobs described by the provided Pipeline2WSResponse.
	 * 
	 * @param response
	 * @return
	 * @throws Pipeline2WSException
	 */
	public static List getJobs(Pipeline2WSResponse response) throws Pipeline2WSException {
		if (response.status != 200)
			throw new Pipeline2WSException(response.status+" "+response.statusName+": "+response.statusDescription);
		return parseJobsXml(response.asXml());
	}
	
	/**
	 * Parse the list of jobs described by the provided XML document/node.
	 * Example: http://daisy-pipeline.googlecode.com/hg/webservice/samples/xml-formats/jobs.xml
	 * 
	 * @param response
	 * @return
	 * @throws Pipeline2WSException
	 */
	public static List parseJobsXml(Node jobsXml) throws Pipeline2WSException {
		List jobs = new ArrayList();
		
		// select root element if the node is a document node
		if (jobsXml instanceof Document)
			jobsXml = XPath.selectNode("/d:jobs", jobsXml, Pipeline2WS.ns);
		
		List jobNodes = XPath.selectNodes("d:job", jobsXml, Pipeline2WS.ns);
		for (Node jobNode : jobNodes) {
			jobs.add(new Job(jobNode));
		}
		
		return jobs;
	}
}