com.adobe.cq.social.srp.internal

Interface SocialDatabase

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

Method Detail

readDocument

java.util.Map<java.lang.String,java.lang.Object> readDocument(java.lang.String key,
                                                              boolean unpackMap)
                                                       throws java.io.IOException

Parameters:

key - Key

unpackMap - Map

Returns:

an ugc data from underlying database matching the unique key

Throws:

java.io.IOException - IOException

readDocuments

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

Parameters:

keyName - String

keyValue - String

baseType - String

maxResults - int

page - int

orderBy - List

visibleOnly - boolean

Returns:

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

Throws:

java.io.IOException - IOException

getCommentIndex

int getCommentIndex(java.lang.String keyName,
                    java.lang.String keyValue,
                    java.lang.String commentToCheck,
                    java.lang.String baseType,
                    boolean visibleOnly)

Parameters:

keyName - String

keyValue - String

commentToCheck - String

baseType - String

visibleOnly - boolean

Returns:

index of current comment amongst all comments of a post

createDocument

java.util.Map<java.lang.String,java.lang.Object> createDocument(java.util.Map<java.lang.String,java.lang.Object> origdata)
                                                         throws PersistenceException

Persist data to underlying database

Parameters:

origdata - Map

Returns:

Map

Throws:

PersistenceException - PersistenceException

deleteDocument

APIResult deleteDocument(java.lang.String key)
                  throws java.io.IOException

Delete record matching the key

Parameters:

key - String

Returns:

APIResult

Throws:

java.io.IOException - IOException

updateDocument

java.util.Map<java.lang.String,java.lang.Object> updateDocument(java.lang.String key,
                                                                java.util.Map<java.lang.String,java.lang.Object> origdata)
                                                         throws PersistenceException

Update the db record matching the given key

Parameters:

key - String

origdata - Map

Returns:

Map

Throws:

PersistenceException - PersistenceException

readThread

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

Read list of db record matching the given inputs

Parameters:

keyName - String

keyValue - String

baseType - String

maxResults - int

page - int

orderBy - List

visibleOnly - boolean

Returns:

List List

Throws:

java.io.IOException - IOException

addAttachment

void addAttachment(java.lang.String key,
                   java.util.Map<java.lang.String,java.lang.Object> attachment)
            throws PersistenceException

Persist the attachment/binary into underlying db layer

Parameters:

key - String

attachment - Map

Throws:

PersistenceException - PersistenceException

getAttachmentInputStream

java.io.InputStream getAttachmentInputStream(java.lang.String key)
                                      throws java.io.IOException

Retrieve the attachment/binary from the db

Parameters:

key - String

Returns:

InputStream

Throws:

java.io.IOException - IOException

readAttachment

java.util.Map<java.lang.String,java.lang.Object> readAttachment(java.lang.String key)
                                                         throws java.io.IOException

Read the attachment db record from underlying persistence layer

Parameters:

key - String

Returns:

Map

Throws:

java.io.IOException - IOException

deleteAttachment

void deleteAttachment(java.lang.String key)
               throws java.io.IOException

Delete the attachment matching the given key

Parameters:

key - String

Throws:

java.io.IOException - IOException

countChildren

java.util.Map<java.lang.String,java.lang.Long> countChildren(java.util.List<java.lang.String> keyValues,
                                                             java.lang.String baseType,
                                                             boolean visibleOnly)

Fetch the count of db record matching the given inputs

Parameters:

keyValues - List

baseType - String

visibleOnly - boolean

Returns:

Map

batchRead

void batchRead(java.util.List<java.lang.String> paths,
               java.util.List<java.util.Map<java.lang.String,java.lang.Object>> docs)
        throws java.io.IOException

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

Parameters:

paths - List

docs - List

Throws:

java.io.IOException - IOException