Package dev.getelements.elements.rt.transact

Interface ResourceIndex

All Known Implementing Classes:

UnixFSResourceIndex

public interface ResourceIndex

Allows for fetching and opening of the Resource data.

Method Summary

Modifier and Type	Method	Description
void	applyContentsChange(ResourceId resourceId, String transactionId)	Applies the change to the ResourceIndex according to the supplied transaction ID.
void	applyReversePathsChange(ResourceId resourceId, String transactionId)	Applies the change to the ResourceIndex according to the supplied transaction ID.
void	cleanup(ResourceId resourceId, String transactionId)	Cleans up whatever may have been left behind by a partial transaction.
default boolean	exists(ResourceId resourceId)	Checks if a ResourceId exists.
default Optional<ResourceEntry>	findEntry(ResourceId resourceId)	Loads the ResourceEntry from the supplied Path.
Optional<ResourceEntry>	findEntry(ResourceId resourceId, Supplier<ResourceEntry.OperationalStrategy> operationalStrategy)	Loads the ResourceEntry from the supplied Path.
default Optional<Set<Path>>	findReversePaths(ResourceId resourceId)	Finds reverse paths for the ResourceId.
ResourceEntry	newEntry(ResourceId resourceId, Supplier<ResourceEntry.OperationalStrategy> operationalStrategy)	Creates a new ResourceEntry with the supplied transaction id and ResourceId.
ResourceContents	updateContents(ResourceId resourceId)	Creates a new ResourceContents for the supplied ResourceId.

Method Details

cleanup

void cleanup(ResourceId resourceId,
 String transactionId)

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

Parameters:

transactionId - the transaction ID

applyContentsChange

void applyContentsChange(ResourceId resourceId,
 String transactionId)

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

Parameters:

resourceId - the ResourceId

transactionId - the transaction ID from which to apply

applyReversePathsChange

void applyReversePathsChange(ResourceId resourceId,
 String transactionId)

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

Parameters:

resourceId - the ResourceId

transactionId - the transaction ID from which to apply

newEntry

ResourceEntry newEntry(ResourceId resourceId,
 Supplier<ResourceEntry.OperationalStrategy> operationalStrategy)

Creates a new ResourceEntry with the supplied transaction id and ResourceId.

Parameters:

resourceId - the resource id

operationalStrategy - the operational strategy

updateContents

ResourceContents updateContents(ResourceId resourceId)

Creates a new ResourceContents for the supplied ResourceId.

Parameters:

resourceId - the contents

Returns:

the ResourceContents

findEntry

default Optional<ResourceEntry> findEntry(ResourceId resourceId)

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

Returns:

the Path

findEntry

Optional<ResourceEntry> findEntry(ResourceId resourceId,
 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

findReversePaths

default Optional<Set<Path>> findReversePaths(ResourceId resourceId)

Finds reverse paths for the ResourceId.

Parameters:

resourceId - the ResourceId

Returns:

the Optional set of reverse paths

exists

default boolean exists(ResourceId resourceId)

Checks if a ResourceId exists.

Parameters:

resourceId - the ResourceId

Returns:

true if it exists, false otherwise