org.mycore.datamodel.metadata.MCRBase 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
*
* @exception MCRException
* general Exception of MyCoRe
*/
public MCRBase() throws MCRException {
mcrLabel = "";
mcrVersion = MCRCoreVersion.getVersion();
mcrSchema = "";
// Service class
mcrService = new MCRObjectService();
}
protected void setFromJDOM(Document doc) {
jdomDocument = doc;
setUp();
}
protected void setUp() {
if (jdomDocument == null) {
throw new MCRException("The JDOM document is null or empty.");
}
Element rootElement = jdomDocument.getRootElement();
setId(MCRObjectID.getInstance(rootElement.getAttributeValue("ID")));
setLabel(rootElement.getAttributeValue("label"));
setVersion(rootElement.getAttributeValue("version"));
setSchema(rootElement.getAttribute("noNamespaceSchemaLocation", XSI_NAMESPACE).getValue());
// get the service data of the object
Element serviceElement = rootElement.getChild("service");
if (serviceElement != null) {
mcrService.setFromDOM(serviceElement);
}
}
/**
* This methode return the object id. If this is not set, null was returned.
*
* @return the id as MCRObjectID
*/
public final MCRObjectID getId() {
return mcrId;
}
/**
* This methode return the object label. If this is not set, null was
* returned.
*
* @return the lable as a string
*/
public final String getLabel() {
return mcrLabel;
}
/**
* This methode return the MyCoRe version of the data structure.
*
* @return the version as a string
*/
public final String getVersion() {
return mcrVersion;
}
/**
* Method returns the object schema. If the schema is not set null will be returned.
*
* @return the schema as a string
*/
public final String getSchema() {
return mcrSchema;
}
/**
* This methode return the instance of the MCRObjectService class. If this
* was not found, null was returned.
*
* @return the instance of the MCRObjectService class
*/
public final MCRObjectService getService() {
return mcrService;
}
/**
* This method read the XML input stream from an URI to build up the
* MyCoRe-Object.
*
* @param uri
* an URI
* @exception MCRException
* general Exception of MyCoRe
*/
protected final void setFromURI(URI uri) throws MCRException, SAXParseException, IOException {
Document jdom = MCRXMLParserFactory.getParser().parseXML(new MCRURLContent(uri.toURL()));
setFromJDOM(jdom);
}
/**
* This method read the XML input stream from a byte array to build up the
* MyCoRe-Object.
*
* @param xml
* a XML string
* @exception MCRException
* general Exception of MyCoRe
*/
protected final void setFromXML(byte[] xml, boolean valid) throws MCRException, SAXParseException {
Document jdom = MCRXMLParserFactory.getParser(valid).parseXML(new MCRByteContent(xml));
setFromJDOM(jdom);
}
/**
* This method set the object ID.
*
* @param id
* the object ID
*/
public void setId(MCRObjectID id) {
mcrId = id;
}
/**
* This method set the object label.
*
* @param label
* the object label
*/
public final void setLabel(String label) {
if (label == null) {
mcrLabel = label;
} else {
mcrLabel = label.trim();
if (mcrLabel.length() > MAX_LABEL_LENGTH) {
mcrLabel = mcrLabel.substring(0, MAX_LABEL_LENGTH);
}
}
}
/**
* This methods set the MyCoRe version to the string 'Version 1.3'.
*/
public final void setVersion(String version) {
mcrVersion = version != null ? version : MCRCoreVersion.getVersion();
}
/**
* This methode set the object schema.
*
* @param schema
* the object schema
*/
public final void setSchema(String schema) {
if (schema == null) {
mcrSchema = "";
return;
}
mcrSchema = schema.trim();
}
/**
* This method create a XML stream for all object data.
*
* @exception MCRException
* if the content of this class is not valid
* @return a JDOM Document with the XML data of the object as byte array
*/
public Document createXML() throws MCRException {
validate();
Element elm = new Element(getRootTagName());
Document doc = new Document(elm);
elm.addNamespaceDeclaration(XSI_NAMESPACE);
elm.addNamespaceDeclaration(XLINK_NAMESPACE);
elm.setAttribute("noNamespaceSchemaLocation", mcrSchema, XSI_NAMESPACE);
elm.setAttribute("ID", mcrId.toString());
if (mcrLabel != null) {
elm.setAttribute("label", mcrLabel);
}
elm.setAttribute("version", mcrVersion);
return doc;
}
/**
* Creates the JSON representation of this object.
*
*
* {
* id: "mycore_project_00000001",
* label: "my mycore base object",
* version: "3.0"
* }
*
*
*/
public JsonObject createJSON() {
JsonObject base = new JsonObject();
base.addProperty("id", mcrId.toString());
if (mcrLabel != null) {
base.addProperty("label", mcrLabel);
}
base.addProperty("version", mcrVersion);
return base;
}
protected abstract String getRootTagName();
/**
* This method check the validation of the content of this class. The method
* returns true if
*
* - the mcr_id value is valid
*
- the label value is not null or empty
*
* otherwise the method return false
*
* @return a boolean value
*/
public boolean isValid() {
try {
validate();
return true;
} catch (MCRException exc) {
LOGGER.warn("The content of this object '{}' is invalid.", mcrId, exc);
}
return false;
}
/**
* Validates the content of this class. This method throws an exception if:
*
* - the mcr_id is null
* - the XML schema is null or empty
* - the service part is null or invalid
*
*
* @throws MCRException the content is invalid
*/
public void validate() throws MCRException {
if (mcrId == null) {
throw new MCRException("MCRObjectID is undefined.");
}
if (getSchema() == null || getSchema().length() == 0) {
throw new MCRException("XML Schema of '" + mcrId + "' is undefined.");
}
MCRObjectService service = getService();
if (service == null) {
throw new MCRException("The part of '" + mcrId + "' is undefined.");
}
try {
service.validate();
} catch (MCRException exc) {
throw new MCRException("The part of '" + mcrId + "' is invalid.", exc);
}
}
public boolean isImportMode() {
return importMode;
}
public void setImportMode(boolean importMode) {
this.importMode = importMode;
}
@Override
public String toString() {
return this.mcrId.toString();
}
}