io.evitadb.api.requestResponse.data.annotation.Reference Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of evita_api Show documentation
Show all versions of evita_api Show documentation
Module contains external API of the evitaDB.
/*
*
* _ _ ____ ____
* _____ _(_) |_ __ _| _ \| __ )
* / _ \ \ / / | __/ _` | | | | _ \
* | __/\ V /| | || (_| | |_| | |_) |
* \___| \_/ |_|\__\__,_|____/|____/
*
* Copyright (c) 2023
*
* Licensed under the Business Source License, Version 1.1 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://github.com/FgForrest/evitaDB/blob/master/LICENSE
*
* 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 io.evitadb.api.requestResponse.data.annotation;
import io.evitadb.api.requestResponse.schema.ReferenceSchemaContract;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Annotation is used to mark a field, getter method or record component as reference of the entity to another entity.
* This information, annotation attribute values and target field/method/component signature allows to generate
* {@link ReferenceSchemaContract}.
*
* @author Jan Novotný ([email protected]), FG Forrest a.s. (c) 2022
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.METHOD, ElementType.RECORD_COMPONENT})
public @interface Reference {
/**
* Name of the reference. Use camel-case naming style.
* Propagates to {@link ReferenceSchemaContract#getName()}
* If left empty the name is taken from the name of the field / property / component.
*/
String name() default "";
/**
* Description of the reference. Use Markdown format.
* Propagates to {@link ReferenceSchemaContract#getDescription()}.
*/
String description() default "";
/**
* Marks reference as deprecated and allows to specify the reason for it. Use Markdown format.
* Propagates to {@link ReferenceSchemaContract#getDeprecationNotice()}.
*/
String deprecated() default "";
/**
* Specifies the name of the target entity for the reference. If the field, method getter or record
* component returns a complex class and this class is annotated with {@link Entity} annotation or contains a field,
* method getter or record component marked with {@link ReferencedEntity} that relates to a complex class annotated
* with {@link Entity}, the value of this attribute can be derived from it. In such case also attribute
* {@link #managed()} is derived along with it.
*/
String entity() default "";
/**
* Specifies whether the {@link #entity()} targets an entity managed by the same evitaDB catalog (set to `true`)
* or an externally managed entity outside evitaDB catalog (set to `false`). The value of this attribute can be
* derived from class structure.
*
* @see #entity()
*/
boolean managed() default true;
/**
* Specifies the name of the group of target entity for the reference. If the field, method getter or record
* component returns a complex class and this class is annotated with {@link Entity} annotation or contains a field,
* method getter or record component marked with {@link ReferencedEntityGroup} that relates to a complex class annotated
* with {@link Entity}, the value of this attribute can be derived from it. In such case also attribute
* {@link #groupEntityManaged()} is derived along with it.
*/
String groupEntity() default "";
/**
* Specifies whether the {@link #groupEntity()} targets an entity managed by the same evitaDB catalog (set to `true`)
* or an externally managed entity outside evitaDB catalog (set to `false`). The value of this attribute can be
* derived from class structure.
*
* @see #groupEntity()
*/
boolean groupEntityManaged() default true;
/**
* If set to true (default) the entity may have the reference empty (i.e. without relation). If set to false, at
* least one reference of this type is required in order to commit transaction.
*
* This annotation along with the annotated field, method getter or record component type (whether it's array,
* collection or plain type) affects the {@link ReferenceSchemaContract#getCardinality()}.
*/
boolean allowEmpty() default true;
/**
* Enables filtering / sorting by attributes of reference of this name.
* Propagates to {@link ReferenceSchemaContract#isIndexed()}.
*/
boolean indexed() default false;
/**
* Enables facet computation for reference of this name.
* Propagates to {@link ReferenceSchemaContract#isFaceted()}.
*/
boolean faceted() default false;
}