org.springframework.data.jpa.repository.support.JpaEntityInformation Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-data-jpa Show documentation
Show all versions of spring-data-jpa Show documentation
Spring Data module for JPA repositories.
/*
* Copyright 2011-2019 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 org.springframework.data.jpa.repository.support;
import javax.persistence.metamodel.SingularAttribute;
import org.springframework.data.jpa.repository.query.JpaEntityMetadata;
import org.springframework.data.repository.core.EntityInformation;
import org.springframework.lang.Nullable;
/**
* Extension of {@link EntityInformation} to capture additional JPA specific information about entities.
*
* @author Oliver Gierke
* @author Thomas Darimont
* @author Mark Paluch
*/
public interface JpaEntityInformation extends EntityInformation, JpaEntityMetadata {
/**
* Returns the id attribute of the entity.
*
* @return
*/
@Nullable
SingularAttribute getIdAttribute();
/**
* Returns the required identifier type.
*
* @return the identifier type.
* @throws IllegalArgumentException in case no id type could be obtained.
* @since 2.0
*/
default SingularAttribute getRequiredIdAttribute() throws IllegalArgumentException {
SingularAttribute id = getIdAttribute();
if (id != null) {
return id;
}
throw new IllegalArgumentException(
String.format("Could not obtain required identifier attribute for type %s!", getEntityName()));
}
/**
* Returns {@literal true} if the entity has a composite id.
*
* @return
*/
boolean hasCompositeId();
/**
* Returns the attribute names of the id attributes. If the entity has a composite id, then all id attribute names are
* returned. If the entity has a single id attribute then this single attribute name is returned.
*
* @return
*/
Iterable getIdAttributeNames();
/**
* Extracts the value for the given id attribute from a composite id
*
* @param id
* @param idAttribute
* @return
*/
@Nullable
Object getCompositeIdAttributeValue(Object id, String idAttribute);
}