Java tutorial
/* ************************************************************************ ******************* CANADIAN ASTRONOMY DATA CENTRE ******************* ************** CENTRE CANADIEN DE DONNES ASTRONOMIQUES ************** * * (c) 2009. (c) 2009. * Government of Canada Gouvernement du Canada * National Research Council Conseil national de recherches * Ottawa, Canada, K1A 0R6 Ottawa, Canada, K1A 0R6 * All rights reserved Tous droits rservs * * NRC disclaims any warranties, Le CNRC dnie toute garantie * expressed, implied, or nonce, implicite ou lgale, * statutory, of any kind with de quelque nature que ce * respect to the software, soit, concernant le logiciel, * including without limitation y compris sans restriction * any warranty of merchantability toute garantie de valeur * or fitness for a particular marchande ou de pertinence * purpose. NRC shall not be pour un usage particulier. * liable in any event for any Le CNRC ne pourra en aucun cas * damages, whether direct or tre tenu responsable de tout * indirect, special or general, dommage, direct ou indirect, * consequential or incidental, particulier ou gnral, * arising from the use of the accessoire ou fortuit, rsultant * software. Neither the name de l'utilisation du logiciel. Ni * of the National Research le nom du Conseil National de * Council of Canada nor the Recherches du Canada ni les noms * names of its contributors may de ses participants ne peuvent * be used to endorse or promote tre utiliss pour approuver ou * products derived from this promouvoir les produits drivs * software without specific prior de ce logiciel sans autorisation * written permission. pralable et particulire * par crit. * * This file is part of the Ce fichier fait partie du projet * OpenCADC project. OpenCADC. * * OpenCADC is free software: OpenCADC est un logiciel libre ; * you can redistribute it and/or vous pouvez le redistribuer ou le * modify it under the terms of modifier suivant les termes de * the GNU Affero General Public la GNU Affero General Public * License as published by the License? telle que publie * Free Software Foundation, par la Free Software Foundation * either version 3 of the : soit la version 3 de cette * License, or (at your option) licence, soit ( votre gr) * any later version. toute version ultrieure. * * OpenCADC is distributed in the OpenCADC est distribu * hope that it will be useful, dans lespoir quil vous * but WITHOUT ANY WARRANTY; sera utile, mais SANS AUCUNE * without even the implied GARANTIE : sans mme la garantie * warranty of MERCHANTABILITY implicite de COMMERCIALISABILIT * or FITNESS FOR A PARTICULAR ni dADQUATION UN OBJECTIF * PURPOSE. See the GNU Affero PARTICULIER. Consultez la Licence * General Public License for Gnrale Publique GNU Affero * more details. pour plus de dtails. * * You should have received Vous devriez avoir reu une * a copy of the GNU Affero copie de la Licence Gnrale * General Public License along Publique GNU Affero avec * with OpenCADC. If not, see OpenCADC ; si ce nest * <http://www.gnu.org/licenses/>. pas le cas, consultez : * <http://www.gnu.org/licenses/>. * * $Revision: 4 $ * ************************************************************************ */ package ca.nrc.cadc.uws; import java.io.IOException; import java.io.OutputStream; import java.io.OutputStreamWriter; import java.io.Writer; import java.text.DateFormat; import java.util.Date; import java.util.Iterator; import org.apache.log4j.Logger; import org.jdom2.Document; import org.jdom2.Element; import org.jdom2.output.Format; import org.jdom2.output.XMLOutputter; import ca.nrc.cadc.date.DateUtil; import ca.nrc.cadc.xml.ContentConverter; import ca.nrc.cadc.xml.IterableContent; /** * Writes a JobList as XML. * * @author majorb */ public class JobListWriter { private static Logger log = Logger.getLogger(JobListWriter.class); private DateFormat dateFormat; public JobListWriter() { this.dateFormat = DateUtil.getDateFormat(DateUtil.IVOA_DATE_FORMAT, DateUtil.UTC); } /** * Write to root Element to a writer. * * @param root Root Element to write. * @param writer Writer to write to. * @throws IOException if the writer fails to write. */ protected void writeDocument(Element root, Writer writer) throws IOException { XMLOutputter outputter = new XMLOutputter(); outputter.setFormat(Format.getPrettyFormat()); Document document = new Document(root); outputter.output(document, writer); } /** * Write the job list to an OutputStream. * * @param jobs * @param out OutputStream to write to. * @throws IOException if the writer fails to write. */ public void write(Iterator<JobRef> jobs, OutputStream out) throws IOException { write(jobs, new OutputStreamWriter(out)); } /** * Write the job list to our streaming xml writer. * * @param jobs * @param writer Writer to write to. * @throws IOException if the writer fails to write. */ public void write(Iterator<JobRef> jobs, Writer writer) throws IOException { Element root = getRootElement(jobs); XMLOutputter outputter = new XMLOutputter(); outputter.setFormat(Format.getPrettyFormat()); Document document = new Document(root); outputter.output(document, writer); } public Element getRootElement(Iterator<JobRef> jobs) { ContentConverter<Element, JobRef> contentConverter = new ContentConverter<Element, JobRef>() { @Override public Element convert(final JobRef jobRef) { return getShortJobDescription(jobRef); } }; Element root = new IterableContent<Element, JobRef>(JobAttribute.JOBS.getAttributeName(), UWS.NS, jobs, contentConverter); root.addNamespaceDeclaration(UWS.NS); root.addNamespaceDeclaration(UWS.XLINK_NS); root.setAttribute(JobAttribute.VERSION.getAttributeName(), UWS.XSD_VERSION); return root; } /** * Create the XML for a short job description. * @param jobRef * @return */ public Element getShortJobDescription(JobRef jobRef) { Element shortJobDescription = new Element(JobAttribute.JOB_REF.getAttributeName(), UWS.NS); shortJobDescription.setAttribute("id", jobRef.getJobID()); shortJobDescription.addContent(getPhase(jobRef)); shortJobDescription.addContent(getCreationTime(jobRef)); shortJobDescription.addContent(getRunID(jobRef)); shortJobDescription.addContent(getOwnerID(jobRef)); return shortJobDescription; } /** * Get an Element representing the Job phase. * * @return The Job phase Element. */ private Element getPhase(JobRef jobRef) { Element element = new Element(JobAttribute.EXECUTION_PHASE.getAttributeName(), UWS.NS); element.addContent(jobRef.getExecutionPhase().toString()); return element; } /** * Get an Element representing the runID. * * @return The runID element. */ private Element getRunID(JobRef jobRef) { Element element = new Element(JobAttribute.RUN_ID.getAttributeName(), UWS.NS); String runID = jobRef.getRunID(); if (runID == null) element.setAttribute("nil", "true", UWS.XSI_NS); else element.addContent(runID); return element; } /** * Get an Element representing the creation time. * * @return The creation time element. */ private Element getCreationTime(JobRef jobRef) { Element element = new Element(JobAttribute.CREATION_TIME.getAttributeName(), UWS.NS); Date creationTime = jobRef.getCreationTime(); if (creationTime == null) element.setAttribute("nil", "true", UWS.XSI_NS); else element.addContent(dateFormat.format(jobRef.getCreationTime())); return element; } /** * Get an Element representing the owner ID. * * @return The owner ID Element. */ private Element getOwnerID(JobRef jobRef) { Element element = new Element(JobAttribute.OWNER_ID.getAttributeName(), UWS.NS); element.addContent(jobRef.getOwnerID()); return element; } }