org.dspace.util.JpaCriteriaBuilderKit 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.util;

import jakarta.persistence.criteria.AbstractQuery;
import jakarta.persistence.criteria.CriteriaBuilder;
import jakarta.persistence.criteria.Root;

/**
 * Data structure containing the required objects to build criteria
 * for a JPA query built using the JPA Criteria API.
 * The getters match those generated by the JVM when using a record
 * so that no API changes will be required when this class gets converted
 * into a record when DSpace gets promoted to Java 17 or later.
 * @author Jean-François Morin (Université Laval)
 */
// TODO: Convert this data structure into a record when DSpace gets promoted to Java 17 or later
public class JpaCriteriaBuilderKit {

    private CriteriaBuilder criteriaBuilder;
    /** Can be a CriteriaQuery as well as a Subquery - both extend AbstractQuery. */
    private AbstractQuery query;
    private Root root;

    public JpaCriteriaBuilderKit(CriteriaBuilder criteriaBuilder, AbstractQuery query,
            Root root) {
        this.criteriaBuilder = criteriaBuilder;
        this.query = query;
        this.root = root;
    }

    public CriteriaBuilder criteriaBuilder() {
        return criteriaBuilder;
    }

    public AbstractQuery query() {
        return query;
    }

    public Root root() {
        return root;
    }

}