org.modeshape.schematic

Interface SchematicDb

All Superinterfaces:

Lifecycle, Lockable, TransactionListener

public interface SchematicDb
extends TransactionListener, Lifecycle, Lockable

A store for JSON documents and other binary content, plus a library of JSON Schema documents used to describe and validate the stored documents.

Since:

5.0

Author:

Horia Chiorean

Method Summary

Modifier and Type	Method and Description
default boolean	containsKey(String key) Determine whether the database contains an entry with the supplied key.
EditableDocument	editContent(String key, boolean createIfMissing) Get an editor for the content of the given entry with the supplied key.
Document	get(String key) Get the document with the supplied key.
default SchematicEntry	getEntry(String key) Get the entry with the supplied key.
String	id() Returns a unique identifier for this schematic DB.
List<String>	keys() Returns a set over all the keys present in the DB.
List<SchematicEntry>	load(Collection<String> keys) Loads a set of documents from the DB returning the corresponding schematic entries.
default boolean	lockForWriting(List<String> locks) Locks a list of keys exclusively, for writing.
default void	put(String key, Document content) Store the supplied content document at the given key.
void	put(String key, SchematicEntry entry) Stores the supplied schematic entry under the given key.
default void	putEntry(Document entryDocument) Store the supplied document.
SchematicEntry	putIfAbsent(String key, Document content) Store the supplied content at the given key.
boolean	remove(String key) Remove the existing document at the given key.
void	removeAll() Removes all the entries from this DB.

Methods inherited from interface org.modeshape.schematic.TransactionListener

txCommitted, txRolledback, txStarted

Methods inherited from interface org.modeshape.schematic.Lifecycle

start, stop

Methods inherited from interface org.modeshape.schematic.Lockable

lockForWriting

Method Detail

id

String id()

Returns a unique identifier for this schematic DB.

Implementations should make sure that the provided id is unique per storage instance. In other words, if two SchematicDb instances of the same type store data in two different places, they should return a different id.

Returns:

a String, never null

keys

List<String> keys()

Returns a set over all the keys present in the DB.

If this method is called within an existing transaction, it should take into account the transient transactional context (i.e. any local but not yet committed changes)

Returns:

a List instance, never null

get

Document get(String key)

Get the document with the supplied key. This will represent the full SchematicEntry document if one exists.

If this method is called within an existing transaction, it should take into account the transient transactional context (i.e. any local but not yet committed changes)

Parameters:

key - the key or identifier for the document

Returns:

the document, or null if there was no document with the supplied key

load

List<SchematicEntry> load(Collection<String> keys)

Loads a set of documents from the DB returning the corresponding schematic entries.

If this method is called within an existing transaction, it should take into account the transient transactional context (i.e. any local but not yet committed changes) and either use that (if it exists) or the persisted information.

Parameters:

keys - an Collection of keys; never null

Returns:

a List of entries; never null

put

@RequiresTransaction
void put(String key,
                              SchematicEntry entry)

Stores the supplied schematic entry under the given key. If an entry already exists with the same key, it should be overwritten.

Parameters:

key - a schematic entry id, never null

entry - a SchematicEntry instance, never null

editContent

@RequiresTransaction
EditableDocument editContent(String key,
                                                  boolean createIfMissing)

Get an editor for the content of the given entry with the supplied key.

Parameters:

key - the key or identifier for the document

createIfMissing - true if a new entry should be created and added to the database if an existing entry does not exist

Returns:

the content document, or null if there was no document with the supplied key and a new one could not be created

putIfAbsent

@RequiresTransaction
SchematicEntry putIfAbsent(String key,
                                                Document content)

Store the supplied content at the given key.

Depending on the actual implementation, this may or may not be thread-safe. ModeShape never assumes this is thread-safe when calling it.

Parameters:

key - the key or identifier for the content

content - the content that is to be stored

Returns:

the existing entry for the supplied key, or null if there was no entry and the put was successful

remove

@RequiresTransaction
boolean remove(String key)

Remove the existing document at the given key.

Parameters:

key - the key or identifier for the document

Returns:

true if the removal was successful, false otherwise

removeAll

@RequiresTransaction
void removeAll()

Removes all the entries from this DB.

put

@RequiresTransaction
default void put(String key,
                                      Document content)

Store the supplied content document at the given key. If a document already exists with the given key, this should overwrite the existing document.

Parameters:

key - the key or identifier for the document

content - the document that is to be stored

See Also:

putIfAbsent(String, Document)

lockForWriting

@RequiresTransaction
default boolean lockForWriting(List<String> locks)

Description copied from interface: Lockable

Locks a list of keys exclusively, for writing.

Specified by:

lockForWriting in interface Lockable

Parameters:

locks - a list of locks

Returns:

true if the operation was successful and the locks were obtained, false otherwise

getEntry

default SchematicEntry getEntry(String key)

Get the entry with the supplied key.

If this method is called within an existing transaction, it should take into account the transient transactional context (i.e. any local but not yet committed changes)

Parameters:

key - the key or identifier for the document

Returns:

the entry, or null if there was no document with the supplied key

containsKey

default boolean containsKey(String key)

Determine whether the database contains an entry with the supplied key.

If this method is called within an existing transaction, it should take into account the transient transactional context (i.e. any local but not yet committed changes)

Parameters:

key - the key or identifier for the document

Returns:

true if the database contains an entry with this key, or false otherwise

putEntry

@RequiresTransaction
default void putEntry(Document entryDocument)

Store the supplied document. This document is expected to be a full entry document, which contains both a "metadata" and "content" section.

Parameters:

entryDocument - the document that contains the metadata document and content document.

See Also:

putIfAbsent(String, Document)