de.unirostock.sems.cbarchive.Utils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of CombineArchive Show documentation
Library to read/create/write/manipulate/... COMBINE archives
The newest version!
/**
 * CombineArchive - a JAVA library to read/write/create/.. CombineArchives
 * Copyright (c) 2014, Martin Scharm 
 * 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 de.unirostock.sems.cbarchive;

import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.OutputStream;
import java.net.URI;
import java.net.URISyntaxException;
import java.nio.file.CopyOption;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.StandardCopyOption;
import java.nio.file.StandardOpenOption;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.List;

import javax.xml.transform.TransformerException;

import org.jdom2.Document;
import org.jdom2.Element;
import org.jdom2.JDOMException;
import org.jdom2.Namespace;
import org.jdom2.input.SAXBuilder;
import org.jdom2.output.Format;
import org.jdom2.output.XMLOutputter;

import de.binfalse.bflog.LOGGER;



/**
 * Some tools.
 * 
 * @author martin scharm
 */
public class Utils
{
	
	/** The RDF namespace. */
	public static final Namespace					rdfNS					= Namespace
		.getNamespace ("rdf", "http://www.w3.org/1999/02/22-rdf-syntax-ns#");
	
	/** The DC namespace. */
	public static final Namespace					dcNS					= Namespace
		.getNamespace ("dcterms", "http://purl.org/dc/terms/");
	
	/** The vcard namespace. */
	public static final Namespace					vcNS					= Namespace
		.getNamespace ("vCard", "http://www.w3.org/2006/vcard/ns#");
	
	/** The OMEX spec namespace. */
	public static final Namespace					omexSpecNs		= Namespace
		.getNamespace ("http://identifiers.org/combine.specifications/omex");
	
	/** The OMEX namespace. */
	public static final Namespace					omexNs				= Namespace.getNamespace (
		"http://identifiers.org/combine.specifications/omex-manifest");
	
	/** The date formater. */
	public static final SimpleDateFormat	dateFormater	= new SimpleDateFormat (
		"yyyy'-'MM'-'dd'T'HH':'mm':'ss'Z'");
	
	/** The default buffer size. */
	public final static int								BUFFER_SIZE		= 8 * 1024;
	
	/** The newline character. */
	public final static String						NEWLINE				= System
		.getProperty ("line.separator");
	
	/** The COPY_OPTION used to copy/move files. */
	public static final CopyOption[]			COPY_OPTION		= new CopyOption[] {
		StandardCopyOption.REPLACE_EXISTING, StandardCopyOption.COPY_ATTRIBUTES };
	
	
	/**
	 * Reads an XML file and creates a Document.
	 * 
	 * @param fileToRead
	 *          the file to read
	 * @return the XML document
	 * @throws JDOMException
	 *           the JDOM exception
	 * @throws IOException
	 *           Signals that an I/O exception has occurred.
	 */
	public static final Document readXmlDocument (Path fileToRead)
		throws JDOMException,
			IOException
	{
		SAXBuilder builder = new SAXBuilder ();
		return (Document) builder
			.build (Files.newInputStream (fileToRead, StandardOpenOption.READ));
	}
	
	/**
	 * The Class SimpleOutputStream.
	 */
	public static class SimpleOutputStream
		extends OutputStream
	{
		
		/** The string. */
		private StringBuilder string = new StringBuilder ();
		
		
		/*
		 * (non-Javadoc)
		 * 
		 * @see java.io.OutputStream#write(int)
		 */
		@Override
		public void write (int b) throws IOException
		{
			this.string.append ((char) b);
		}
		
		
		/*
		 * (non-Javadoc)
		 * 
		 * @see java.lang.Object#toString()
		 */
		public String toString ()
		{
			return this.string.toString ();
		}
		
		
		/**
		 * Reset.
		 */
		public void reset ()
		{
			this.string = new StringBuilder ();
		}
	}
	
	
	/**
	 * Gets elements of an XML subtree by tag name.
	 * 
	 * @param parent
	 *          the root of the subtree
	 * @param name
	 *          the tag name
	 * @param ns
	 *          the namespace
	 * @return the elements by sharing this tag name
	 */
	public static List getElementsByTagName (Element parent, String name,
		Namespace ns)
	{
		List nodeList = new ArrayList ();
		List togo = new ArrayList ();
		togo.add (parent);
		
		while (togo.size () > 0)
		{
			parent = togo.remove (0);
			nodeList.addAll (parent.getChildren (name, ns));
			togo.addAll (0, parent.getChildren ());
		}
		
		return nodeList;
	}
	
	
	/**
	 * Pretty print an XML document.
	 * 
	 * @param doc
	 *          the XML document
	 * @return the beautified string
	 * @throws IOException
	 *           Signals that an I/O exception has occurred.
	 * @throws TransformerException
	 *           the transformer exception
	 */
	public static String prettyPrintDocument (Document doc)
		throws IOException,
			TransformerException
	{
		XMLOutputter outputter = new XMLOutputter (Format.getPrettyFormat ());
		return outputter.outputString (doc);
	}
	
	
	/**
	 * Extracts the extension of a filename.
	 * 
	 * @param fileName
	 *          the file name
	 * @return the extension, or null if we're not able to find an extension
	 */
	public static String getExtension (String fileName)
	{
		int dot = fileName.lastIndexOf (".");
		if (dot >= 0)
			return fileName.substring (dot + 1);
		return null;
	}
	
	
	/**
	 * Recursively delete file or directory.
	 * 
	 * @param f
	 *          the file/dir to delete
	 * @throws IOException
	 *           Signals that an I/O exception has occurred.
	 */
	public static void delete (File f) throws IOException
	{
		if (f.isDirectory ())
			for (File c : f.listFiles ())
				delete (c);
		if (!f.delete ())
			throw new FileNotFoundException ("Failed to delete file: " + f);
	}
	
	
	/**
	 * Get the URI representing OMEX meta data
	 * 
	 * @return OMEX meta data URI
	 */
	public static URI getOmexMetaDataUri ()
	{
		try
		{
			return new URI (
				"http://identifiers.org/combine.specifications/omex-metadata");
		}
		catch (URISyntaxException e)
		{
			LOGGER.error (e,
				"failed to create omex meta data uri. that shouldn't happen!!!");
			return null;
		}
	}
	
	
	/**
	 * Gets the URI representing the OMEX specification.
	 * 
	 * @return the OMEX specification URI
	 */
	public static URI getOmexSpecUri ()
	{
		try
		{
			return new URI ("http://identifiers.org/combine.specifications/omex");
		}
		catch (URISyntaxException e)
		{
			LOGGER.error (e,
				"failed to create omex spec uri. that shouldn't happen!!!");
			return null;
		}
	}
	
	
	/**
	 * Gets the OMEX manifest URI.
	 * 
	 * @return the OMEX manifest URI
	 */
	public static URI getOmexManifestUri ()
	{
		try
		{
			return new URI (
				"http://identifiers.org/combine.specifications/omex-manifest");
		}
		catch (URISyntaxException e)
		{
			LOGGER.error (e,
				"failed to create omex manifest uri. that shouldn't happen!!!");
			return null;
		}
	}
	
	
	/**
	 * Utility to fix paths on different operating systems.
	 * 
	 * Will make sure that all paths use '/'. If the operation systems uses
	 * something else, such as '\' or ':', we're going to replace that with an
	 * '/'.
	 * 
	 * @param path
	 *          the path as retrieved by your operating system
	 * @return the fixed path
	 */
	public static String pathFixer (String path)
	{
		if (!File.separator.equals ("/"))
			path = path.replaceAll (File.separator.replaceAll ("\\\\", "\\\\\\\\"),
				"/");
		return path;
	}
	
}