nl.vpro.w3.rdf.Description Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gtaa-domain Show documentation
Contains java bindings for the objects served out by Openskos/GTAA
There is a newer version: 8.3.0
/*
 * Copyright (C) 2015 Licensed under the Apache License, Version 2.0
 * VPRO The Netherlands
 */
package nl.vpro.w3.rdf;

import lombok.*;

import java.net.URI;
import java.time.ZonedDateTime;
import java.util.*;
import java.util.stream.Stream;

import jakarta.xml.bind.annotation.*;
import jakarta.xml.bind.annotation.adapters.XmlJavaTypeAdapter;

import org.apache.commons.lang3.StringUtils;

import nl.vpro.domain.gtaa.*;
import nl.vpro.dublincore.terms.Date;
import nl.vpro.openarchives.oai.Label;
import nl.vpro.openarchives.oai.Note;
import nl.vpro.xml.bind.ZonedDateTimeXmlAdapter;

import static nl.vpro.openarchives.oai.Namespaces.*;

/**
 *
 * @author Roelof Jan Koekoek
 * @since 3.7
 */
@XmlAccessorType(XmlAccessType.NONE)
@XmlType(propOrder = {
    "type",
    "editorialNote",
    "creatorResource",
    "modifiedBy",
    "prefLabel",
    "xlPrefLabel",
    "modified",
    "uuid",
    "set",
    "inScheme",
    "notation",
    "creator",
    "status",
    "tenant",
    "acceptedBy",
    "dateAccepted",
    "dateSubmitted",
    "hiddenLabels",
    "xlHiddenLabels",
    "historyNote",
    "altLabels",
    "xlAltLabels",
    "scopeNote",
    "changeNote"
})
@ToString
@Data
@EqualsAndHashCode(callSuper = true)
public class Description extends AbstractGTAAObject {

    private static final String FORWARD = "Forward:";

    @XmlElement
    private ResourceElement type;

    @XmlElement(namespace = OPEN_SKOS)
    private Status status;

    @XmlElement(namespace = OPEN_SKOS)
    private String tenant;

    @XmlElement(namespace = OPEN_SKOS)
    private ResourceElement modifiedBy;

    @XmlElement(namespace = OPEN_SKOS)
    private String acceptedBy;

    @XmlElement(namespace = SKOS)
    private String notation;

    @XmlElement(namespace = DC_TERMS)
    @XmlJavaTypeAdapter(ZonedDateTimeXmlAdapter.class)
    private ZonedDateTime dateAccepted;

    @XmlElement(namespace = DC_TERMS_ELEMENTS)
    private String creator;

    @XmlElement(namespace = DC_TERMS, name = "creator")
    private ResourceElement creatorResource;

    @XmlElement(namespace = DC_TERMS)
    @XmlJavaTypeAdapter(ZonedDateTimeXmlAdapter.class)
    private ZonedDateTime dateSubmitted;

    @XmlElement(namespace = DC_TERMS)
    private Date modified;

    @XmlElement(namespace = OPEN_SKOS)
    private UUID uuid;

    @XmlElement(namespace = OPEN_SKOS)
    private ResourceElement set;

    @XmlElement(namespace = SKOS)
    private ResourceElement inScheme;

    @XmlElement(namespace = SKOS, name = "prefLabel")
    private Label prefLabel;

    @XmlElement(namespace = SKOS_XL, name = "prefLabel")
    private XLLabel xlPrefLabel;

    @XmlElement(namespace = SKOS, name = "hiddenLabel")
    @Singular
    private List hiddenLabels;

    @XmlElement(namespace = SKOS_XL, name = "hiddenLabel")
    @Singular
    private List xlHiddenLabels;

    @XmlElement(namespace = SKOS)
    private Note historyNote;

    @XmlElement(namespace = SKOS, name = "altLabel")
    private List altLabels;

    @XmlElement(namespace = SKOS_XL, name = "altLabel")
    @Singular
    private List xlAltLabels;

    @XmlElement(namespace = SKOS)
    private List changeNote;

    @XmlElement(namespace = SKOS)
    private List scopeNote;

    @XmlElement(namespace = SKOS)
    private List editorialNote;

    public Description() {
    }

    public Description(String prefLabel) {
        this.prefLabel = new Label(prefLabel);
    }

    @lombok.Builder(builderClassName = "Builder")
    private Description(UUID uuid, URI about, ResourceElement type, Status status, String tenant, ResourceElement modifiedBy, String acceptedBy, String notation, ZonedDateTime dateAccepted, String creator, ResourceElement creatorResource, ZonedDateTime dateSubmitted, Date modified, UUID uuid1, ResourceElement set, ResourceElement inScheme, Label prefLabel, XLLabel xlPrefLabel, List hiddenLabels, List xlHiddenLabels, Note historyNote, List altLabels, List xlAltLabels, List changeNote, List scopeNote, List editorialNote) {
        super(uuid, about);
        this.type = type;
        this.status = status;
        this.tenant = tenant;
        this.modifiedBy = modifiedBy;
        this.acceptedBy = acceptedBy;
        this.notation = notation;
        this.dateAccepted = dateAccepted;
        this.creator = creator;
        this.creatorResource = creatorResource;
        this.dateSubmitted = dateSubmitted;
        this.modified = modified;
        this.uuid = uuid1;
        this.set = set;
        this.inScheme = inScheme;
        this.prefLabel = prefLabel;
        this.xlPrefLabel = xlPrefLabel;
        this.hiddenLabels = hiddenLabels;
        this.xlHiddenLabels = xlHiddenLabels;
        this.historyNote = historyNote;
        this.altLabels = altLabels;
        this.xlAltLabels = xlAltLabels;
        this.changeNote = changeNote;
        this.scopeNote = scopeNote;
        this.editorialNote = editorialNote;
    }

    public boolean isPerson() {
        return getSimpleType().equals(Scheme.person.getId());
    }

    public boolean isGeoLocation() {
        return getSimpleType().equals(Scheme.geographicname.getId());
    }

    public String getSimpleType() {
        return StringUtils.substringAfterLast(getInScheme().getResource(), "/");
    }

    public Optional getRedirectedFrom() {
        return getCleanChangeNote().filter(note -> StringUtils.contains(note, FORWARD)).map(note -> StringUtils.substringAfter(note, FORWARD)).map(URI::create).findAny();
    }

    private Stream getCleanChangeNote() {
        return getChangeNote().stream().map(StringUtils::deleteWhitespace);
    }

    public static class Builder extends AbstractBuilder {

        public Builder type(String type) {
            this.type = ResourceElement.builder().resource(type).build();
            return this;
        }

        public Builder inScheme(String scheme) {
            this.inScheme = ResourceElement.builder().resource(scheme).build();
            return this;
        }

        public Builder inScheme(Scheme scheme) {
            this.inScheme = ResourceElement.builder().resource(scheme.getUrl()).build();
            return this;
        }

        public Builder prefLabelOrXL(boolean useXlLablel, String label, String tenant) {
            if (useXlLablel) {
                return xlPrefLabel(new XLLabel(label, tenant));
            } else {
                return prefLabel(new Label(label));
            }
        }

    }

    public void addChangeNote(String note) {
        if (changeNote == null) {
            this.changeNote = new ArrayList<>();
        }
        this.changeNote.add(note);
    }
}