Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* 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 .
*/
package org.mycore.datamodel.metadata;
import java.nio.file.Files;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import java.util.Objects;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.jdom2.Element;
import org.mycore.common.MCRException;
import org.mycore.common.MCRPersistenceException;
import org.mycore.datamodel.niofs.MCRPath;
/**
* This class implements all methode for handling one derivate data.
*
* @author Jens Kupferschmidt
* @version $Revision$ $Date: 2008-02-06 18:27:24 +0100 (Mi, 06. Feb
* 2008) $
*/
public class MCRObjectDerivate {
private static final Logger LOGGER = LogManager.getLogger();
// derivate data
private MCRMetaLinkID linkmeta;
private final ArrayList externals;
private MCRMetaIFS internals;
private final ArrayList titles;
private final ArrayList classifications;
private String derivateURN;
private boolean display;
private List files;
private MCRObjectID derivateID;
/**
* This is the constructor of the MCRObjectDerivate class. All data are set
* to null.
*/
public MCRObjectDerivate(MCRObjectID derivateID) {
linkmeta = null;
externals = new ArrayList<>();
internals = null;
titles = new ArrayList<>();
classifications = new ArrayList<>();
files = Collections.emptyList();
display = true;
this.derivateID = derivateID;
}
public MCRObjectDerivate(MCRObjectID derivateID, Element derivate) {
this(derivateID);
setFromDOM(derivate);
}
/**
* This methode read the XML input stream part from a DOM part for the
* structure data of the document.
*
* @param derivate
* a list of relevant DOM elements for the derivate
*/
private void setFromDOM(Element derivate) {
// Link to Metadata part
Element linkmetaElement = derivate.getChild("linkmetas").getChild("linkmeta");
MCRMetaLinkID link = new MCRMetaLinkID();
link.setFromDOM(linkmetaElement);
linkmeta = link;
// External part
Element externalsElement = derivate.getChild("externals");
externals.clear();
if (externalsElement != null) {
List externalList = externalsElement.getChildren();
for (Element externalElement : externalList) {
MCRMetaLink eLink = new MCRMetaLink();
eLink.setFromDOM(externalElement);
externals.add(eLink);
}
}
// Internal part
Element internalsElement = derivate.getChild("internals");
if (internalsElement != null) {
Element internalElement = internalsElement.getChild("internal");
if (internalElement != null) {
internals = new MCRMetaIFS();
internals.setFromDOM(internalElement);
}
}
// Title part
Element titlesElement = derivate.getChild("titles");
titles.clear();
if (titlesElement != null) {
List titleList = titlesElement.getChildren();
for (Element titleElement : titleList) {
MCRMetaLangText text = new MCRMetaLangText();
text.setFromDOM(titleElement);
if (text.isValid()) {
titles.add(text);
}
}
}
// Classification part
Element classificationElement = derivate.getChild("classifications");
classifications.clear();
if (classificationElement != null) {
final List classificationList = classificationElement.getChildren();
classificationList.stream().map((classElement) -> {
MCRMetaClassification clazzObject = new MCRMetaClassification();
clazzObject.setFromDOM(classElement);
return clazzObject;
}).forEach(classifications::add);
}
// fileset part
Element filesetElements = derivate.getChild("fileset");
if (filesetElements != null) {
String mainURN = filesetElements.getAttributeValue("urn");
if (mainURN != null) {
this.derivateURN = mainURN;
}
List filesInList = filesetElements.getChildren();
if (!filesInList.isEmpty()) {
files = new ArrayList<>(filesInList.size());
for (Element file : filesInList) {
files.add(new MCRFileMetadata(file));
}
}
}
String displayVal = derivate.getAttributeValue("display");
if (displayVal != null && displayVal.length() > 3) {
this.display = Boolean.valueOf(displayVal);
}
}
/**
* returns link to the MCRObject.
*
* @return a metadata link as MCRMetaLinkID
*/
public MCRMetaLinkID getMetaLink() {
return linkmeta;
}
/**
* This method set the metadata link
*
* @param link
* the MCRMetaLinkID object
*/
public final void setLinkMeta(MCRMetaLinkID link) {
linkmeta = link;
}
/**
* This method return the size of the external array.
*/
public final int getExternalSize() {
return externals.size();
}
/**
* This method get a single link from the external list as a MCRMetaLink.
*
* @exception IndexOutOfBoundsException
* throw this exception, if the index is false
* @return a external link as MCRMetaLink
*/
public final MCRMetaLink getExternal(int index) throws IndexOutOfBoundsException {
if ((index < 0) || (index > externals.size())) {
throw new IndexOutOfBoundsException("Index error in getExternal(" + index + ").");
}
return externals.get(index);
}
/**
* This method return the size of the title array.
*/
public final int getTitleSize() {
return titles.size();
}
/**
* This method get a single text from the titles list as a MCRMetaLangText.
*
* @exception IndexOutOfBoundsException
* throw this exception, if the index is false
* @return a title text as MCRMetaLangText
*/
public final MCRMetaLangText getTitle(int index) throws IndexOutOfBoundsException {
if ((index < 0) || (index > titles.size())) {
throw new IndexOutOfBoundsException("Index error in getTitle(" + index + ").");
}
return titles.get(index);
}
/**
* This method get a single data from the internal list as a MCRMetaIFS.
*
* @return a internal data as MCRMetaIFS
*/
public final MCRMetaIFS getInternals() {
return internals;
}
/**
* @param file the file to add
* @param urn the urn of the file, if already known, if not provide null
*
* @throws NullPointerException if first argument is null
*/
public MCRFileMetadata getOrCreateFileMetadata(MCRPath file, String urn) {
return getOrCreateFileMetadata(file, urn, null);
}
public MCRFileMetadata getOrCreateFileMetadata(MCRPath file, String urn, String handle) {
Objects.requireNonNull(file, "File may not be null");
String path = "/" + file.subpathComplete();
return getOrCreateFileMetadata(path, urn, handle);
}
/**
* @param path
* @param urn
* @param handle
* @return
*/
private MCRFileMetadata getOrCreateFileMetadata(String path, String urn, String handle) {
if (path == null) {
throw new NullPointerException("path may not be null");
}
int fileCount = files.size();
for (int i = 0; i < fileCount; i++) {
MCRFileMetadata fileMetadata = files.get(i);
int compare = fileMetadata.getName().compareTo(path);
if (compare == 0) {
return fileMetadata;
} else if (compare > 0) {
//we need to create entry here
MCRFileMetadata newFileMetadata = createFileMetadata(path, urn, handle);
files.add(i, newFileMetadata);
return newFileMetadata;
}
}
//add path to end of list;
if (files.isEmpty()) {
files = new ArrayList<>();
}
MCRFileMetadata newFileMetadata = createFileMetadata(path, urn, handle);
files.add(newFileMetadata);
return newFileMetadata;
}
public final MCRFileMetadata getOrCreateFileMetadata(String path) {
return getOrCreateFileMetadata(MCRPath.getPath(derivateID.toString(), path), null, null);
}
public MCRFileMetadata getOrCreateFileMetadata(MCRPath file) {
return getOrCreateFileMetadata(file, null, null);
}
/**
* @param path
* @param urn
* @param handle
* @return
*/
private MCRFileMetadata createFileMetadata(String path, String urn, String handle) {
MCRPath mcrFile = MCRPath.getPath(derivateID.toString(), path);
if (!Files.exists(mcrFile)) {
throw new MCRPersistenceException("File does not exist: " + mcrFile);
}
return new MCRFileMetadata(path, urn, handle, null);
}
public List getFileMetadata() {
return Collections.unmodifiableList(files);
}
/**
* Removes file metadata (urn information) from the {@link MCRObjectDerivate}
*/
public void removeFileMetadata() {
this.files = Collections.emptyList();
this.derivateURN = null;
}
/**
* Deletes file metadata of file idendified by absolute path.
* @param path absolute path of this node starting with a '/'
* @return true if metadata was deleted and false if file has no metadata.
*/
public boolean deleteFileMetaData(String path) {
Iterator it = files.iterator();
while (it.hasNext()) {
MCRFileMetadata metadata = it.next();
if (metadata.getName().equals(path)) {
it.remove();
return true;
}
}
return false;
}
/**
* This method set the metadata internals (the IFS data)
*
* @param ifs
* the MCRMetaIFS object
*/
public final void setInternals(MCRMetaIFS ifs) {
if (ifs == null) {
return;
}
internals = ifs;
}
/**
* This methode create a XML stream for all derivate data.
*
* @exception MCRException
* if the content of this class is not valid
* @return a JDOM Element with the XML data of the structure data part
*/
public final Element createXML() throws MCRException {
try {
validate();
} catch (MCRException exc) {
throw new MCRException("The content is not valid.", exc);
}
Element elm = new Element("derivate");
elm.setAttribute("display", String.valueOf(display));
Element linkmetas = new Element("linkmetas");
linkmetas.setAttribute("class", "MCRMetaLinkID");
linkmetas.setAttribute("heritable", "false");
linkmetas.addContent(linkmeta.createXML());
elm.addContent(linkmetas);
if (externals.size() != 0) {
Element extEl = new Element("externals");
extEl.setAttribute("class", "MCRMetaLink");
extEl.setAttribute("heritable", "false");
for (MCRMetaLink external : externals) {
extEl.addContent(external.createXML());
}
elm.addContent(extEl);
}
if (internals != null) {
Element intEl = new Element("internals");
intEl.setAttribute("class", "MCRMetaIFS");
intEl.setAttribute("heritable", "false");
intEl.addContent(internals.createXML());
elm.addContent(intEl);
}
if (titles.size() != 0) {
Element titEl = new Element("titles");
titEl.setAttribute("class", "MCRMetaLangText");
titEl.setAttribute("heritable", "false");
titles.stream()
.map(MCRMetaLangText::createXML)
.forEach(titEl::addContent);
elm.addContent(titEl);
}
if (classifications.size() > 0) {
Element clazzElement = new Element("classifications");
clazzElement.setAttribute("class", "MCRMetaClassification");
clazzElement.setAttribute("heritable", "false");
classifications.stream()
.map(MCRMetaClassification::createXML)
.forEach(clazzElement::addContent);
elm.addContent(clazzElement);
}
if (this.derivateURN != null || !files.isEmpty()) {
Element fileset = new Element("fileset");
if (this.derivateURN != null) {
fileset.setAttribute("urn", this.derivateURN);
}
Collections.sort(files);
for (MCRFileMetadata file : files) {
fileset.addContent(file.createXML());
}
elm.addContent(fileset);
}
return elm;
}
/**
* This method check the validation of the content of this class. The method
* returns true if
*
*
the linkmeta exist and the XLink type of linkmeta is not "arc"
*
no information in the external AND internal tags
*
*
* @return a boolean value
*/
public final boolean isValid() {
try {
validate();
return true;
} catch (MCRException exc) {
LOGGER.warn("The part of the mycorederivate '{}' is invalid.", derivateID, exc);
}
return false;
}
/**
* Validates this MCRObjectDerivate. This method throws an exception if:
*
*
the linkmeta is null
*
the linkmeta xlink:type is not 'locator'
*
the internals and the externals are empty
*
*
* @throws MCRException the MCRObjectDerivate is invalid
*/
public void validate() throws MCRException {
if (linkmeta == null) {
throw new MCRException("linkmeta == null");
}
if (!linkmeta.getXLinkType().equals("locator")) {
throw new MCRException("linkmeta type != locator");
}
if ((internals == null) && (externals.size() == 0)) {
throw new MCRException("(internals == null) && (externals.size() == 0)");
}
}
/**
* @return true if the display attribute is set to true, false otherwise
*/
public boolean isDisplayEnabled() {
return display;
}
/**
* Sets the display attribute of the derivate object
* @param display pass true if you want to have the derivate displayed or false if not
*/
public void setDisplayEnabled(boolean display) {
this.display = display;
}
public void setURN(String urn) {
derivateURN = urn;
}
public String getURN() {
return derivateURN;
}
void setDerivateID(MCRObjectID id) {
this.derivateID = id;
}
public ArrayList getClassifications() {
return classifications;
}
public ArrayList getTitles() {
return titles;
}
}
