org.dspace.external.model.ExternalDataObject Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dspace-api Show documentation
DSpace core data model and service APIs.
The newest version!
/**
 * The contents of this file are subject to the license and copyright
 * detailed in the LICENSE and NOTICE files at the root of the source
 * tree and available online at
 *
 * http://www.dspace.org/license/
 */
package org.dspace.external.model;

import java.util.ArrayList;
import java.util.List;
import java.util.Objects;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.dspace.content.dto.MetadataValueDTO;

/**
 * The representation model object for external data
 */
public class ExternalDataObject {

    /**
     * This field determines the ID for the ExternalDataObject
     */
    private String id;
    /**
     * This field determines the value for the ExternalDataObject
     */
    private String value;
    /**
     * This field determines where the ExternalData came from
     */
    private String source;
    /**
     * The list of Metadata values. These our MetadataValueDTO because they won't exist in the DB
     */
    private List metadata = new ArrayList<>();
    /**
     * The display value of the ExternalDataObject
     */
    private String displayValue;

    private Logger log = LogManager.getLogger(ExternalDataObject.class);

    /**
     * Default constructor
     */
    public ExternalDataObject() {

    }

    /**
     * Constructor for the ExternalDataObject with as parameter the source of where it came from
     * @param source    The source where the ExternalDataObject came from
     */
    public ExternalDataObject(String source) {
        this.source = source;
    }

    /**
     * Generic getter for the source
     * @return  The source
     */
    public String getSource() {
        return source;
    }

    /**
     * Generic setter for the source
     * @param source    The source to be set
     */
    public void setSource(String source) {
        this.source = source;
    }

    /**
     * Generic getter for the Metadata
     * @return  The metadata
     */
    public List getMetadata() {
        return metadata;
    }

    /**
     * Generic setter for the Metadata
     * @param metadata  The metadata to be set
     */
    public void setMetadata(List metadata) {
        this.metadata = metadata;
    }

    /**
     * This method will add a Metadata value to the list of metadata values
     * @param metadataValueDTO The metadata value to be added.
     */
    public void addMetadata(MetadataValueDTO metadataValueDTO) {
        if (metadata == null) {
            metadata = new ArrayList<>();
        }
        metadata.add(metadataValueDTO);
    }

    /**
     * Generic getter for the display value
     * @return  The display value
     */
    public String getDisplayValue() {
        return displayValue;
    }

    /**
     * Generic setter for the display value
     * @param displayValue  The display value to be set
     */
    public void setDisplayValue(String displayValue) {
        this.displayValue = displayValue;
    }

    /**
     * Generic getter for the ID
     * @return  The id
     */
    public String getId() {
        return id;
    }

    /**
     * Generic setter for the ID
     * @param id    The id to be set
     */
    public void setId(String id) {
        this.id = id;
    }

    /**
     * Generic getter for the value
     * @return the value value of this ExternalDataObject
     */
    public String getValue() {
        return value;
    }

    /**
     * Generic setter for the value
     * @param value   The value to be set on this ExternalDataObject
     */
    public void setValue(String value) {
        this.value = value;
    }

    /**
     * Sort metadata before printing, to help with comparison by eye
     * @return
     */
    @Override
    public String toString() {
        List thisMetadata = new ArrayList<>(this.metadata);
        thisMetadata.sort(MetadataValueDTO.comparator());
        return "ExternalDataObject{" +
                "id='" + id + '\'' +
                ", value='" + value + '\'' +
                ", source='" + source + '\'' +
                ", displayValue='" + displayValue + '\'' +
                ", metadata=" + thisMetadata +
                '}';
    }

    /**
     * Equality test for ExternalDataObject takes into account the fact that we might have
     * lists of metadata values which are identical except for sort order, so we sort and compare these
     * using a custom comparator.
     * @param o The other object ("that") with which to compare this object ("this")
     * @return  true if objects are identical, false if not
     */
    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        ExternalDataObject that = (ExternalDataObject) o;
        // Compare *sorted* lists
        List thisMetadata = new ArrayList<>(this.metadata);
        List thatMetadata = new ArrayList<>(that.metadata);
        // Sort both lists using our custom comparator
        thisMetadata.sort(MetadataValueDTO.comparator());
        thatMetadata.sort(MetadataValueDTO.comparator());

        // Return straight comparisons of basic member variables
        return Objects.equals(id, that.id) &&
                Objects.equals(value, that.value) &&
                Objects.equals(source, that.source) &&
                Objects.equals(displayValue, that.displayValue) &&
                // Compare the sorted lists rather than the raw stored metadata
                Objects.equals(thisMetadata, thatMetadata);
    }

    /**
     * Explicit override of Object hashCode()
     * @return
     */
    @Override
    public int hashCode() {
        return Objects.hash(id, value, source, metadata, displayValue);
    }

}