nl.vpro.domain.media.support.Description Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of media-domain Show documentation

The basic domain classes for 'media', the core of POMS. Also, the 'update' XML bindings for it. It also contains some closely related domain classes like the enum to contain NICAM kijkwijzer settings.

There is a newer version: 8.3.1

Show newest version

package nl.vpro.domain.media.support;

import java.io.Serial;
import java.io.Serializable;

import jakarta.persistence.*;
import jakarta.validation.constraints.NotNull;
import jakarta.validation.constraints.Size;
import jakarta.xml.bind.Unmarshaller;
import jakarta.xml.bind.annotation.*;

import org.checkerframework.checker.nullness.qual.NonNull;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;

import nl.vpro.domain.*;
import nl.vpro.domain.media.MediaObject;
import nl.vpro.validation.NoHtml;

/**
 * A {@link MediaObject} can have more than one description which should differ in type and
 * owner. See {@link Title} for further explanation of this class behaviour.
 *
 * @author Roelof Jan Koekoek
 * @see Title
 * @since 0.4
 */
@Entity
@XmlAccessorType(XmlAccessType.NONE)
@XmlType(name = "descriptionType",
    namespace = Xmlns.MEDIA_NAMESPACE)
@JsonPropertyOrder({"value", "owner", "type"})
public class Description extends AbstractOwnedText implements Serializable, Child {

    @Serial
    private static final long serialVersionUID = 1L;

    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    @XmlTransient
    private Long id;

    @Column(nullable = false)
    @NotNull(message = "description not set")
    @NoHtml(aggressive = false)
    @XmlValue
    @JsonProperty("value")
    @Size.List({
        @Size(min = 1, message = "{nl.vpro.constraints.text.Size.min}"),
        @Size(max = 64000, message = "{nl.vpro.constraints.text.Size.max}")
    })
    protected String value;

    @XmlTransient
    @ManyToOne(targetEntity = MediaObject.class)
    protected MediaObject parent;

    public Description() {
    }

    public Description(@NonNull String description, OwnerType owner, TextualType type) {
        super(owner, type);
        this.value = description;
    }

    public Description(Description source) {
        this(source, source.parent);
    }


    public Description(Description source, MediaObject parent) {
        this(source.get(), source.getOwner(), source.getType());
        this.parent = parent;
    }

    public static Description copy(Description source){
        return source == null ? null : copy(source, source.parent);
    }

    public static Description copy(Description source, MediaObject parent){
        return source == null ? null : new Description(source, parent);
    }

    public static Description main(String main, OwnerType type) {
        return new Description(main, type, TextualType.MAIN);
    }

    @Override
    public String get() {
        return value;
    }
    @Override
    public void set(String s) {
        this.value = strip(s);
    }

    protected static String strip(String s) {
        if (s == null) {
            return null;
        }
        return s.replaceAll("[\f\\u0085\\u2028\\u2029  ]", "\n");
    }

    @Override
    @XmlTransient
    public MediaObject getParent() {
        return parent;
    }

    @Override
    public void setParent(MediaObject parent) {
        this.parent = parent;
    }

    protected Long getId() {
        return id;
    }

    protected void setId(Long id) {
        this.id = id;
    }

    @Override
    public boolean equals(Object o) {
        if(this == o) {
            return true;
        }
        if(o == null || getClass() != o.getClass()) {
            return false;
        }

        Description desc = (Description)o;

        if (parent == null && desc.getParent() == null) {
            return owner == desc.getOwner() && type == desc.getType();
        }

        return owner == desc.getOwner() && type == desc.getType() && parent.equals(desc.getParent());

    }

    void afterUnmarshal(Unmarshaller unmarshaller, Object parent) {
        this.parent = (MediaObject) parent;
    }
}