de.uzk.hki.da.metadata.XMPMetadataStructure.java Source code

Introduction

Here is the source code for de.uzk.hki.da.metadata.XMPMetadataStructure.java

Source

/*
  DA-NRW Software Suite | ContentBroker
  Copyright (C) 2014 LVRInfoKom
  Landschaftsverband Rheinland
    
  This program is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.
    
  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
    
  You should have received a copy of the GNU General Public License
  along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

package de.uzk.hki.da.metadata;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileWriter;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.Reader;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.apache.commons.io.input.BOMInputStream;
import org.jdom.Attribute;
import org.jdom.Document;
import org.jdom.Element;
import org.jdom.JDOMException;
import org.jdom.Namespace;
import org.jdom.input.SAXBuilder;
import org.jdom.output.Format;
import org.jdom.output.XMLOutputter;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.xml.sax.InputSource;

import de.uzk.hki.da.utils.Path;
import de.uzk.hki.da.utils.XMLUtils;

/**
 * @author Polina Gubaidullina
 */

public class XMPMetadataStructure extends MetadataStructure {

    /** The logger. */
    public Logger logger = LoggerFactory.getLogger(XMPMetadataStructure.class);

    private static final Namespace RDF_NS = Namespace.getNamespace("http://www.w3.org/1999/02/22-rdf-syntax-ns#");
    private File xmpFile;
    private List<Element> descriptionElements;
    private Document rdfDoc;
    private List<de.uzk.hki.da.model.Document> currentDocuments;

    public XMPMetadataStructure(Path workPath, File metadataFile, List<de.uzk.hki.da.model.Document> documents)
            throws FileNotFoundException, JDOMException, IOException {
        super(workPath, metadataFile, documents);

        logger.debug("Instantiate new xmp metadata structure with metadata file " + metadataFile.getAbsolutePath()
                + " ... ");

        xmpFile = metadataFile;
        currentDocuments = documents;

        SAXBuilder builder = XMLUtils.createNonvalidatingSaxBuilder();
        FileInputStream fileInputStream = new FileInputStream(Path.makeFile(workPath, xmpFile.getPath()));
        BOMInputStream bomInputStream = new BOMInputStream(fileInputStream);
        Reader reader = new InputStreamReader(bomInputStream, "UTF-8");
        InputSource is = new InputSource(reader);
        is.setEncoding("UTF-8");
        rdfDoc = builder.build(is);

        descriptionElements = getXMPDescriptionElements();
        fileInputStream.close();
        bomInputStream.close();
        reader.close();
    }

    //   ::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::  GETTER  ::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::

    @Override
    public File getMetadataFile() {
        return xmpFile;
    }

    private List<String> getReferences(List<Element> descriptionElements) {
        List<String> references = new ArrayList<String>();
        for (Element element : descriptionElements) {
            if (element.getName().equals("Description")) {
                String reference = element.getAttributeValue("about", RDF_NS);
                references.add(reference);
            }
        }
        return references;
    }

    @SuppressWarnings("unchecked")
    private List<Element> getXMPDescriptionElements() {
        List<Element> descriptionElements = new ArrayList<Element>();
        for (Element element : (List<Element>) rdfDoc.getRootElement().getChildren()) {
            if (element.getName().equals("Description")) {
                descriptionElements.add(element);
            }
        }
        return descriptionElements;
    }

    //   :::::::::::::::::::::::::::::::::::::::::::::::::::::::::  REPLACEMENTS  :::::::::::::::::::::::::::::::::::::::::::::::::::::::::

    public void makeReplacementsInRDf(Map<String, String> replacements) throws IOException {
        for (Element element : descriptionElements) {
            if (element.getName().equals("Description")) {
                Attribute attr = element.getAttribute("about", RDF_NS);
                for (String ref : replacements.keySet()) {
                    if (ref.equals(attr.getValue())) {
                        logger.debug("Replace " + ref + " by " + replacements.get(ref));
                        attr.setValue(replacements.get(ref));
                    }
                }
            }
        }
        XMLOutputter outputter = new XMLOutputter();
        outputter.setFormat(Format.getPrettyFormat());
        outputter.output(rdfDoc, new FileWriter(Path.makeFile(workPath, xmpFile.getPath())));
    }

    //   :::::::::::::::::::::::::::::::::::::::::::::::::::::::::   VALIDATION   :::::::::::::::::::::::::::::::::::::::::::::::::::::::::

    private boolean checkReferencedFiles() {
        Boolean valid = true;
        if (getReferences(descriptionElements).size() == 0) {
            logger.error("XMP.xml does not contain any file references");
            valid = false;
        }
        List<String> references = getReferences(descriptionElements);
        List<File> existingFiles = getReferencedFiles(xmpFile, references, currentDocuments);
        if (getReferences(descriptionElements).size() != existingFiles.size()) {
            valid = false;
        }
        return valid;
    }

    @Override
    public boolean isValid() {
        return checkReferencedFiles();
    }

    @Override
    public HashMap<String, HashMap<String, List<String>>> getIndexInfo(String ObjectId) {
        return null;
    }
}