Module io.fluxzero.sdk

Package io.fluxzero.sdk.persisting.search

Class DefaultIndexOperation

java.lang.Object

io.fluxzero.sdk.persisting.search.DefaultIndexOperation

All Implemented Interfaces:

IndexOperation

public class DefaultIndexOperation
extends Object
implements IndexOperation

Default implementation of the IndexOperation interface.

This class provides a mutable, builder-style implementation for preparing and executing document indexing operations using a DocumentStore.

Instances of this class are typically created by calling DocumentStore.prepareIndex(Object). Upon construction, the document ID, collection name, and timestamps are automatically extracted from the object's class using reflection.

See Also:

• DocumentStore
• IndexOperation

Constructor Summary

Constructors

Constructor	Description
DefaultIndexOperation()

Method Summary

Modifier and Type	Method	Description
IndexOperation	copy()	Creates a deep copy of this operation, preserving all configured values.
CompletableFuture<Void>	index(io.fluxzero.common.Guarantee guarantee)	Executes the indexing operation with the provided guarantee.
static DefaultIndexOperation	prepare(DocumentStore documentStore, @NonNull Object object)	Prepare a new DefaultIndexOperation instance for managing document indexing.
static DefaultIndexOperation	prepare(DocumentStore documentStore, Object object, @NonNull Object collection, String idPath, String beginPath, String endPath)
static DefaultIndexOperation	prepare(DocumentStore documentStore, Object object, @NonNull Object collection, Function<Object,?> idFunction, Function<Object,Instant> beginFunction, Function<Object,Instant> endFunction)
io.fluxzero.common.api.search.SerializedDocument	toDocument()	Converts the current state of the IndexOperation into a Document instance.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.fluxzero.sdk.persisting.search.IndexOperation

addMetadata, addMetadata, addMetadata, collection, end, end, id, id, ifNotExists, ifNotExists, index, indexAndForget, indexAndWait, indexAndWait, metadata, metadata, period, start, start, timestamp

Constructor Details

DefaultIndexOperation

public DefaultIndexOperation()

Method Details

prepare

public static DefaultIndexOperation prepare(DocumentStore documentStore,
 @NonNull
 @NonNull Object object)

Prepare a new DefaultIndexOperation instance for managing document indexing.

Parameters:

documentStore - the DocumentStore used to store and manage the index operations

object - the object to be indexed, which will be analyzed and converted for storage

Returns:

an index operation initialized for the given object

prepare

public static DefaultIndexOperation prepare(DocumentStore documentStore,
 Object object,
 @NonNull
 @NonNull Object collection,
 String idPath,
 String beginPath,
 String endPath)

prepare

public static DefaultIndexOperation prepare(DocumentStore documentStore,
 Object object,
 @NonNull
 @NonNull Object collection,
 Function<Object,?> idFunction,
 Function<Object,Instant> beginFunction,
 Function<Object,Instant> endFunction)

index

public CompletableFuture<Void> index(io.fluxzero.common.Guarantee guarantee)

Description copied from interface: IndexOperation

Executes the indexing operation with the provided guarantee.

Specified by:

index in interface IndexOperation

toDocument

public io.fluxzero.common.api.search.SerializedDocument toDocument()

Description copied from interface: IndexOperation

Converts the current state of the IndexOperation into a Document instance.

Specified by:

toDocument in interface IndexOperation

copy

public IndexOperation copy()

Description copied from interface: IndexOperation

Creates a deep copy of this operation, preserving all configured values.

Specified by:

copy in interface IndexOperation