org.mycore.datamodel.classifications2.model.MCRClass 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.model;

import java.net.URI;
import java.util.ArrayList;
import java.util.List;
import java.util.Optional;
import java.util.stream.Collectors;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlElementWrapper;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlSeeAlso;
import javax.xml.bind.annotation.XmlType;
import javax.xml.bind.annotation.adapters.NormalizedStringAdapter;
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;

import org.mycore.datamodel.classifications2.MCRCategory;
import org.mycore.datamodel.classifications2.MCRCategoryID;
import org.mycore.datamodel.classifications2.MCRLabel;
import org.mycore.datamodel.classifications2.impl.MCRCategoryImpl;

import com.fasterxml.jackson.annotation.JsonGetter;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;

@XmlRootElement(name = "mycoreclass")
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "MCRClass",
    propOrder = {
        "label",
        "url",
        "categories"
    })
@XmlSeeAlso({ MCRClassCategory.class, MCRClassURL.class, MCRLabel.class })
@JsonInclude(value = JsonInclude.Include.NON_EMPTY)
@JsonPropertyOrder({ "ID", "url", "labels", "categories" })
public class MCRClass {

    @XmlElement(required = true)
    protected List label;

    protected MCRClassURL url;

    @XmlElementWrapper(name = "categories")
    @XmlElement(name = "category")
    protected List categories;

    @XmlAttribute(name = "ID", required = true)
    @XmlJavaTypeAdapter(NormalizedStringAdapter.class)
    protected String id;

    @JsonGetter("labels")
    public List getLabel() {
        if (label == null) {
            label = new ArrayList<>();
        }
        return this.label;
    }

    public MCRClassURL getUrl() {
        return url;
    }

    public void setUrl(MCRClassURL value) {
        this.url = value;
    }

    @JsonGetter("categories")
    public List getCategories() {
        return categories;
    }

    public void setCategories(List value) {
        this.categories = value;
    }

    @JsonGetter
    public String getID() {
        return id;
    }

    public void setID(String value) {
        this.id = value;
    }

    public static MCRClass getClassification(MCRCategory rootCategory) {
        if (!rootCategory.getId().isRootID()) {
            throw new IllegalArgumentException("Not a root category");
        }
        MCRClass mcrClass = new MCRClass();
        mcrClass.setID(rootCategory.getId().getRootID());
        mcrClass.setUrl(MCRClassURL.getInstance(rootCategory.getURI()));
        mcrClass.getLabel()
            .addAll(
                rootCategory.getLabels()
                    .stream()
                    .map(MCRLabel::clone)
                    .collect(Collectors.toList()));
        mcrClass.setCategories(MCRClassCategory.getInstance(rootCategory.getChildren()));
        return mcrClass;
    }

    public MCRCategory toCategory() {
        MCRCategoryImpl category = new MCRCategoryImpl();
        category.setId(MCRCategoryID.rootID(getID()));
        category.setLevel(0);
        URI uri = Optional.ofNullable(getUrl())
            .map(MCRClassURL::getHref)
            .map(URI::create)
            .orElse(null);
        category.setURI(uri);
        category.getLabels()
            .addAll(getLabel().stream()
                .map(MCRLabel::clone)
                .collect(Collectors.toList()));
        return category;
    }

    public static MCRCategory buildCategory(String classID, MCRClassCategory e, MCRCategory parent) {
        MCRCategoryImpl category = new MCRCategoryImpl();
        //setId must be called before setParent (info important)
        category.setId(new MCRCategoryID(classID, e.getID()));
        category.setRoot(parent.getRoot());
        category.setChildren(new ArrayList<>());
        category.setParent(parent);
        category.getLabels()
            .addAll(e.getLabel().stream()
                .map(MCRLabel::clone)
                .collect(Collectors.toList()));
        category.setLevel(parent.getLevel() + 1);
        URI uri = Optional.ofNullable(e.getUrl())
            .map(MCRClassURL::getHref)
            .map(URI::create)
            .orElse(null);
        category.setURI(uri);
        for (MCRClassCategory child : e.getCategory()) {
            buildCategory(classID, child, category);
        }
        return category;
    }

}