com.adobe.cq.social.srp.internal

Interface SocialDatabase

public interface SocialDatabase

An interface to provide various api to communicate with underlying UGC database/store

Method Summary

Modifier and Type	Method and Description
void	addAttachment(String key, Map<String,Object> attachment) Persist the attachment/binary into underlying db layer
void	batchRead(List<String> paths, List<Map<String,Object>> docs) Retrieve all documents corresponding with the provided paths and add them, in order, to the docs list
Map<String,Long>	countChildren(List<String> keyValues, String baseType, boolean visibleOnly) Fetch the count of db record matching the given inputs
Map<String,Object>	createDocument(Map<String,Object> origdata) Persist data to underlying database
void	deleteAttachment(String key) Delete the attachment matching the given key
APIResult	deleteDocument(String key) Delete record matching the key
InputStream	getAttachmentInputStream(String key) Retrieve the attachment/binary from the db
Map<String,Object>	readAttachment(String key) Read the attachment db record from underlying persistence layer
Map<String,Object>	readDocument(String key, boolean unpackMap)
List<Map<String,Object>>	readDocuments(String keyName, String keyValue, String baseType, int maxResults, int page, List<Map.Entry<String,Boolean>> orderBy, boolean visibleOnly)
List<Map<String,Object>>	readThread(String keyName, String keyValue, String baseType, int maxResults, int page, List<Map.Entry<String,Boolean>> orderBy, boolean visibleOnly) Read list of db record matching the given inputs
Map<String,Object>	updateDocument(String key, Map<String,Object> origdata) Update the db record matching the given key

Method Detail

readDocument

Map<String,Object> readDocument(String key,
                                boolean unpackMap)
                         throws IOException

Parameters:

key -

unpackMap -

Returns:

an ugc data from underlying database matching the unique key

Throws:

IOException

readDocuments

List<Map<String,Object>> readDocuments(String keyName,
                                       String keyValue,
                                       String baseType,
                                       int maxResults,
                                       int page,
                                       List<Map.Entry<String,Boolean>> orderBy,
                                       boolean visibleOnly)
                                throws IOException

Parameters:

keyName -

keyValue -

baseType -

maxResults -

page -

orderBy -

visibleOnly -

Returns:

a list of ugc data from underlying database matching the input criteria

Throws:

IOException

createDocument

Map<String,Object> createDocument(Map<String,Object> origdata)
                           throws PersistenceException

Persist data to underlying database

Parameters:

origdata -

Returns:

Throws:

PersistenceException

deleteDocument

APIResult deleteDocument(String key)
                  throws IOException

Delete record matching the key

Parameters:

key -

Returns:

Throws:

IOException

updateDocument

Map<String,Object> updateDocument(String key,
                                  Map<String,Object> origdata)
                           throws PersistenceException

Update the db record matching the given key

Parameters:

key -

origdata -

Returns:

Throws:

PersistenceException

readThread

List<Map<String,Object>> readThread(String keyName,
                                    String keyValue,
                                    String baseType,
                                    int maxResults,
                                    int page,
                                    List<Map.Entry<String,Boolean>> orderBy,
                                    boolean visibleOnly)
                             throws IOException

Read list of db record matching the given inputs

Parameters:

keyName -

keyValue -

baseType -

maxResults -

page -

orderBy -

visibleOnly -

Returns:

Throws:

IOException

addAttachment

void addAttachment(String key,
                   Map<String,Object> attachment)
            throws PersistenceException

Persist the attachment/binary into underlying db layer

Parameters:

key -

attachment -

Throws:

PersistenceException

getAttachmentInputStream

InputStream getAttachmentInputStream(String key)
                              throws IOException

Retrieve the attachment/binary from the db

Parameters:

key -

Returns:

Throws:

IOException

readAttachment

Map<String,Object> readAttachment(String key)
                           throws IOException

Read the attachment db record from underlying persistence layer

Parameters:

key -

Returns:

Throws:

IOException

deleteAttachment

void deleteAttachment(String key)
               throws IOException

Delete the attachment matching the given key

Parameters:

key -

Throws:

IOException

countChildren

Map<String,Long> countChildren(List<String> keyValues,
                               String baseType,
                               boolean visibleOnly)

Fetch the count of db record matching the given inputs

Parameters:

keyValues -

baseType -

visibleOnly -

Returns:

batchRead

void batchRead(List<String> paths,
               List<Map<String,Object>> docs)
        throws IOException

Retrieve all documents corresponding with the provided paths and add them, in order, to the docs list

Parameters:

paths -

docs -

Throws:

IOException