Package dev.getelements.elements.rt.transact

Interface PathIndex

All Known Implementing Classes:

UnixFSPathIndex

public interface PathIndex

Manages the index of paths to revisions ResourceIds as well as the inverse relationship.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	PathIndex.Listing	Represents a listing of a Path.

Method Summary

Modifier and Type	Method	Description
void	applyChange(Path path, String transactionId)	Applies the change to the ResourceIndex according to the supplied transaction ID.
void	cleanup(Path path, String transactionId)	Cleans up whatever may have been left behind by a partial transaction.
default Optional<ResourceEntry>	findEntry(Path path)	Loads the ResourceEntry from the supplied Path.
Optional<ResourceEntry>	findEntry(Path path, Supplier<ResourceEntry.OperationalStrategy> operationalStrategy)	Loads the ResourceEntry from the supplied Path.
default Optional<ResourceId>	findResourceId(Path path)	Gets the ResourceId for the supplied path.
Stream<PathIndex.Listing>	list(Path path)	Lists all associations between Path and ResourceIds.

Method Details

cleanup

void cleanup(Path path,
 String transactionId)

Cleans up whatever may have been left behind by a partial transaction.

Parameters:

path - the Path

transactionId - the transaction ID

applyChange

void applyChange(Path path,
 String transactionId)

Applies the change to the ResourceIndex according to the supplied transaction ID.

Parameters:

path - the Path

transactionId - the transaction ID from which to apply

findEntry

default Optional<ResourceEntry> findEntry(Path path)

Loads the ResourceEntry from the supplied Path. If non-existent then this will load a nascent path entry.

Parameters:

path -

Returns:

the Path

findEntry

Optional<ResourceEntry> findEntry(Path path,
 Supplier<ResourceEntry.OperationalStrategy> operationalStrategy)

Loads the ResourceEntry from the supplied Path. If non-existent then this will load a nascent path entry.

Returns:

the Path

list

Stream<PathIndex.Listing> list(Path path)

Lists all associations between Path and ResourceIds. This inclues listing of direct path links as well as wildcard path links.

Parameters:

path - the Path, may be wildcard if searching for multiple paths.

Returns:

a Stream<ResourceService.Listing> instances

findResourceId

default Optional<ResourceId> findResourceId(Path path)

Gets the ResourceId for the supplied path.

Parameters:

path - the Path to find

Returns:

the ResourceId or Optional.empty() if no such resource exists at the path