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.common;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.LinkedList;
import java.util.Map;
import java.util.Optional;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.mycore.common.MCRUtils;
import org.mycore.common.config.MCRConfiguration2;
import org.mycore.datamodel.classifications2.MCRCategLinkReference;
import org.mycore.datamodel.classifications2.MCRCategLinkServiceFactory;
import org.mycore.datamodel.classifications2.MCRCategoryID;
import org.mycore.datamodel.metadata.MCRDerivate;
import org.mycore.datamodel.metadata.MCRMetaClassification;
import org.mycore.datamodel.metadata.MCRMetaDerivateLink;
import org.mycore.datamodel.metadata.MCRMetaElement;
import org.mycore.datamodel.metadata.MCRMetaLink;
import org.mycore.datamodel.metadata.MCRMetaLinkID;
import org.mycore.datamodel.metadata.MCRMetadataManager;
import org.mycore.datamodel.metadata.MCRObject;
import org.mycore.datamodel.metadata.MCRObjectID;
import org.mycore.datamodel.metadata.MCRObjectMetadata;
import org.mycore.datamodel.metadata.MCRObjectStructure;
/**
* This class manage all accesses to the link table database. This database
* holds all informations about links between MCRObjects/MCRClassifications.
*
* @author Jens Kupferschmidt
* @version $Revision$ $Date$
*/
public class MCRLinkTableManager {
/** The list of entry types */
public static final String ENTRY_TYPE_CHILD = "child";
public static final String ENTRY_TYPE_DERIVATE = "derivate";
public static final String ENTRY_TYPE_DERIVATE_LINK = "derivate_link";
public static final String ENTRY_TYPE_PARENT = "parent";
public static final String ENTRY_TYPE_REFERENCE = "reference";
/** The link table manager singleton */
protected static MCRLinkTableManager singleton;
// logger
static Logger LOGGER = LogManager.getLogger();
private MCRLinkTableInterface linkTableInstance = null;
/**
* Returns the link table manager singleton.
*
* @return Returns a MCRLinkTableManager instance.
*/
public static synchronized MCRLinkTableManager instance() {
if (singleton == null) {
singleton = new MCRLinkTableManager();
}
return singleton;
}
/**
* The constructor of this class.
*/
protected MCRLinkTableManager() {
// Load the persistence class
linkTableInstance = MCRConfiguration2
.getOrThrow("MCR.Persistence.LinkTable.Store.Class", MCRConfiguration2::instantiateClass);
}
/**
* The method add a reference link pair.
*
* @param from
* the source of the reference as MCRObjectID
* @param to
* the target of the reference as MCRObjectID
* @param type
* the type of the reference as String
* @param attr
* the optional attribute of the reference as String
*/
public void addReferenceLink(MCRObjectID from, MCRObjectID to, String type, String attr) {
addReferenceLink(from.toString(), to.toString(), type, attr);
}
/**
* The method add a reference link pair.
*
* @param from
* the source of the reference as String
* @param to
* the target of the reference as String
* @param type
* the type of the reference as String
* @param attr
* the optional attribute of the reference as String
*/
public void addReferenceLink(String from, String to, String type, String attr) {
from = MCRUtils.filterTrimmedNotEmpty(from).orElse(null);
if (from == null) {
LOGGER.warn("The from value of a reference link is false, the link was not added to the link table");
return;
}
to = MCRUtils.filterTrimmedNotEmpty(to).orElse(null);
if (to == null) {
LOGGER.warn("The to value of a reference link is false, the link was not added to the link table");
return;
}
type = MCRUtils.filterTrimmedNotEmpty(type).orElse(null);
if (type == null) {
LOGGER.warn("The type value of a reference link is false, the link was not added to the link table");
return;
}
attr = MCRUtils.filterTrimmedNotEmpty(attr).orElse("");
LOGGER.debug("Link in table {} add for {}<-->{} with {} and {}", type, from, to, type, attr);
try {
linkTableInstance.create(from, to, type, attr);
} catch (Exception e) {
LOGGER.warn("An error occured while adding a dataset from the reference link table, adding not succesful.",
e);
}
}
/**
* The method delete a reference link.
*
* @param from
* the source of the reference as MCRObjectID
*/
public void deleteReferenceLink(MCRObjectID from) {
deleteReferenceLink(from.toString());
}
/**
* The method delete a reference link.
*
* @param from
* the source of the reference as String
*/
public void deleteReferenceLink(String from) {
from = MCRUtils.filterTrimmedNotEmpty(from).orElse(null);
if (from == null) {
LOGGER
.warn("The from value of a reference link is false, the link was " + "not deleted from the link table");
return;
}
try {
linkTableInstance.delete(from, null, null);
} catch (Exception e) {
LOGGER.warn("An error occured while deleting a dataset from the" + from
+ " reference link table, deleting could be not succesful.", e);
}
}
/**
* The method delete a reference link pair for the given type to the store.
*
* @param from
* the source of the reference as String
* @param to
* the target of the reference as String
* @param type
* the type of the reference as String
*/
public void deleteReferenceLink(String from, String to, String type) {
from = MCRUtils.filterTrimmedNotEmpty(from).orElse(null);
if (from == null) {
LOGGER
.warn("The from value of a reference link is false, the link was " + "not deleted from the link table");
return;
}
try {
linkTableInstance.delete(from, to, type);
} catch (Exception e) {
LOGGER.warn("An error occured while deleting a dataset from the"
+ " reference link table, deleting is not succesful.", e);
}
}
/**
* The method count the reference links for a given target MCRobjectID.
*
* @param to
* the object ID as MCRObjectID, they was referenced
* @return the number of references
*/
public int countReferenceLinkTo(MCRObjectID to) {
return countReferenceLinkTo(to.toString());
}
/**
* The method count the reference links for a given target object ID.
*
* @param to
* the object ID as String, they was referenced
* @return the number of references
*/
public int countReferenceLinkTo(String to) {
to = MCRUtils.filterTrimmedNotEmpty(to).orElse(null);
if (to == null) {
LOGGER.warn("The to value of a reference link is false, the link was " + "not added to the link table");
return 0;
}
try {
return linkTableInstance.countTo(null, to, null, null);
} catch (Exception e) {
LOGGER.warn("An error occured while searching for references of " + to + ".", e);
}
return 0;
}
/**
* counts the reference links for a given to object ID.
*
* @param types
* Array of document type slected by the mcrfrom content
* @param restriction
* a first part of the to ID as String, it can be null
* @return the number of references
*/
public int countReferenceLinkTo(String to, String[] types, String restriction) {
Optional myTo = MCRUtils.filterTrimmedNotEmpty(to);
if (!myTo.isPresent()) {
LOGGER.warn("The to value of a reference link is false, the link was " + "not added to the link table");
return 0;
}
try {
if (types != null && types.length > 0) {
return Stream.of(types).mapToInt(type -> linkTableInstance.countTo(null, myTo.get(), type, restriction))
.sum();
}
return linkTableInstance.countTo(null, myTo.get(), null, restriction);
} catch (Exception e) {
LOGGER.warn("An error occured while searching for references of " + to + ".", e);
return 0;
}
}
/**
* The method count the number of references to a category of a
* classification without sub ID's and returns it as a Map
*
* @param classid
* the classification ID as MCRObjectID
*
* @return a Map with key=categID and value=counted number of references
*/
public Map countReferenceCategory(String classid) {
return linkTableInstance.getCountedMapOfMCRTO(classid);
}
/**
* The method count the number of references to a category of a
* classification.
*
* @param classid
* the classification ID as String
* @param categid
* the category ID as String
* @return the number of references
*/
public int countReferenceCategory(String classid, String categid) {
return countReferenceLinkTo(classid + "##" + categid, null, null);
}
/**
* Returns a List of all link sources of to
*
* @param to
* The MCRObjectID to referenced.
* @return List of Strings (Source-IDs)
*/
public Collection getSourceOf(MCRObjectID to) {
return getSourceOf(to.toString());
}
/**
* Returns a List of all link sources of to
*
* @param to
* The ID to referenced.
* @return List of Strings (Source-IDs)
*/
public Collection getSourceOf(String to) {
if (to == null || to.length() == 0) {
LOGGER.warn("The to value of a reference link is false, the link was not found in the link table");
return Collections.emptyList();
}
try {
return linkTableInstance.getSourcesOf(to, null);
} catch (Exception e) {
LOGGER.warn("An error occured while searching for references to " + to + ".", e);
return Collections.emptyList();
}
}
/**
* Returns a List of all link sources of to and a special
* type
*
* @param to
* Destination-ID
* @param type
* link reference type
* @return List of Strings (Source-IDs)
*/
public Collection getSourceOf(MCRObjectID to, String type) {
return getSourceOf(to.toString(), type);
}
/**
* Returns a List of all link sources of to and a special
* type
*
* @param to
* Destination-ID
* @param type
* link reference type
* @return List of Strings (Source-IDs)
*/
public Collection getSourceOf(String to, String type) {
if (to == null || to.length() == 0) {
LOGGER.warn("The to value of a reference link is false, the link was not found in the link table");
return Collections.emptyList();
}
if (type == null || type.length() == 0) {
LOGGER.warn("The type value of a reference link is false, the link was not found in the link table");
return Collections.emptyList();
}
try {
return linkTableInstance.getSourcesOf(to, type);
} catch (Exception e) {
LOGGER.warn("An error occured while searching for references to " + to + " with " + type + ".", e);
return Collections.emptyList();
}
}
/**
* The method return a list of all source ID's of the refernce target to
* with the given type.
*
* @param to
* the refernce target to
* @param type
* type of the refernce
* @return a list of ID's
*/
public Collection getSourceOf(String[] to, String type) {
if (to == null || to.length == 0) {
LOGGER.warn("The to value of a reference link is false, the link was not found in the link table");
return Collections.emptyList();
}
LinkedList ll = new LinkedList<>();
try {
for (String singleTo : to) {
ll.addAll(linkTableInstance.getSourcesOf(singleTo, type));
}
return ll;
} catch (Exception e) {
LOGGER.warn("An error occured while searching for references to " + Arrays.toString(to) + ".", e);
return ll;
}
}
/**
* Returns a List of all link destinations of from and a
* special type
*
* @param from
* Destination-ID
* @param type
* link reference type
* @return List of Strings (Source-IDs)
*/
public Collection getDestinationOf(MCRObjectID from, String type) {
return getDestinationOf(from.toString(), type);
}
/**
* Returns a List of all link destination of from and a
* special type
*
* @param from
* Source-ID
* @param type
* Link reference type, this can be null. Current types are
* classid, child, parent, reference and derivate.
* @return List of Strings (Destination-IDs)
*/
public Collection getDestinationOf(String from, String type) {
if (from == null || from.length() == 0) {
LOGGER.warn("The from value of a reference link is false, the link was not found in the link table");
return Collections.emptyList();
}
if (type == null || type.length() == 0) {
LOGGER.warn("The type value of a reference link is false, the link was not found in the link table");
return Collections.emptyList();
}
try {
return linkTableInstance.getDestinationsOf(from, type);
} catch (Exception e) {
LOGGER.warn("An error occured while searching for references from " + from + ".", e);
return Collections.emptyList();
}
}
/**
* Creates all references for the given object. You should call {@link #delete(MCRObjectID)} before using this
* method otherwise doublets could occur.
*
* @param obj the object to create the references
*/
public void create(MCRObject obj) {
MCRObjectID mcrId = obj.getId();
// set new entries
MCRObjectMetadata meta = obj.getMetadata();
//use Set for category collection to remove duplicates if there are any
Collection categories = new HashSet<>();
meta.stream().flatMap(MCRMetaElement::stream).forEach(inf -> {
if (inf instanceof MCRMetaClassification) {
String classId = ((MCRMetaClassification) inf).getClassId();
String categId = ((MCRMetaClassification) inf).getCategId();
categories.add(new MCRCategoryID(classId, categId));
} else if (inf instanceof MCRMetaLinkID) {
addReferenceLink(mcrId.toString(), ((MCRMetaLink) inf).getXLinkHref(),
MCRLinkTableManager.ENTRY_TYPE_REFERENCE, "");
} else if (inf instanceof MCRMetaDerivateLink) {
addReferenceLink(mcrId.toString(), ((MCRMetaLink) inf).getXLinkHref(),
MCRLinkTableManager.ENTRY_TYPE_DERIVATE_LINK, "");
}
});
MCRCategoryID state = obj.getService().getState();
if (state != null) {
categories.add(state);
}
if (categories.size() > 0) {
MCRCategLinkReference objectReference = new MCRCategLinkReference(mcrId);
MCRCategLinkServiceFactory.getInstance().setLinks(objectReference, categories);
}
// add derivate reference
MCRObjectStructure structure = obj.getStructure();
for (int i = 0; i < structure.getDerivates().size(); i++) {
MCRMetaLinkID lid = structure.getDerivates().get(i);
addReferenceLink(obj.getId(), lid.getXLinkHrefID(), MCRLinkTableManager.ENTRY_TYPE_DERIVATE, "");
}
// add parent reference
if (structure.getParentID() != null) {
addReferenceLink(mcrId, structure.getParentID(), MCRLinkTableManager.ENTRY_TYPE_PARENT, "");
}
}
/**
* Removes all references of this object.
*
* @param id the object where all references should be removed
*/
public void delete(MCRObjectID id) {
deleteReferenceLink(id);
MCRCategLinkReference reference = new MCRCategLinkReference(id);
MCRCategLinkServiceFactory.getInstance().deleteLink(reference);
}
/**
* Updates all references of this object. Old ones will be removed and new links will be created.
*
* @param id the mycore object identifer
*/
public void update(MCRObjectID id) {
delete(id);
if ("derivate".equals(id.getTypeId())) {
create(MCRMetadataManager.retrieveMCRDerivate(id));
} else {
create(MCRMetadataManager.retrieveMCRObject(id));
}
}
public void create(MCRDerivate der) {
Collection categoryList = new HashSet<>();
categoryList.addAll(der.getDerivate().getClassifications()
.stream()
.map(this::metaClassToCategoryID)
.collect(Collectors.toList()));
MCRCategoryID state = der.getService().getState();
if (state != null) {
categoryList.add(state);
}
MCRCategLinkReference objectReference = new MCRCategLinkReference(der.getId());
MCRCategLinkServiceFactory.getInstance().setLinks(objectReference, categoryList);
}
private MCRCategoryID metaClassToCategoryID(MCRMetaClassification metaClazz) {
return new MCRCategoryID(metaClazz.getClassId(), metaClazz.getCategId());
}
}
