Class AggregatePath.ColumnInfos

java.lang.Object

org.springframework.data.relational.core.mapping.AggregatePath.ColumnInfos

Enclosing interface:

AggregatePath

public static class AggregatePath.ColumnInfos
extends Object

A group of AggregatePath.ColumnInfo values referenced by there respective AggregatePath. It is used in a similar way as ColumnInfo when one needs to consider more than a single column. This is relevant for composite ids and references to such ids.

Since:

4.0

Author:

Jens Schauder, Mark Paluch

Method Summary

Modifier and Type	Method	Description
AggregatePath.ColumnInfo	any()	Any of the contained AggregatePath.ColumnInfo instances.
<T> T	any(BiFunction<AggregatePath, AggregatePath.ColumnInfo, T> mapper)	Calls the mapper for each pair one pair of AggregatePath and AggregatePath.ColumnInfo, if there is any.
static AggregatePath.ColumnInfos	empty()	An empty ColumnInfos instance with a fixed base path.
void	forEach(BiConsumer<AggregatePath, AggregatePath.ColumnInfo> consumer)	Calls the consumer for each pair of AggregatePath and ColumnInfo.
@Nullable AggregatePath.ColumnInfo	get(AggregatePath path)	Gets the AggregatePath.ColumnInfo for the provided AggregatePath
boolean	isEmpty()	Checks if this instance is empty, i.e. does not contain any AggregatePath.ColumnInfo instance.
Iterable<AggregatePath>	paths()	Return an Iterable of AggregatePath associated with this column infos.
<T> T	reduce(T identity, BiFunction<AggregatePath, AggregatePath.ColumnInfo, T> accumulator, BinaryOperator<T> combiner)	Performs a Stream.reduce(Object, BiFunction, BinaryOperator) on AggregatePath.ColumnInfo and AggregatePath to reduce the results into a single T return value.
int	size()	Number of ColumnInfo elements in this instance.
List<Column>	toColumnList(BiFunction<AggregatePath, AggregatePath.ColumnInfo, Column> mappingFunction)	Creates a List of Column instances by applying the provided mapping function to each AggregatePath and AggregatePath.ColumnInfo.
List<Column>	toColumnList(Table table)	Converts the given Table into a list of Columns.
Map<AggregatePath, Column>	toMap(Table table)	Create a Map of AggregatePath to Column using the given Table as column source.
AggregatePath.ColumnInfo	unique()	If this instance contains exactly one AggregatePath.ColumnInfo it will be returned.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

empty

public static AggregatePath.ColumnInfos empty()

An empty ColumnInfos instance with a fixed base path. Useful as a base when collecting AggregatePath.ColumnInfo instances into an ColumnInfos instance.

Returns:

an empty instance save the basePath.

unique

public AggregatePath.ColumnInfo unique()

If this instance contains exactly one AggregatePath.ColumnInfo it will be returned.

Returns:

the unique ColumnInfo if present.

Throws:

IllegalStateException - if the number of contained ColumnInfo instances is not exactly 1.

any

public AggregatePath.ColumnInfo any()

Any of the contained AggregatePath.ColumnInfo instances.

Returns:

a AggregatePath.ColumnInfo instance.

Throws:

NoSuchElementException - if no instance is available.

toMap

public Map<AggregatePath, Column> toMap(Table table)

Create a Map of AggregatePath to Column using the given Table as column source.

Parameters:

table -

Returns:

a Map of AggregatePath to Columns.

Since:

4.0

toColumnList

public List<Column> toColumnList(Table table)

Converts the given Table into a list of Columns. This method retrieves and caches the list of columns for the specified table. If the columns are not already cached, it computes the list by mapping columnInfos to their corresponding Column in the provided table and then stores the result in the cache.

Parameters:

table - the Table for which the columns should be generated; must not be null.

Returns:

a list of Columns associated with the specified Table. Guaranteed no to be null.

toColumnList

public List<Column> toColumnList(BiFunction<AggregatePath, AggregatePath.ColumnInfo, Column> mappingFunction)

Creates a List of Column instances by applying the provided mapping function to each AggregatePath and AggregatePath.ColumnInfo.

Parameters:

mappingFunction - function to map AggregatePath and AggregatePath.ColumnInfo to a Column.

Returns:

a list of Columns.

Since:

4.0

reduce

public <T> T reduce(T identity,
 BiFunction<AggregatePath, AggregatePath.ColumnInfo, T> accumulator,
 BinaryOperator<T> combiner)

Performs a Stream.reduce(Object, BiFunction, BinaryOperator) on AggregatePath.ColumnInfo and AggregatePath to reduce the results into a single T return value.

If ColumnInfos is empty, then identity is returned. Without invoking combiner. The combiner is called with the current state (or initial identity) and the accumulated T state to combine both into a single return value.

Type Parameters:

T - type of the result.

Parameters:

identity - the identity (initial) value for the combiner function.

accumulator - an associative, non-interfering (free of side effects), stateless function for incorporating an additional element into a result.

combiner - an associative, non-interfering, stateless function for combining two values, which must be compatible with the accumulator function.

Returns:

result of the function.

Since:

4.0

forEach

public void forEach(BiConsumer<AggregatePath, AggregatePath.ColumnInfo> consumer)

Calls the consumer for each pair of AggregatePath and ColumnInfo.

Parameters:

consumer - the function to call.

any

public <T> T any(BiFunction<AggregatePath, AggregatePath.ColumnInfo, T> mapper)

Calls the mapper for each pair one pair of AggregatePath and AggregatePath.ColumnInfo, if there is any.

Parameters:

mapper - the function to call.

Returns:

the result of the mapper

Throws:

NoSuchElementException - if this ColumnInfo is empty.

get

public @Nullable AggregatePath.ColumnInfo get(AggregatePath path)

Gets the AggregatePath.ColumnInfo for the provided AggregatePath

Parameters:

path - for which to return the ColumnInfo

Returns:

ColumnInfo for the given path.

paths

public Iterable<AggregatePath> paths()

Return an Iterable of AggregatePath associated with this column infos.

Returns:

isEmpty

public boolean isEmpty()

Checks if this instance is empty, i.e. does not contain any AggregatePath.ColumnInfo instance.

Returns:

true iff the collection of ColumnInfo is empty.

size

public int size()

Number of ColumnInfo elements in this instance.

Returns:

the size of the collection of ColumnInfo.