com.attivio.sdk.client

Interface DocumentStoreApi

All Known Implementing Classes:

MockDocumentStore

public interface DocumentStoreApi

Client to the AIE document store (currently available only within an AIE node process).

DocumentStoreClients may be used within components by creating a private DocumentStoreClient field and setting the Spring @Autowired annotation on it.

$Revision$

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTENT_STORE_NAMESPACE_PREFIX the prefix for the content store namespace used when storing content pointers.
static List<String>	DEFAULT_FILTER_FIELDS

Method Summary

Modifier and Type	Method and Description
void	delete(String namespace, String docId) Deletes the document from the specified collection
Iterable<IngestDocument>	filteredRetrieve(String namespace, Map<String,String> filters) Finds and returns the documents matching the provided equality filters.
IngestDocument	retrieve(String namespace, String docId)
void	store(String namespace, IngestDocument doc, List<String> filterFields, boolean storeContentPointers) Stores the document in namespace, creating indexes which allow equality filtering on the list of fields provided.
IngestDocument	storeAndUpdate(String namespace, IngestDocument doc, List<String> filterFields, boolean storeContentPointers) Stores the document in namespace, creating indexes which allow equality filtering on the list of fields provided.

Field Detail

CONTENT_STORE_NAMESPACE_PREFIX

static final String CONTENT_STORE_NAMESPACE_PREFIX

the prefix for the content store namespace used when storing content pointers. if a document is stored in namespace 'collection1', then stored content pointers will be placed in the content store under namespace CONTENT_STORE_NAMESPACE_PREFIX+".collection1".

See Also:

Constant Field Values

DEFAULT_FILTER_FIELDS

static final List<String> DEFAULT_FILTER_FIELDS

Method Detail

delete

void delete(String namespace,
            String docId)
     throws AttivioException

Deletes the document from the specified collection

Parameters:

namespace -

docId -

Throws:

AttivioException

retrieve

IngestDocument retrieve(String namespace,
                        String docId)
                 throws AttivioException

Parameters:

namespace -

docId -

Returns:

the store document or null if it does not exist in the collection

Throws:

AttivioException

store

void store(String namespace,
           IngestDocument doc,
           List<String> filterFields,
           boolean storeContentPointers)
    throws AttivioException

Stores the document in namespace, creating indexes which allow equality filtering on the list of fields provided. Only the first value any multi-valued fields is available for filtering. The document may be temporarily altered during invocation. If the document mode is set to PARTIAL, the document will first be retrieved, updated with any fields from doc, then stored. If the document mode is set to ADD, any existing version of the document will be replaced.

The input document is always unmodified upon return.

Parameters:

namespace -

doc -

filterFields -

storeContentPointers - if false, content associated with content pointers will not be stored and upon retrieval the content may no longer be present.

Throws:

AttivioException

IllegalArgumentException - for document modes other than PARTIAL and ADD

storeAndUpdate

IngestDocument storeAndUpdate(String namespace,
                              IngestDocument doc,
                              List<String> filterFields,
                              boolean storeContentPointers)
                       throws AttivioException

Stores the document in namespace, creating indexes which allow equality filtering on the list of fields provided. Only the first value any multi-valued fields is available for filtering. The document may be temporarily altered during invocation. If the document mode is set to PARTIAL, the document will first be retrieved, updated with any fields from doc, then stored. It will then be modified and returned (to support remote API calls). The returned document will always have its document mode set to ADD if it had been PARTIAL, regardless of whether or not it had ever been stored.

If the document mode is set to ADD, any existing version of the document will be replaced and the returned document will be the original document.

Parameters:

namespace -

doc -

filterFields -

storeContentPointers - if false, content associated with content pointers will not be stored and upon retrieval the content may not be present.

Returns:

the updated document or original if mode was not PARTIAL

Throws:

AttivioException

IllegalArgumentException - for document modes other than PARTIAL and ADD

filteredRetrieve

Iterable<IngestDocument> filteredRetrieve(String namespace,
                                          Map<String,String> filters)
                                   throws AttivioException

Finds and returns the documents matching the provided equality filters. These filters must have been established during storage of documents in the collection.

Parameters:

namespace -

filters -

Returns:

an iterable over the matching documents

Throws:

AttivioException