Package de.espirit.firstspirit.client.access.editor.lists

Interface Index

All Superinterfaces:

Collection<Index.Record>, Iterable<Index.Record>

public interface Index
extends Collection<Index.Record>

Container value holding an arbitrary number of records referring to some data.

Since:

5.2.11

See Also:

• IndexEditorValue

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Index.Record	Single entry of an index providing some meta data on the item and a reference to the item itself.

Method Summary

Modifier and Type	Method	Description
@NotNull Index.Record	create(String identifier)	Create a record from the given identifier.
<T> @NotNull DataAccessSession<T>	createSession(@NotNull SpecialistsBroker broker)	Creates a session based on the definition and configuration of the underlying source.

Methods inherited from interface java.util.Collection

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, parallelStream, remove, removeAll, removeIf, retainAll, size, spliterator, stream, toArray, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach

Method Details

createSession

@ApiDoc(comment="Creates a session based on the definition and configuration of the underlying source.",
        since="5.2.191103")
@NotNull
<T> @NotNull DataAccessSession<T> createSession(@NotNull
 @NotNull SpecialistsBroker broker)

Creates a session based on the definition and configuration of the underlying source. NOTE: For a more generic use (e.g. for batch-processing multiple indexes using the same template) please refer to GomIndexSource.createSession(SpecialistsBroker, boolean) instead.

Type Parameters:

T - The type of data provided by the source.

Parameters:

broker - A broker providing contextual knowledge.

Returns:

A new session.

Since:

5.2.191103

create

@ApiDoc(comment="Create a record from the given identifier.",
        since="5.2.13")
@NotNull
@NotNull Index.Record create(String identifier)

Create a record from the given identifier.
Note: The index does not validate a given identifier wrt. the index's source.

Parameters:

identifier - The identifier of the element to be referred to.

Returns:

A record on the identified element.

Since:

5.2.13