MCRMetaDateLangText

/*
 * 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 <http://www.gnu.org/licenses/>.
 */

package org.mycore.datamodel.metadata;

import com.google.gson.JsonObject;
import org.jdom2.Element;
import org.mycore.common.MCRException;
import org.mycore.datamodel.common.MCRISO8601Date;
import org.mycore.datamodel.common.MCRISO8601Format;

import java.util.Objects;

/**
 * This class implements all method for handling with the MCRMetaDateLangText part
 * of a metadata object. The MCRMetaDateLangText class present a single item, which
 * has quadruples of a text and his corresponding language and optional a type and date.
 *
 * @version $Revision$ $Date$
 */
public class MCRMetaDateLangText extends MCRMetaLangText {

    protected MCRISO8601Date isoDate;

    /**
     * This is the constructor. <br>
     * The language element was set to <b>en </b>. All other elements was set to
     * an empty string. The <em>form</em> Attribute is set to 'plain'.
     */
    public MCRMetaDateLangText() {
        super();
    }

    /**
     * This is the constructor. <br>
     * The language element was set. If the value of <em>lang</em> is
     * null, empty or false <b>en </b> was set. The subtag element was set to
     * the value of <em>subtag</em>. If the value of <em>subtag</em>
     * is null or empty an exception was thrown. The type element was set to
     * the value of <em>type</em>, if it is null, an empty string was set
     * to the type element. The text element was set to the value of
     * <em>text</em>, if it is null, an empty string was set
     * to the text element.
     * @param subtag       the name of the subtag
     * @param lang     the default language
     * @param type         the optional type string
     * @param inherted     a value &gt;= 0
     * @param form         the format string, if it is empty 'plain' is set.
     * @param text         the text string
     *
     * @exception MCRException if the subtag value is null or empty
     */
    public MCRMetaDateLangText(String subtag, String lang, String type, int inherted, String form, String text)
        throws MCRException {
        super(subtag, lang, type, inherted, form, text);
    }

    /**
     * sets the date for this meta data object
     *
     * @param isoDate
     *            the new date, may be null
     */
    public void setDate(MCRISO8601Date isoDate) {
        this.isoDate = isoDate;
    }

    /**
     * Returns the date.
     *
     * @return the date, may be null
     */
    public MCRISO8601Date getDate() {
        return isoDate;
    }

    /**
     * This method read the XML input stream part from a DOM part for the
     * metadata of the document.
     *
     * @param element
     *            a relevant JDOM element for the metadata
     */
    @Override
    public void setFromDOM(Element element) {
        super.setFromDOM(element);

        String tempDate = element.getAttributeValue("date");

        if (tempDate != null) {

            MCRISO8601Date tempIsoDate = new MCRISO8601Date();

            String tempFormat = element.getAttributeValue("format");

            if (tempFormat != null) {
                tempIsoDate.setFormat(tempFormat);
            }

            tempIsoDate.setDate(tempDate);

            isoDate = tempIsoDate;

        }
    }

    /**
     * This method create a XML stream for all data in this class, defined by
     * the MyCoRe XML MCRMetaLangText definition for the given subtag.
     *
     * @exception MCRException
     *                if the content of this class is not valid
     * @return a JDOM Element with the XML MCRMetaLangText part
     */
    @Override
    public Element createXML() throws MCRException {
        Element elm = super.createXML();

        if (isoDate != null) {
            elm.setAttribute("date", isoDate.getISOString());
            MCRISO8601Format isoFormat = isoDate.getIsoFormat();
            if (isoFormat != null && isoFormat != MCRISO8601Format.COMPLETE_HH_MM_SS_SSS) {
                elm.setAttribute("format", isoDate.getIsoFormat().toString());
            }
        }

        return elm;
    }

    /**
     * Creates the JSON representation. Extends the {@link MCRMetaLangText#createJSON()} method
     * with the following data.
     *
     * <pre>
     *   {
     *     text: "Hallo Welt",
     *     form: "plain",
     *     date: "2000-01-01",
     *     format: "YYYY-MM-DD"
     *   }
     * </pre>
     *
     */
    @Override
    public JsonObject createJSON() {
        JsonObject obj = super.createJSON();
        if (isoDate != null) {
            obj.addProperty("date", isoDate.getISOString());
            MCRISO8601Format isoFormat = isoDate.getIsoFormat();
            if (isoFormat != null) {
                obj.addProperty("format", isoDate.getIsoFormat().toString());
            }
        }
        return obj;
    }

    /**
     * clone of this instance
     *
     * you will get a (deep) clone of this element
     *
     * @see Object#clone()
     */
    @Override
    public MCRMetaDateLangText clone() {
        MCRMetaDateLangText clone = (MCRMetaDateLangText) super.clone();

        clone.isoDate = this.isoDate; // this is ok because iso Date is immutable

        return clone;
    }

    /**
     * Check the equivalence between this instance and the given object.
     *
     * @param obj the MCRMetaDateLangText object
     * @return true if its equal
     */
    @Override
    public boolean equals(Object obj) {
        if (!super.equals(obj)) {
            return false;
        }
        final MCRMetaDateLangText other = (MCRMetaDateLangText) obj;
        return Objects.equals(this.text, other.text) && Objects.equals(this.form, other.form)
            && Objects.equals(this.isoDate, other.isoDate);
    }

}