org.dspace.content.dao.impl.RelationshipDAOImpl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dspace-api Show documentation
DSpace core data model and service APIs.
The newest version!
/**
 * The contents of this file are subject to the license and copyright
 * detailed in the LICENSE and NOTICE files at the root of the source
 * tree and available online at
 *
 * http://www.dspace.org/license/
 */
package org.dspace.content.dao.impl;

import java.sql.SQLException;
import java.util.ArrayList;
import java.util.List;
import java.util.UUID;
import java.util.stream.Collectors;

import jakarta.persistence.Query;
import jakarta.persistence.Tuple;
import jakarta.persistence.criteria.CriteriaBuilder;
import jakarta.persistence.criteria.CriteriaQuery;
import jakarta.persistence.criteria.Predicate;
import jakarta.persistence.criteria.Root;
import org.dspace.content.Item;
import org.dspace.content.Item_;
import org.dspace.content.Relationship;
import org.dspace.content.RelationshipType;
import org.dspace.content.RelationshipType_;
import org.dspace.content.Relationship_;
import org.dspace.content.dao.RelationshipDAO;
import org.dspace.content.dao.pojo.ItemUuidAndRelationshipId;
import org.dspace.content.factory.ContentServiceFactory;
import org.dspace.content.service.RelationshipTypeService;
import org.dspace.core.AbstractHibernateDAO;
import org.dspace.core.Context;

public class RelationshipDAOImpl extends AbstractHibernateDAO implements RelationshipDAO {

    @Override
    public List findByItem(
        Context context, Item item, boolean excludeTilted, boolean excludeNonLatest
    ) throws SQLException {
        return findByItem(context, item, -1, -1, excludeTilted, excludeNonLatest);
    }

    @Override
    public List findByItem(
        Context context, Item item, Integer limit, Integer offset, boolean excludeTilted, boolean excludeNonLatest
    ) throws SQLException {
        CriteriaBuilder criteriaBuilder = getCriteriaBuilder(context);
        CriteriaQuery criteriaQuery = getCriteriaQuery(criteriaBuilder, Relationship.class);
        Root relationshipRoot = criteriaQuery.from(Relationship.class);
        criteriaQuery.select(relationshipRoot);

        criteriaQuery.where(
            criteriaBuilder.or(
                getLeftItemPredicate(criteriaBuilder, relationshipRoot, item, excludeTilted, excludeNonLatest),
                getRightItemPredicate(criteriaBuilder, relationshipRoot, item, excludeTilted, excludeNonLatest)
            )
        );

        return list(context, criteriaQuery, false, Relationship.class, limit, offset);
    }

    /**
     * Get the predicate for a criteria query that selects relationships by their left item.
     * @param criteriaBuilder   the criteria builder.
     * @param relationshipRoot  the relationship root.
     * @param item              the item that is being searched for.
     * @param excludeTilted     if true, exclude tilted relationships.
     * @param excludeNonLatest  if true, exclude relationships for which the opposite item is not the latest version
     *                          that is relevant.
     * @return a predicate that satisfies the given restrictions.
     */
    protected Predicate getLeftItemPredicate(
        CriteriaBuilder criteriaBuilder, Root relationshipRoot, Item item,
        boolean excludeTilted, boolean excludeNonLatest
    ) {
        List predicates = new ArrayList<>();

        // match relationships based on the left item
        predicates.add(
            criteriaBuilder.equal(relationshipRoot.get(Relationship_.leftItem), item)
        );

        if (excludeTilted) {
            // if this item is the left item,
            // return relationships for types which are NOT tilted right (tilted is either left nor null)
            predicates.add(
                criteriaBuilder.or(
                    criteriaBuilder.isNull(
                        relationshipRoot.get(Relationship_.relationshipType).get(RelationshipType_.tilted)
                    ),
                    criteriaBuilder.notEqual(
                        relationshipRoot.get(Relationship_.relationshipType).get(RelationshipType_.tilted),
                        RelationshipType.Tilted.RIGHT
                    )
                )
            );
        }

        if (excludeNonLatest) {
            // if this item is the left item,
            // return relationships for which the right item is the "latest" version that is relevant.
            predicates.add(
                criteriaBuilder.notEqual(
                    relationshipRoot.get(Relationship_.LATEST_VERSION_STATUS),
                    Relationship.LatestVersionStatus.LEFT_ONLY
                )
            );
        }

        return criteriaBuilder.and(predicates.toArray(new Predicate[]{}));
    }

    /**
     * Get the predicate for a criteria query that selects relationships by their right item.
     * @param criteriaBuilder   the criteria builder.
     * @param relationshipRoot  the relationship root.
     * @param item              the item that is being searched for.
     * @param excludeTilted     if true, exclude tilted relationships.
     * @param excludeNonLatest  if true, exclude relationships for which the opposite item is not the latest version
     *                          that is relevant.
     * @return a predicate that satisfies the given restrictions.
     */
    protected Predicate getRightItemPredicate(
        CriteriaBuilder criteriaBuilder, Root relationshipRoot, Item item,
        boolean excludeTilted, boolean excludeNonLatest
    ) {
        List predicates = new ArrayList<>();

        // match relationships based on the right item
        predicates.add(
            criteriaBuilder.equal(relationshipRoot.get(Relationship_.rightItem), item)
        );

        if (excludeTilted) {
            // if this item is the right item,
            // return relationships for types which are NOT tilted left (tilted is either right nor null)
            predicates.add(
                criteriaBuilder.or(
                    criteriaBuilder.isNull(
                        relationshipRoot.get(Relationship_.relationshipType).get(RelationshipType_.tilted)
                    ),
                    criteriaBuilder.notEqual(
                        relationshipRoot.get(Relationship_.relationshipType).get(RelationshipType_.tilted),
                        RelationshipType.Tilted.LEFT
                    )
                )
            );
        }

        if (excludeNonLatest) {
            // if this item is the right item,
            // return relationships for which the left item is the "latest" version that is relevant.
            predicates.add(
                criteriaBuilder.notEqual(
                    relationshipRoot.get(Relationship_.LATEST_VERSION_STATUS),
                    Relationship.LatestVersionStatus.RIGHT_ONLY
                )
            );
        }

        return criteriaBuilder.and(predicates.toArray(new Predicate[]{}));
    }

    @Override
    public int countByItem(
        Context context, Item item, boolean excludeTilted, boolean excludeNonLatest
    ) throws SQLException {
        CriteriaBuilder criteriaBuilder = getCriteriaBuilder(context);
        CriteriaQuery criteriaQuery = criteriaBuilder.createQuery(Long.class);
        Root relationshipRoot = criteriaQuery.from(Relationship.class);
        criteriaQuery.select(criteriaBuilder.count(relationshipRoot));

        criteriaQuery.where(
            criteriaBuilder.or(
                getLeftItemPredicate(criteriaBuilder, relationshipRoot, item, excludeTilted, excludeNonLatest),
                getRightItemPredicate(criteriaBuilder, relationshipRoot, item, excludeTilted, excludeNonLatest)
            )
        );

        return count(context, criteriaQuery, criteriaBuilder, relationshipRoot);
    }

    @Override
    public List findByRelationshipType(Context context, RelationshipType relationshipType)
        throws SQLException {

        return findByRelationshipType(context, relationshipType, -1, -1);
    }

    @Override
    public List findByRelationshipType(Context context, RelationshipType relationshipType,
                                                     Integer limit, Integer offset) throws SQLException {

        CriteriaBuilder criteriaBuilder = getCriteriaBuilder(context);
        CriteriaQuery criteriaQuery = getCriteriaQuery(criteriaBuilder, Relationship.class);
        Root relationshipRoot = criteriaQuery.from(Relationship.class);
        criteriaQuery.select(relationshipRoot);
        criteriaQuery
            .where(criteriaBuilder.equal(relationshipRoot.get(Relationship_.relationshipType), relationshipType));
        return list(context, criteriaQuery, true, Relationship.class, limit, offset);
    }

    @Override
    public List findByItemAndRelationshipType(
        Context context, Item item, RelationshipType relationshipType, Integer limit, Integer offset,
        boolean excludeNonLatest
    ) throws SQLException {
        CriteriaBuilder criteriaBuilder = getCriteriaBuilder(context);
        CriteriaQuery criteriaQuery = getCriteriaQuery(criteriaBuilder, Relationship.class);
        Root relationshipRoot = criteriaQuery.from(Relationship.class);
        criteriaQuery.select(relationshipRoot);

        criteriaQuery.where(
            criteriaBuilder.equal(relationshipRoot.get(Relationship_.relationshipType), relationshipType),
            criteriaBuilder.or(
                getLeftItemPredicate(criteriaBuilder, relationshipRoot, item, false, excludeNonLatest),
                getRightItemPredicate(criteriaBuilder, relationshipRoot, item, false, excludeNonLatest)
            )
        );

        return list(context, criteriaQuery, true, Relationship.class, limit, offset);
    }

    @Override
    public List findByItemAndRelationshipType(
        Context context, Item item, RelationshipType relationshipType, boolean isLeft, Integer limit, Integer offset,
        boolean excludeNonLatest
    ) throws SQLException {
        CriteriaBuilder criteriaBuilder = getCriteriaBuilder(context);
        CriteriaQuery criteriaQuery = getCriteriaQuery(criteriaBuilder, Relationship.class);
        Root relationshipRoot = criteriaQuery.from(Relationship.class);
        criteriaQuery.select(relationshipRoot);

        if (isLeft) {
            criteriaQuery.where(
                criteriaBuilder.equal(relationshipRoot.get(Relationship_.relationshipType), relationshipType),
                getLeftItemPredicate(criteriaBuilder, relationshipRoot, item, false, excludeNonLatest)
            );
            criteriaQuery.orderBy(criteriaBuilder.asc(relationshipRoot.get(Relationship_.leftPlace)));
        } else {
            criteriaQuery.where(
                criteriaBuilder.equal(relationshipRoot.get(Relationship_.relationshipType), relationshipType),
                getRightItemPredicate(criteriaBuilder, relationshipRoot, item, false, excludeNonLatest)
            );
            criteriaQuery.orderBy(criteriaBuilder.asc(relationshipRoot.get(Relationship_.rightPlace)));
        }

        return list(context, criteriaQuery, true, Relationship.class, limit, offset);
    }

    @Override
    public List findByLatestItemAndRelationshipType(
        Context context, Item latestItem, RelationshipType relationshipType, boolean isLeft
    ) throws SQLException {
        final String relationshipIdAlias = "relationshipId";
        final String itemUuidAlias = "itemUuid";

        CriteriaBuilder criteriaBuilder = getCriteriaBuilder(context);
        CriteriaQuery criteriaQuery = criteriaBuilder.createTupleQuery();
        Root relationshipRoot = criteriaQuery.from(Relationship.class);

        ArrayList predicates = new ArrayList<>();

        // all relationships should have the specified relationship type
        predicates.add(
            criteriaBuilder.equal(relationshipRoot.get(Relationship_.relationshipType), relationshipType)
        );

        if (isLeft) {
            // match relationships based on the left item
            predicates.add(
                criteriaBuilder.equal(relationshipRoot.get(Relationship_.leftItem), latestItem)
            );

            // the left item has to have "latest status" => accept BOTH and LEFT_ONLY
            predicates.add(
                criteriaBuilder.notEqual(
                    relationshipRoot.get(Relationship_.LATEST_VERSION_STATUS),
                    Relationship.LatestVersionStatus.RIGHT_ONLY
                )
            );

            // return the UUIDs of the right item
            criteriaQuery.multiselect(
                relationshipRoot.get(Relationship_.id).alias(relationshipIdAlias),
                relationshipRoot.get(Relationship_.rightItem).get(Item_.id).alias(itemUuidAlias)
            );
        } else {
            // match relationships based on the right item
            predicates.add(
                criteriaBuilder.equal(relationshipRoot.get(Relationship_.rightItem), latestItem)
            );

            // the right item has to have "latest status" => accept BOTH and RIGHT_ONLY
            predicates.add(
                criteriaBuilder.notEqual(
                    relationshipRoot.get(Relationship_.LATEST_VERSION_STATUS),
                    Relationship.LatestVersionStatus.LEFT_ONLY
                )
            );

            // return the UUIDs of the left item
            criteriaQuery.multiselect(
                relationshipRoot.get(Relationship_.id).alias(relationshipIdAlias),
                relationshipRoot.get(Relationship_.leftItem).get(Item_.id).alias(itemUuidAlias)
            );
        }

        // all predicates are chained with the AND operator
        criteriaQuery.where(predicates.toArray(new Predicate[]{}));

        // deduplicate result
        criteriaQuery.distinct(true);

        // execute query
        Query query = this.getHibernateSession(context).createQuery(criteriaQuery);
        query.setHint("org.hibernate.cacheable", true);
        List resultList = query.getResultList();

        // convert types
        return resultList.stream()
            .map(Tuple.class::cast)
            .map(t -> new ItemUuidAndRelationshipId(
                (UUID) t.get(itemUuidAlias),
                (Integer) t.get(relationshipIdAlias)
            ))
            .collect(Collectors.toList());
    }

    @Override
    public List findByTypeName(Context context, String typeName)
            throws SQLException {
        return this.findByTypeName(context, typeName, -1, -1);
    }

    @Override
    public List findByTypeName(Context context, String typeName, Integer limit, Integer offset)
            throws SQLException {
        RelationshipTypeService relationshipTypeService = ContentServiceFactory.getInstance()
                .getRelationshipTypeService();
        List relTypes = relationshipTypeService.findByLeftwardOrRightwardTypeName(context, typeName);
        List ids = new ArrayList<>();
        for ( RelationshipType relationshipType : relTypes) {
            ids.add(relationshipType.getID());
        }
        CriteriaBuilder criteriaBuilder = getCriteriaBuilder(context);
        CriteriaQuery criteriaQuery = getCriteriaQuery(criteriaBuilder, Relationship.class);
        Root relationshipRoot = criteriaQuery.from(Relationship.class);
        criteriaQuery.where(relationshipRoot.get(Relationship_.relationshipType).in(ids));
        return list(context, criteriaQuery, true, Relationship.class, limit, offset);
    }

    @Override
    public int countByRelationshipType(Context context, RelationshipType relationshipType) throws SQLException {

        CriteriaBuilder criteriaBuilder = getCriteriaBuilder(context);
        CriteriaQuery criteriaQuery = criteriaBuilder.createQuery(Long.class);
        Root relationshipRoot = criteriaQuery.from(Relationship.class);
        criteriaQuery.select(criteriaBuilder.count(relationshipRoot));
        criteriaQuery
                .where(criteriaBuilder.equal(relationshipRoot.get(Relationship_.relationshipType), relationshipType));
        return count(context, criteriaQuery, criteriaBuilder, relationshipRoot);
    }

    @Override
    public int countRows(Context context) throws SQLException {
        CriteriaBuilder criteriaBuilder = getCriteriaBuilder(context);
        CriteriaQuery criteriaQuery = criteriaBuilder.createQuery(Long.class);
        Root relationshipRoot = criteriaQuery.from(Relationship.class);
        criteriaQuery.select(criteriaBuilder.count(relationshipRoot));
        return count(context, criteriaQuery, criteriaBuilder, relationshipRoot);
    }

    @Override
    public int countByItemAndRelationshipType(
        Context context, Item item, RelationshipType relationshipType, boolean isLeft, boolean excludeNonLatest
    ) throws SQLException {
        CriteriaBuilder criteriaBuilder = getCriteriaBuilder(context);
        CriteriaQuery criteriaQuery = criteriaBuilder.createQuery(Long.class);
        Root relationshipRoot = criteriaQuery.from(Relationship.class);
        criteriaQuery.select(criteriaBuilder.count(relationshipRoot));

        if (isLeft) {
            criteriaQuery.where(
                criteriaBuilder.equal(relationshipRoot.get(Relationship_.relationshipType), relationshipType),
                getLeftItemPredicate(criteriaBuilder, relationshipRoot, item, false, excludeNonLatest)
            );
        } else {
            criteriaQuery.where(
                criteriaBuilder.equal(relationshipRoot.get(Relationship_.relationshipType), relationshipType),
                getRightItemPredicate(criteriaBuilder, relationshipRoot, item, false, excludeNonLatest)
            );
        }

        return count(context, criteriaQuery, criteriaBuilder, relationshipRoot);
    }

    @Override
    public int countByTypeName(Context context, String typeName)
            throws SQLException {
        RelationshipTypeService relationshipTypeService = ContentServiceFactory.getInstance()
                .getRelationshipTypeService();
        List relTypes = relationshipTypeService.findByLeftwardOrRightwardTypeName(context, typeName);
        List ids = new ArrayList<>();
        for ( RelationshipType relationshipType : relTypes) {
            ids.add(relationshipType.getID());
        }
        CriteriaBuilder criteriaBuilder = getCriteriaBuilder(context);
        CriteriaQuery criteriaQuery = criteriaBuilder.createQuery(Long.class);
        Root relationshipRoot = criteriaQuery.from(Relationship.class);
        criteriaQuery.select(criteriaBuilder.count(relationshipRoot));
        criteriaQuery.where(relationshipRoot.get(Relationship_.relationshipType).in(ids));
        return count(context, criteriaQuery, criteriaBuilder, relationshipRoot);
    }

    @Override
    public List findByItemAndRelationshipTypeAndList(Context context, UUID focusUUID,
            RelationshipType relationshipType, List items, boolean isLeft,
            int offset, int limit) throws SQLException {
        String side = isLeft ? "leftItem.id" : "rightItem.id";
        String otherSide = !isLeft ? "leftItem.id" : "rightItem.id";
        Query query = createQuery(context, "FROM " + Relationship.class.getSimpleName() +
                                          " WHERE relationshipType = :type " +
                                           "AND " + side + " = (:focusUUID) " +
                                           "AND " + otherSide + " in (:list) " +
                                           "ORDER BY id");
        query.setParameter("type", relationshipType);
        query.setParameter("focusUUID", focusUUID);
        query.setParameter("list", items);
        return list(query, limit, offset);
    }

    @Override
    public int countByItemAndRelationshipTypeAndList(Context context, UUID focusUUID, RelationshipType relationshipType,
            List items, boolean isLeft) throws SQLException {
        String side = isLeft ? "leftItem.id" : "rightItem.id";
        String otherSide = !isLeft ? "leftItem.id" : "rightItem.id";
        Query query = createQuery(context, "SELECT count(*) " +
                                           "FROM " + Relationship.class.getSimpleName() +
                                          " WHERE relationshipType = :type " +
                                           "AND " + side + " = (:focusUUID) " +
                                           "AND " + otherSide + " in (:list)");
        query.setParameter("type", relationshipType);
        query.setParameter("focusUUID", focusUUID);
        query.setParameter("list", items);
        return count(query);
    }

}