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.
/*
* Copyright 2014 - 2021 Blazebit.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.blazebit.persistence;
import com.blazebit.persistence.spi.ConfigurationSource;
import com.blazebit.persistence.spi.JpqlFunction;
import com.blazebit.persistence.spi.ServiceProvider;
import javax.persistence.EntityManager;
import java.util.Map;
/**
* An interface used to create criteria builders.
*
* @author Christian Beikov
* @since 1.0.0
*/
public interface CriteriaBuilderFactory extends ServiceProvider, ConfigurationSource {
/**
* Returns all functions that are available in queries as a map of function name to {@link JpqlFunction}.
*
* @return The registered functions
* @since 1.2.0
*/
public Map getRegisteredFunctions();
/**
* Starts a criteria builder with a nested set operation builder.
* Doing this is like starting a nested query that will be connected via a set operation.
*
* @param entityManager The entity manager to use for the criteria builder
* @param resultClass The result class of the query
* @param The type of the result class
* @return The set operation builder
* @since 1.2.0
*/
public StartOngoingSetOperationCriteriaBuilder> startSet(EntityManager entityManager, Class resultClass);
/**
* Like {@link CriteriaBuilderFactory#create(javax.persistence.EntityManager, java.lang.Class, java.lang.String)} but with the alias
* equivalent to the camel cased result of what {@link Class#getSimpleName()} of the result class returns.
*
* @param entityManager The entity manager to use for the criteria builder
* @param resultClass The result class of the query
* @param The type of the result class
* @return A new criteria builder
*/
public CriteriaBuilder create(EntityManager entityManager, Class resultClass);
/**
* Creates a new criteria builder with the given result class. The result class will be used as default from class.
* The alias will be used as default alias for the from class. Both can be overridden by invoking
* {@link BaseQueryBuilder#from(java.lang.Class, java.lang.String)}.
*
* @param entityManager The entity manager to use for the criteria builder
* @param resultClass The result class of the query
* @param The type of the result class
* @param alias The alias that should be used for the result class from clause
* @return A new criteria builder
*/
public CriteriaBuilder create(EntityManager entityManager, Class resultClass, String alias);
/**
* Like {@link CriteriaBuilderFactory#delete(javax.persistence.EntityManager, java.lang.Class, java.lang.String)} but with the alias
* equivalent to the camel cased result of what {@link Class#getSimpleName()} of the delete class returns.
*
* @param entityManager The entity manager to use for the delete criteria builder
* @param deleteClass The entity class for the delete criteria
* @param The type of the entity for the delete criteria
* @return A new delete criteria builder
* @since 1.1.0
*/
public DeleteCriteriaBuilder delete(EntityManager entityManager, Class deleteClass);
/**
* Creates a new delete criteria builder for the given entity class.
*
* @param entityManager The entity manager to use for the delete criteria builder
* @param deleteClass The entity class for the delete criteria
* @param alias The alias that should be used for the entity
* @param The type of the entity for the delete criteria
* @return A new delete criteria builder
* @since 1.1.0
*/
public DeleteCriteriaBuilder delete(EntityManager entityManager, Class deleteClass, String alias);
/**
* Like {@link CriteriaBuilderFactory#deleteCollection(javax.persistence.EntityManager, java.lang.Class, java.lang.String, java.lang.String)} but with the alias
* equivalent to the camel cased result of what {@link Class#getSimpleName()} of the delete owner class returns.
*
* @param entityManager The entity manager to use for the delete criteria builder
* @param deleteOwnerClass The entity class owning the collection for the delete criteria
* @param collectionName The name of the collection contained in the owner entity class
* @param The type of the entity for the delete criteria
* @return A new delete criteria builder
* @since 1.2.0
*/
public DeleteCriteriaBuilder deleteCollection(EntityManager entityManager, Class deleteOwnerClass, String collectionName);
/**
* Creates a new delete criteria builder for the given entity class and collection name to delete elements of the
* entity class's collection.
*
* @param entityManager The entity manager to use for the delete criteria builder
* @param deleteOwnerClass The entity class owning the collection for the delete criteria
* @param alias The alias that should be used for the entity
* @param collectionName The name of the collection contained in the owner entity class
* @param The type of the entity for the delete criteria
* @return A new delete criteria builder
* @since 1.2.0
*/
public DeleteCriteriaBuilder deleteCollection(EntityManager entityManager, Class deleteOwnerClass, String alias, String collectionName);
/**
* Like {@link CriteriaBuilderFactory#update(javax.persistence.EntityManager, java.lang.Class, java.lang.String)} but with the alias
* equivalent to the camel cased result of what {@link Class#getSimpleName()} of the update class returns.
*
* @param entityManager The entity manager to use for the update criteria builder
* @param updateClass The entity class for the update criteria
* @param The type of the entity for the update criteria
* @return A new update criteria builder
* @since 1.1.0
*/
public UpdateCriteriaBuilder update(EntityManager entityManager, Class updateClass);
/**
* Creates a new update criteria builder for the given entity class.
*
* @param entityManager The entity manager to use for the update criteria builder
* @param updateClass The entity class for the update criteria
* @param alias The alias that should be used for the entity
* @param The type of the entity for the update criteria
* @return A new update criteria builder
* @since 1.1.0
*/
public UpdateCriteriaBuilder update(EntityManager entityManager, Class updateClass, String alias);
/**
* Like {@link CriteriaBuilderFactory#updateCollection(javax.persistence.EntityManager, java.lang.Class, java.lang.String, java.lang.String)} but with the alias
* equivalent to the camel cased result of what {@link Class#getSimpleName()} of the delete owner class returns.
*
* @param entityManager The entity manager to use for the update criteria builder
* @param updateOwnerClass The entity class owning the collection for the update criteria
* @param collectionName The name of the collection contained in the owner entity class
* @param The type of the entity for the update criteria
* @return A new update criteria builder
* @since 1.2.0
*/
public UpdateCriteriaBuilder updateCollection(EntityManager entityManager, Class updateOwnerClass, String collectionName);
/**
* Creates a new update criteria builder for the given entity class and collection name to update elements of the
* entity class's collection.
*
* @param entityManager The entity manager to use for the update criteria builder
* @param updateOwnerClass The entity class owning the collection for the update criteria
* @param alias The alias that should be used for the entity
* @param collectionName The name of the collection contained in the owner entity class
* @param The type of the entity for the update criteria
* @return A new update criteria builder
* @since 1.2.0
*/
public UpdateCriteriaBuilder updateCollection(EntityManager entityManager, Class updateOwnerClass, String alias, String collectionName);
/**
* Creates a new insert criteria builder for the given entity class.
*
* @param entityManager The entity manager to use for the insert criteria builder
* @param insertClass The entity class for the insert criteria
* @param The type of the entity for the insert criteria
* @return A new insert criteria builder
* @since 1.1.0
*/
public InsertCriteriaBuilder insert(EntityManager entityManager, Class insertClass);
/**
* Creates a new insert criteria builder for the given entity class and collection name to update elements of the
* entity class's collection.
*
* @param entityManager The entity manager to use for the insert criteria builder
* @param insertOwnerClass The entity class owning the collection for the insert criteria
* @param collectionName The name of the collection contained in the owner entity class
* @param The type of the entity for the insert criteria
* @return A new insert criteria builder
* @since 1.2.0
*/
public InsertCriteriaBuilder insertCollection(EntityManager entityManager, Class insertOwnerClass, String collectionName);
}
