Package io.github.joselion.springr2dbcrelationships.processors

Interface Processable<T extends Annotation,U>

Type Parameters:

T - the type of the processed annotation

U - the type of value populated or persisted

All Known Implementing Classes:

ManyToManyProcessor, ManyToOneProcessor, OneToManyProcessor, OneToOneProcessor

public interface Processable<T extends Annotation,U>

Describes how a relationship annotation is processed.

Method Summary

Modifier and Type	Method	Description
default String	columnNameOf(Field field)	Returns the column name representation of a field.
default @Nullable String	columnNameOrNull(Field field)	Returns the column name representation of a field or null if the persistent property does not exist.
org.springframework.context.ApplicationContext	context()	Returns the Spring application context.
default Optional<String>	createdColumnOf(Class<?> type)	Returns an Optional containing the auditable column used to mark the date of creation or empty.
default <S> Optional<String>	createdColumnOf(S target)	Returns an Optional containing the auditable column used to mark the date of creation or empty.
default <S> Class<?>	domainFor(Class<S> type)	Returns the actual domain of an entity which may or may not be projected by another type.
Object	entity()	Returns the entity where the annotated field is being processed.
default String	idColumnOf(Class<?> type)	Returns the primary key column name of an entity type.
default @Nullable Object	idValueOf(Object target)	Returns the primary key value of an entity if exists, otherwise null.
default Optional<Field>	inferForeignField(String foreignKey)	Tries to infer the foreign key field in the current entity type.
default Optional<Field>	inferForeignField(String foreignKey, Class<?> entityType)	Tries to infer the foreign key field in the specified entity type.
default boolean	isNew(Object entity)	Returns true if the entity is considered to be new, false otherwise.
default Function<T,reactor.core.publisher.Mono<U>>	persist(Field field)	Curried version of persist(Annotation, Field) method.
reactor.core.publisher.Mono<U>	persist(T annotation, Field field)	Persists the value of a field annotated with a relationship annotation.
default Function<T,reactor.core.publisher.Mono<U>>	populate(Field field)	Curried version of populate(Annotation, Field) method.
reactor.core.publisher.Mono<U>	populate(T annotation, Field field)	Returns a Mono containing the value used to populate a field annotated with a relationship annotation.
default <S, I> reactor.core.publisher.Mono<S>	save(S entity)	Inserts an entity when it's new or update it otherwise.
org.springframework.data.relational.core.sql.SqlIdentifier	table()	Returns the SQL identifier of the table associated with the entity where the annotated field is being processed.
default org.springframework.data.relational.core.sql.SqlIdentifier	tableIdentifierOf(Class<?> type)	Returns the table SqlIdentifier of an entity type.
default String	tableNameOf(Class<?> type)	Returns the table name of an entity type.
org.springframework.data.r2dbc.core.R2dbcEntityTemplate	template()	Returns the r2dbc entity template injected to the processor.

Method Details

populate

reactor.core.publisher.Mono<U> populate(T annotation,
 Field field)

Returns a Mono containing the value used to populate a field annotated with a relationship annotation.

Parameters:

annotation - the field's annotation instance

field - the field to be populated

Returns:

a publisher containing the value to populate

populate

default Function<T,reactor.core.publisher.Mono<U>> populate(Field field)

Curried version of populate(Annotation, Field) method.

Parameters:

field - field the field to be populated

Returns:

a function taht takes the annotation T and returns a publisher containing the value to populate

persist

reactor.core.publisher.Mono<U> persist(T annotation,
 Field field)

Persists the value of a field annotated with a relationship annotation. Then returns a Mono containing the result of the operation.

Parameters:

annotation - the field's annotation instance

field - the field to be persisted

Returns:

a publisher containing the value os the persist operation

persist

default Function<T,reactor.core.publisher.Mono<U>> persist(Field field)

Curried version of persist(Annotation, Field) method.

Parameters:

field - the field to be persisted

Returns:

a function that takes the annotation T and returns a publisher containing the value os the persist operation

template

org.springframework.data.r2dbc.core.R2dbcEntityTemplate template()

Returns the r2dbc entity template injected to the processor.

Returns:

the r2dbc entity template

entity

Object entity()

Returns the entity where the annotated field is being processed.

Returns:

the field's entity

table

org.springframework.data.relational.core.sql.SqlIdentifier table()

Returns the SQL identifier of the table associated with the entity where the annotated field is being processed.

Returns:

the entity's table SQL identifier

context

org.springframework.context.ApplicationContext context()

Returns the Spring application context.

Returns:

the application context

isNew

default boolean isNew(Object entity)

Returns true if the entity is considered to be new, false otherwise.

Parameters:

entity - the entity to check if it's new

Returns:

true if the entity is new, false otherwise

save

default <S,
I> reactor.core.publisher.Mono<S> save(S entity)

Inserts an entity when it's new or update it otherwise.

Type Parameters:

S - the entity type

I - the type of the entity identifier

Parameters:

entity - the entity to insert/update

Returns:

a publisher containing the inserted/updated entity

domainFor

default <S> Class<?> domainFor(Class<S> type)

Returns the actual domain of an entity which may or may not be projected by another type.

Type Parameters:

S - the type of type's class

Parameters:

type - the type to get the domain from

Returns:

the actual domain type

tableIdentifierOf

default org.springframework.data.relational.core.sql.SqlIdentifier tableIdentifierOf(Class<?> type)

Returns the table SqlIdentifier of an entity type.

Parameters:

type - the type of the entity

Returns:

the table identifier

tableNameOf

default String tableNameOf(Class<?> type)

Returns the table name of an entity type.

Parameters:

type - the type of the entity

Returns:

the table name

idColumnOf

default String idColumnOf(Class<?> type)

Returns the primary key column name of an entity type.

Parameters:

type - the entity type

Returns:

the primary key column name

idValueOf

default @Nullable Object idValueOf(Object target)

Returns the primary key value of an entity if exists, otherwise null.

Parameters:

target - the target entity

Returns:

the id value of the target

createdColumnOf

default Optional<String> createdColumnOf(Class<?> type)

Returns an Optional containing the auditable column used to mark the date of creation or empty.

Parameters:

type - the target's type to find the field

Returns:

an optional with the creation date column or empty

createdColumnOf

default <S> Optional<String> createdColumnOf(S target)

Returns an Optional containing the auditable column used to mark the date of creation or empty.

Type Parameters:

S - the type of the target

Parameters:

target - the target to find the field

Returns:

an optional with the creation date column or empty

columnNameOf

default String columnNameOf(Field field)

Returns the column name representation of a field.

Parameters:

field - the field that maps the column

Returns:

the column name of the field

columnNameOrNull

default @Nullable String columnNameOrNull(Field field)

Returns the column name representation of a field or null if the persistent property does not exist.

Parameters:

field - the field that maps the column

Returns:

the column name of the field or null

inferForeignField

default Optional<Field> inferForeignField(String foreignKey,
 Class<?> entityType)

Tries to infer the foreign key field in the specified entity type.

Parameters:

foreignKey - the foreign key column name

entityType - the entity type to find the field from

Returns:

the foreign key field

inferForeignField

default Optional<Field> inferForeignField(String foreignKey)

Tries to infer the foreign key field in the current entity type.

Parameters:

foreignKey - the foreign key column name

Returns:

the foreign key field