org.modeshape.jcr.cache.document

Interface DocumentStore

All Known Implementing Classes:

FederatedDocumentStore, LocalDocumentStore

public interface DocumentStore

A store which persists/retrieves documents in a JCR context.

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(String key) Determine whether the database contains an entry with the supplied key.
String	createExternalProjection(String projectedNodeKey, String sourceName, String externalPath, String alias) Creates an external projection from the federated node with the given key, towards the external node from the given path, from a source.
EditableDocument	edit(String key, boolean createIfMissing) Edit the existing document at the given key.
SchematicEntry	get(String key) Get the entry with the supplied key.
Document	getChildReference(String parentKey, String childKey) Returns a document representing a single child reference from the supplied parent to the supplied child.
Document	getChildrenBlock(String key) Returns a document representing a block of children, that has the given key.
ExternalBinaryValue	getExternalBinary(String sourceName, String id) Retrieves a binary value which has the given id and which is not stored by ModeShape.
String	getLocalSourceKey() Returns the value of the local repository source key.
List<SchematicEntry>	load(Collection<String> keys) Loads a set of entries from the document store.
LocalDocumentStore	localStore() Returns a local store instance which is used to persist internal repository information.
boolean	lockDocuments(Collection<String> keys) Attempts to lock all of the documents with the given keys.
boolean	lockDocuments(String... keys) Attempts to lock all of the documents with the given keys.
String	newDocumentKey(String parentKey, Name documentName, Name documentPrimaryType) Generates a new key which will be assigned to a new child document when it is being added to its parent.
boolean	remove(String key) Remove the existing document at the given key.
void	setLocalSourceKey(String sourceKey) Sets the value of the local repository source key.
SchematicEntry	storeIfAbsent(String key, Document document) Store the supplied document at the given key.
void	updateDocument(String key, Document document, SessionNode sessionNode) Updates the content of the document at the given key with the given document.

Method Detail

get

SchematicEntry get(String key)

Get the entry with the supplied key.

Parameters:

key - the key or identifier for the document

Returns:

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

Throws:

DocumentStoreException - if there is a problem retrieving the document

See Also:

SchematicDb.get(String)

load

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

Loads a set of entries from the document store. This should always return the latest persisted view of the entries.

Parameters:

keys - a Set of document keys; may not be null

Returns:

a Collection of entries; never null

storeIfAbsent

@RequiresTransaction
SchematicEntry storeIfAbsent(String key,
                                                   Document document)

Store the supplied document at the given key.

Parameters:

key - the key or identifier for the document

document - the document 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

Throws:

DocumentStoreException - if there is a problem storing the document

See Also:

SchematicDb.putIfAbsent(String, Document)

updateDocument

@RequiresTransaction
void updateDocument(String key,
                                          Document document,
                                          SessionNode sessionNode)

Updates the content of the document at the given key with the given document.

Parameters:

key - the key or identifier for the document

document - the content with which the existing document should be updated

sessionNode - the SessionNode instance which contains the changes that caused the update

Throws:

DocumentStoreException - if there is a problem updating the document

newDocumentKey

String newDocumentKey(String parentKey,
                      Name documentName,
                      Name documentPrimaryType)

Generates a new key which will be assigned to a new child document when it is being added to its parent.

Parameters:

parentKey - a non-null String, the key of the existing parent

documentName - non-null Name, the name of the new child document.

documentPrimaryType - non-null Name, the name of the primary type of the new child document

Returns:

a String which will be assigned as key to the new child, or null indicating that no preferred key is to be used. If this is the case, the repository will assign a random key.

lockDocuments

@RequiresTransaction
boolean lockDocuments(Collection<String> keys)

Attempts to lock all of the documents with the given keys.

NOTE: This should only be called within an existing transaction. If this operation succeeds, all the locked keys will be released automatically when the transaction completes (regardless whether successfully or not).

Parameters:

keys - the set of keys identifying the documents that are to be updated via updateDocument(String, Document, SessionNode) or via edit(String,boolean).

Returns:

true if the documents were locked, or false if not all of the documents could be locked

Throws:

IllegalStateException - if no active transaction can be detected when the locking is attempted |

lockDocuments

@RequiresTransaction
boolean lockDocuments(String... keys)

Attempts to lock all of the documents with the given keys.

NOTE: This should only be called within an existing transaction. If this operation succeeds, all the locked keys will be released automatically when the transaction completes (regardless whether successfully or not)

Parameters:

keys - the set of keys identifying the documents that are to be updated via updateDocument(String, Document, SessionNode) or via edit(String,boolean).

Returns:

true if the documents were locked, or false if not all of the documents could be locked

Throws:

IllegalStateException - if no active transaction can be detected when the locking is attempted

edit

@RequiresTransaction
EditableDocument edit(String key,
                                            boolean createIfMissing)

Edit the existing document at the given key.

NOTE: This method does not perform any locking on that key. As such, the caller code should make sure lockDocuments(java.util.Collection<java.lang.String>) is called first on all the keys that are about to be changed if the operation can be performed from a concurrent context.

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:

a EditableDocument instance if either a document exists at the given key or a new one was created and added successfully. If a document does not already exist and cannot be created, then this will return null

See Also:

SchematicDb.editContent(String, boolean)

remove

@RequiresTransaction
boolean remove(String key)

Remove the existing document at the given key.

NOTE: This method does not perform any locking on that key. As such, the caller code should make sure lockDocuments(java.util.Collection<java.lang.String>) is called first on all the keys that are about to be changed if the operation can be performed from a concurrent context.

Parameters:

key - the key or identifier for the document

Returns:

true if a document was removed, or false if there was no document with that key

Throws:

DocumentStoreException - if there is a problem removing the document

See Also:

SchematicDb.remove(String)

containsKey

boolean containsKey(String key)

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

Parameters:

key - the key or identifier for the document

Returns:

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

See Also:

SchematicDb.containsKey(String)

setLocalSourceKey

void setLocalSourceKey(String sourceKey)

Sets the value of the local repository source key.

Parameters:

sourceKey - a non-null string

getLocalSourceKey

String getLocalSourceKey()

Returns the value of the local repository source key.

Returns:

a non-null string

localStore

LocalDocumentStore localStore()

Returns a local store instance which is used to persist internal repository information.

Returns:

a non-null LocalDocumentStore instance.

createExternalProjection

String createExternalProjection(String projectedNodeKey,
                                String sourceName,
                                String externalPath,
                                String alias)

Creates an external projection from the federated node with the given key, towards the external node from the given path, from a source.

Parameters:

projectedNodeKey - a non-null string, the key of the federated node which will contain the projection

sourceName - a non-null string, the name of an external source.

externalPath - a non-null string, representing a path towards a node from the source

alias - a non-null string, representing the alias given to the projection.

Returns:

a non-null string representing the node key of the external node located at externalPath.

getChildrenBlock

Document getChildrenBlock(String key)

Returns a document representing a block of children, that has the given key.

Parameters:

key - a non-null String the key of the block

Returns:

either a Document with children and possibly a pointer to the next block, or null if there isn't a block with such a key.

getChildReference

Document getChildReference(String parentKey,
                           String childKey)

Returns a document representing a single child reference from the supplied parent to the supplied child. This method is called when it is too expensive to find the child reference within the child references.

Parameters:

parentKey - the key for the parent

childKey - the key for the child

Returns:

the document representation of a child reference, or null if the implementation doesn't support this method or the parent does not contain a child with the given key

getExternalBinary

ExternalBinaryValue getExternalBinary(String sourceName,
                                      String id)

Retrieves a binary value which has the given id and which is not stored by ModeShape.

Parameters:

sourceName - a non-null String; the name of an external source

id - a non-null String; the id of an external binary value

Returns:

either an ExternalBinaryValue implementation or null