net.kaczmarzyk.spring.data.jpa.web.annotation.Join Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of specification-arg-resolver Show documentation

An alternative API for filtering data with Spring MVC and Spring Data JPA. This library provides a custom HandlerMethodArgumentResolver that transforms HTTP parameters into a Specification object ready to use with Spring Data repositories.

There is a newer version: 3.1.0

Show newest version

/**
 * Copyright 2014-2022 the original author or authors.
 *
 * 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 net.kaczmarzyk.spring.data.jpa.web.annotation;

import javax.persistence.criteria.JoinType;
import java.lang.annotation.*;

/**
 * Specifies a join part of a query, e.g. {@code select c from Customer c inner join c.addresses a}
 *
 * @author Tomasz Kaczmarzyk
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.PARAMETER, ElementType.TYPE })
@Repeatable(RepeatedJoin.class)
public @interface Join {

	/**
	 * Specifies a collection property to join on, e.g. "addresses"
	 */
	String path();
	
	/**
	 * Specifies an alias for the joined part, e.g. "a"
	 */
	String alias();
	
	/**
	 * Whether the query should return distinct results or not
	 */
	boolean distinct() default true;
	
	JoinType type() default JoinType.INNER;
}