Package com.terracottatech.store.definition

Interface MapCellDefinition

All Superinterfaces:

CellDefinition<StoreMap>

public interface MapCellDefinition
extends CellDefinition<StoreMap>

Definition of a StoreMap cell.

Nested Class Summary

Nested classes/interfaces inherited from interface com.terracottatech.store.definition.CellDefinition

CellDefinition.CellImpl<T>, CellDefinition.Impl<T>

Method Summary

Modifier and Type	Method	Description
default BuildableTypedValueSelectionOptionalFunction<CellCollection>	find(String dotSpec)	Construct a potentially portable find function.
default BuildableTypedValueSelectionFunction<CellCollection>	findOrElse(String dotSpec, StoreMap otherwise)	Construct a potentially portable find function.
default BuildableTypedValueSelectionFunction<CellCollection>	findOrFail(String dotSpec)	Construct a potentially portable find function.
default BuildableMapOptionalFunction<CellCollection>	value()	Returns a function that extracts the value of this cell from a record.
default BuildableMapFunction<CellCollection>	valueOr(StoreMap otherwise)	Returns a function that extracts the value of this cell from a record or uses the given default if the cell is absent.
default BuildableMapFunction<CellCollection>	valueOrFail()	Returns a function that extracts the value of this cell from a record or throws a NoSuchElementException if the cell is absent.

Methods inherited from interface com.terracottatech.store.definition.CellDefinition

exists, name, newCell, type

Method Details

find

default BuildableTypedValueSelectionOptionalFunction<CellCollection> find(String dotSpec)

Construct a potentially portable find function. See ComplexData.find(String) for more info. This call will skip any records which do not have this cell.

Parameters:

dotSpec - find specification

Returns:

Find function

findOrFail

default BuildableTypedValueSelectionFunction<CellCollection> findOrFail(String dotSpec)

Construct a potentially portable find function. See ComplexData.find(String) for more info. This call will throw an exception if any records do not have this cell.

Parameters:

dotSpec - find specification

Returns:

Find function

findOrElse

default BuildableTypedValueSelectionFunction<CellCollection> findOrElse(String dotSpec,
 StoreMap otherwise)

Construct a potentially portable find function. See ComplexData.find(String) for more info. If the cell does not exist, the provided StoreMap will be used to evaluate the find against.

Parameters:

dotSpec - find specification

otherwise - alternative if cell is missing.

Returns:

Find function

value

default BuildableMapOptionalFunction<CellCollection> value()

Description copied from interface: CellDefinition

Returns a function that extracts the value of this cell from a record.

Specified by:

value in interface CellDefinition<StoreMap>

Returns:

a cell extracting function

valueOr

default BuildableMapFunction<CellCollection> valueOr(StoreMap otherwise)

Description copied from interface: CellDefinition

Returns a function that extracts the value of this cell from a record or uses the given default if the cell is absent.

Specified by:

valueOr in interface CellDefinition<StoreMap>

Parameters:

otherwise - default value for absent cells

Returns:

a cell extracting function

valueOrFail

default BuildableMapFunction<CellCollection> valueOrFail()

Description copied from interface: CellDefinition

Returns a function that extracts the value of this cell from a record or throws a NoSuchElementException if the cell is absent.

Specified by:

valueOrFail in interface CellDefinition<StoreMap>

Returns:

a cell extracting function