org.mycore.datamodel.classifications2.utils.MCRClassificationUtils Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of mycore-base Show documentation
There is a newer version: 2024.05
/*
 * This file is part of ***  M y C o R e  ***
 * See http://www.mycore.de/ for details.
 *
 * MyCoRe 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.
 *
 * MyCoRe 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 MyCoRe.  If not, see .
 */

package org.mycore.datamodel.classifications2.utils;

import static org.mycore.access.MCRAccessManager.PERMISSION_WRITE;

import java.io.IOException;
import java.io.InputStream;
import java.net.URISyntaxException;
import java.nio.file.Files;
import java.nio.file.Path;

import org.jdom2.Document;
import org.jdom2.output.Format;
import org.jdom2.output.XMLOutputter;
import org.mycore.access.MCRAccessException;
import org.mycore.access.MCRAccessManager;
import org.mycore.common.MCRException;
import org.mycore.common.content.MCRStreamContent;
import org.mycore.common.xml.MCRXMLParserFactory;
import org.mycore.datamodel.classifications2.MCRCategory;
import org.mycore.datamodel.classifications2.MCRCategoryDAO;
import org.mycore.datamodel.classifications2.MCRCategoryDAOFactory;
import org.mycore.datamodel.classifications2.MCRCategoryID;
import org.xml.sax.SAXParseException;

/**
 * This class contains helper methods to handle mycore classifications.
 * 
 * @author Matthias Eichner
 */
public class MCRClassificationUtils {

    public static final String CREATE_CLASS_PERMISSION = "create-class";

    /**
     * Returns the classification as string. Returns null if the
     * classification does not exists.
     * 
     * @param classId the classification root id
     * @return the classification as string
     */
    public static String asString(String classId) {
        Document xml = asDocument(classId);
        return new XMLOutputter(Format.getPrettyFormat()).outputString(xml);
    }

    /**
     * Returns the classification as a jdom document. Returns null if the
     * classification does not exists.
     * 
     * @param classId the classification root id
     * @return the classification as jdom document
     */
    public static Document asDocument(String classId) {
        MCRCategoryID categoryId = MCRCategoryID.rootID(classId);
        MCRCategory classification = MCRCategoryDAOFactory.getInstance().getRootCategory(categoryId, -1);
        if (classification == null) {
            return null;
        }
        return MCRCategoryTransformer.getMetaDataDocument(classification, false);
    }

    /**
     * Imports a classification from the given path. If the classification
     * already exists, it will be replaced.
     * 
     * @param pathToClassification path to the classification
     * @throws IOException could not read from file
     * @throws MCRException xml parsing went wrong
     * @throws SAXParseException xml parsing went wrong
     * @throws URISyntaxException unable to transform the xml to a {@link MCRCategory}
     * @throws MCRAccessException you are not allowed to import the classification
     */
    public static void fromPath(Path pathToClassification)
        throws IOException, MCRException, SAXParseException, MCRAccessException, URISyntaxException {
        InputStream inputStream = Files.newInputStream(pathToClassification);
        fromStream(inputStream);
    }

    /**
     * Imports a classification from the given input stream. If the classification
     * already exists, it will be replaced.
     * 
     * @param inputStream the classification stream
     * @throws MCRException xml parsing went wrong
     * @throws SAXParseException xml parsing went wrong
     * @throws URISyntaxException unable to transform the xml to a {@link MCRCategory}
     * @throws MCRAccessException you are not allowed to import the classification
     */
    public static void fromStream(InputStream inputStream)
        throws MCRException, SAXParseException, URISyntaxException, MCRAccessException {
        MCRCategoryDAO categoryDAO = MCRCategoryDAOFactory.getInstance();
        Document jdom = MCRXMLParserFactory.getParser().parseXML(new MCRStreamContent(inputStream));
        MCRCategory classification = MCRXMLTransformer.getCategory(jdom);
        if (categoryDAO.exist(classification.getId())) {
            if (!MCRAccessManager.checkPermission(classification.getId().getRootID(), PERMISSION_WRITE)) {
                throw MCRAccessException.missingPermission(
                    "update classification " + classification.getId().getRootID(), classification.getId().getRootID(),
                    PERMISSION_WRITE);
            }
            categoryDAO.replaceCategory(classification);
        } else {
            if (!MCRAccessManager.checkPermission(CREATE_CLASS_PERMISSION)) {
                throw MCRAccessException.missingPermission(
                    "create classification " + classification.getId().getRootID(), classification.getId().getRootID(),
                    CREATE_CLASS_PERMISSION);
            }
            categoryDAO.addCategory(null, classification);
        }
    }

}