io.crnk.jpa.query.JpaQueryFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of crnk-jpa Show documentation

JSON API framework for Java

There is a newer version: 2.6.20180522184741

package io.crnk.jpa.query;

import java.util.List;

public interface JpaQueryFactory {

	/**
	 * Called by the JPA module ones initalized.
	 *
	 * @param context to access entityManager, meta-data, etc.
	 */
	void initalize(JpaQueryFactoryContext context);

	/**
	 * Builds a new query for the given entity class.
	 *
	 * @param          entity
	 * @param entityClass to query
	 * @return query
	 */
	 JpaQuery query(Class entityClass);

	/**
	 * Builds a new query for the given attribute. Used to retrieve relations of
	 * an entity.
	 *
	 * @param                parent entity
	 * @param parentEntityClass to fetch children from
	 * @param childrenAttrName  on parent entity
	 * @param parentIds         to retrieve the children from
	 * @return query
	 */
	 JpaQuery query(Class parentEntityClass, String childrenAttrName, List parentIds);

	/**
	 * @return ComputedAttributeRegistry holding registered computed attributes
	 */
	ComputedAttributeRegistry getComputedAttributes();

}