org.mycore.datamodel.metadata.MCRMetaISO8601Date Maven / Gradle / Ivy
/*
* 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
* {
* date: "2016-02-08",
* format: "YYYY-MM-DD"
* }
*
*/
@Override
public JsonObject createJSON() {
JsonObject obj = super.createJSON();
obj.addProperty("date", getISOString());
if (isoDate.getIsoFormat() != null) {
obj.addProperty("format", isoDate.getIsoFormat().toString());
}
return obj;
}
@Override
public void setFromDOM(Element element) {
super.setFromDOM(element);
setFormat(element.getAttributeValue("format"));
setDate(element.getTextTrim());
export = element.clone();
}
/**
* returns the namespace of this element
*
* @return Returns the ns.
*/
protected static Namespace getNs() {
return DEFAULT_NAMESPACE;
}
/**
* sets the date for this meta data object
*
* @param isoString
* Date in any form that is a valid W3C dateTime
*/
public void setDate(String isoString) {
isoDate.setDate(isoString);
}
/**
* returns the Date representing this element.
*
* @return a new Date instance of the time set in this element
*/
public Date getDate() {
return isoDate.getDate();
}
/**
* sets the date for this meta data object
*
* @param dt
* Date object representing date String in Element
*/
public void setDate(Date dt) {
isoDate.setDate(dt);
}
/**
* returns a ISO 8601 conform String using the current set format.
*
* @return date in ISO 8601 format, or null if date is unset.
*/
public String getISOString() {
return isoDate.getISOString();
}
/**
* sets the input and output format.
*
* please use only the formats defined on the W3C Page, which are also
* exported as static fields by this class.
*
* @param format
* a format string that is valid conforming to xsd:duration
* schema type.
*
*/
public void setFormat(String format) {
isoDate.setFormat(format);
}
public String getFormat() {
return isoDate == null || isoDate.getIsoFormat() == null ? null : isoDate.getIsoFormat().toString();
}
/**
* Returns the internal date.
*
* @return the base date
*/
public MCRISO8601Date getMCRISO8601Date() {
return isoDate;
}
/**
* This method put debug data to the logger (for the debug mode).
*/
@Override
public void debug() {
if (LOGGER.isDebugEnabled()) {
super.debugDefault();
LOGGER.debug("Date={}", isoDate != null ? isoDate.getISOString() : "null");
if (isoDate != null) {
MCRISO8601Format isoFormat = isoDate.getIsoFormat();
LOGGER.debug("Format={}", isoFormat);
}
}
}
/**
* clone of this instance
*
* you will get a (deep) clone of this element
*
* @see java.lang.Object#clone()
*/
@Override
public MCRMetaISO8601Date clone() {
MCRMetaISO8601Date clone = (MCRMetaISO8601Date) super.clone();
clone.changed = this.changed;
clone.export = this.export.clone();
clone.isoDate = this.isoDate; // this is ok because iso Date is immutable
return clone;
}
/**
* Validates this MCRMetaISO8601Date. This method throws an exception if:
*
* - the subtag is not null or empty
* - the lang value was supported
* - the inherited value is lower than zero
* - the isoDate or the temporal accessor is null
*
*
* @throws MCRException the MCRMetaISO8601Date is invalid
*/
public void validate() throws MCRException {
super.validate();
if (isoDate == null || isoDate.getDt() == null) {
throw new MCRException(getSubTag() + ": date is invalid");
}
}
@Override
public boolean equals(Object obj) {
if (!super.equals(obj)) {
return false;
}
final MCRMetaISO8601Date other = (MCRMetaISO8601Date) obj;
return Objects.equals(this.isoDate, other.isoDate);
}
}