com.adobe.cq.social.srp.internal

Interface SocialDataService

@ProviderType
public interface SocialDataService

An interface defining low-level access to Adobe Cloud Storage.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SocialDataService.BrowseDocumentsResult Used in browseDocuments to return the page of documents found and the count of all matching documents.
static class	SocialDataService.Counts Used in browseDocuments to indicate whether and which count of children is desired.

Method Summary

Modifier and Type	Method and Description
void	addAttachment(java.lang.String key, java.util.Map<java.lang.String,java.lang.Object> attachment) Add an attachment.
java.util.List<APIResult>	batchCommit(java.util.List<APICommand> commands)
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	browseDocuments(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) Browse the documents associated with the given key.
SocialDataService.BrowseDocumentsResult	browseDocuments(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, SocialDataService.Counts counts) Browse the documents associated with the given key.
void	close() Close the service.
java.util.Map<java.lang.String,java.lang.Long>	countChildren(java.util.List<java.lang.String> keyValues, java.lang.String childType, boolean visibleOnly) Count the visible, or all the documents associated with the given keys.
long	countChildren(java.lang.String keyValue, java.lang.String childType, boolean visibleOnly) Count the visible, or all the documents associated with the given key.
void	deleteAttachment(java.lang.String key) Delete an attachment.
FacetResults	facetedSearch(java.lang.String queryToAs, java.util.List<java.lang.String> facetFields, java.util.List<java.lang.String> pivotFields, java.lang.String numRows, java.lang.String mincount, boolean isPivot) Do a faceted search.
SocialResourceSearchResult<java.util.Map<java.lang.String,java.lang.Object>>	find(java.lang.String componentFilter, java.lang.String luceneQuery, java.util.List<SearchSortField> sortFields, int offset, int limit) Search.
SocialResourceSearchResult<java.util.Map<java.lang.String,java.lang.Object>>	find(java.lang.String component, java.lang.String solrQueryString, java.util.List<SearchSortField> sortFields, int offset, int limit, java.util.Map<java.lang.String,java.lang.Object> signals) Search.
FacetSearchResult	findFacets(java.util.List<java.lang.String> fieldNames, java.util.List<FacetRangeField> rangeFields, java.lang.String resourceTypeFilter, java.lang.String componentFilter, int count, boolean visibleOnly, boolean includeChildren) Search collections Faceted search
SocialResourceSearchResult<java.util.Map<java.lang.String,java.lang.Object>>	findFacets(java.util.List<java.lang.String> inPath, java.util.List<java.lang.String> notInPath, java.util.List<java.lang.String> fieldNames, java.util.List<FacetRangeField> facetRanges, java.lang.String scoredQueryString, int maxFacetCount, java.util.List<SearchSortField> sortFields, int offset, int pageSize) Do a combined faceted search and filtered search, returning both the facets and an actual page of results
java.io.InputStream	getAttachmentInputStream(java.lang.String path) Get the attachment data as an InputStream and not just the meta data of the attachment
int	getCommentIndex(java.lang.String keyName, java.lang.String keyValue, java.lang.String commentToCheck, java.lang.String baseType, boolean visibleOnly) Get the index position of a reply amongst replies of a comment
java.lang.String	getDSClient() Return the placeholder for dataservice client EG: 'ASRP|MSRP'
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	getMLTResults(java.lang.String query, java.lang.String statusFilter, java.lang.String resourceTypeFilter, java.lang.String componentFilter, java.util.List<java.lang.String> mltField, int maxResults, int minTermFreq, int minDocFreq) Look for documents close to the provided query.
boolean	isConfigured()
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	nonFacetedSearch(java.lang.String queryToAs) Do a regular search.
java.util.Map<java.lang.String,java.lang.Object>	readAttachment(java.lang.String key) Read an attachment.
java.util.Map<java.lang.String,java.lang.Object>	readDocument(java.lang.String key) Read a document.
java.util.Map<java.lang.String,APIResult>	readDocuments(java.util.List<java.lang.String> keys) Read a list of documents.
void	setConfiguration(SocialResourceConfiguration configuration) Set the configuration to use.

Method Detail

readDocument

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

Read a document.

Parameters:

key - the key

Returns:

the document

Throws:

java.io.IOException - on failure

readDocuments

java.util.Map<java.lang.String,APIResult> readDocuments(java.util.List<java.lang.String> keys)
                                                 throws java.io.IOException

Read a list of documents.

Parameters:

keys - the keys

Returns:

a map where each key is associated with the corresponding document, or else the error associated with trying to retrieve it

Throws:

java.io.IOException - on failure to parse

batchCommit

java.util.List<APIResult> batchCommit(java.util.List<APICommand> commands)
                               throws java.io.IOException

Throws:

java.io.IOException

getMLTResults

java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getMLTResults(java.lang.String query,
                                                                               java.lang.String statusFilter,
                                                                               java.lang.String resourceTypeFilter,
                                                                               java.lang.String componentFilter,
                                                                               java.util.List<java.lang.String> mltField,
                                                                               int maxResults,
                                                                               int minTermFreq,
                                                                               int minDocFreq)
                                                                        throws java.io.IOException

Look for documents close to the provided query.

Parameters:

query - The string to match

statusFilter - the status of the documents to match

resourceTypeFilter - the resource type(s) to match

componentFilter - the component to match

mltField - the field in the document to match

maxResults - the most results to return

minTermFreq - the number of times a term has to be in the query to be used

minDocFreq - the number of docs a term has to be in for the term to be used.

Returns:

the matching list of documents

Throws:

java.io.IOException - on failure

find

SocialResourceSearchResult<java.util.Map<java.lang.String,java.lang.Object>> find(java.lang.String componentFilter,
                                                                                  java.lang.String luceneQuery,
                                                                                  java.util.List<SearchSortField> sortFields,
                                                                                  int offset,
                                                                                  int limit)
                                                                           throws java.io.IOException

Search.

Parameters:

componentFilter - the component to filter on

luceneQuery - the lucene query

sortFields - sort fields

offset - starting offset

limit - max to return

Returns:

list of matching docs

Throws:

java.io.IOException - on failure

find

SocialResourceSearchResult<java.util.Map<java.lang.String,java.lang.Object>> find(java.lang.String component,
                                                                                  java.lang.String solrQueryString,
                                                                                  java.util.List<SearchSortField> sortFields,
                                                                                  int offset,
                                                                                  int limit,
                                                                                  java.util.Map<java.lang.String,java.lang.Object> signals)
                                                                           throws java.io.IOException

Search.

Parameters:

component - the component to filter on

solrQueryString - the lucene query

sortFields - sort fields

offset - starting offset

limit - max to return

signals - contains query params(userlanguage, browserlanguge etc)

Returns:

list of matching docs

Throws:

java.io.IOException - on failure

findFacets

FacetSearchResult findFacets(java.util.List<java.lang.String> fieldNames,
                             java.util.List<FacetRangeField> rangeFields,
                             java.lang.String resourceTypeFilter,
                             java.lang.String componentFilter,
                             int count,
                             boolean visibleOnly,
                             boolean includeChildren)
                      throws java.io.IOException

Search collections Faceted search

Parameters:

fieldNames - Fields for which we want facet counts

resourceTypeFilter - Resource filter

componentFilter - Component filter

count - Maximum number of results

visibleOnly - whether to filter by visibility

rangeFields - List of range fields

includeChildren - boolean flag

Returns:

map containing names and counts

Throws:

java.io.IOException - IOException

findFacets

SocialResourceSearchResult<java.util.Map<java.lang.String,java.lang.Object>> findFacets(java.util.List<java.lang.String> inPath,
                                                                                        java.util.List<java.lang.String> notInPath,
                                                                                        java.util.List<java.lang.String> fieldNames,
                                                                                        java.util.List<FacetRangeField> facetRanges,
                                                                                        java.lang.String scoredQueryString,
                                                                                        int maxFacetCount,
                                                                                        java.util.List<SearchSortField> sortFields,
                                                                                        int offset,
                                                                                        int pageSize)
                                                                                 throws java.io.IOException

Do a combined faceted search and filtered search, returning both the facets and an actual page of results

Parameters:

inPath - a list of the parent paths to be searched

fieldNames - the fields being used for faceted searches by value

facetRanges - the fields and intervals being used for faceted searches by range

scoredQueryString - a search string for which solr calculates degree of match (the "q" parameter)

maxFacetCount - the limit of facet results to return, or 0 for no limit

sortFields - fields to sort by, with their directions, in the returned results

offset - page offset

pageSize - page size

notInPath - List of paths

Returns:

The returned data structure is basically a list of the raw results that also holds results for the facets

Throws:

java.io.IOException - IOException

browseDocuments

SocialDataService.BrowseDocumentsResult browseDocuments(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,
                                                        @Nonnull
                                                        SocialDataService.Counts counts)
                                                 throws java.io.IOException

Browse the documents associated with the given key.

Parameters:

keyName - the name of the index to query on

keyValue - the value in the index

baseType - the base type of the documents to list (can be empty or null)

maxResults - the max number of result to return. If all results should be returned, send maxResults < 0

page - the 0-based page of results to return. Only used if maxResults > 0

orderBy - a list of field name and booleans to dictate the order of the results. For the boolean false is descending order and true is to sort in ascending order.

visibleOnly - whether to (true) return only visible documents, or (false) all documents

counts - whether to count matching documents and whether to count all documents or just the visible documents.

Returns:

the list of matching documents and if requested a count of the matching documents (either all or just the visible ones)

Throws:

java.io.IOException - on failure

browseDocuments

java.util.List<java.util.Map<java.lang.String,java.lang.Object>> browseDocuments(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

Browse the documents associated with the given key.

Parameters:

keyName - the name of the index to query on

keyValue - the value in the index

baseType - the base type of the documents to list (can be empty or null)

maxResults - the max number of result to return. If all results should be returned, send maxResults < 0

page - the 0-based page of results to return. Only used if maxResults > 0

orderBy - a list of field name and booleans to dictate the order of the results. For the boolean false is descending order and true is to sort in ascending order.

visibleOnly - whether to (true) return only visible documents, or (false) all documents

Returns:

the list of matching docs.

Throws:

java.io.IOException - on failure

getCommentIndex

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

Get the index position of a reply amongst replies of a comment

Parameters:

keyName - the name of the index to query on

keyValue - the value in the index

commentToCheck - the comment whose index need to be found

baseType - the base type of the documents to list (can be empty or null)

visibleOnly - whether to (true) return only visible documents, or (false) all documents

Returns:

the index of comment to check.

addAttachment

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

Add an attachment.

Parameters:

key - the key

attachment - the attachment data

Throws:

java.io.IOException - on failure

readAttachment

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

Read an attachment.

Parameters:

key - the key

Returns:

the attachment data

Throws:

java.io.IOException - on failure

countChildren

long countChildren(java.lang.String keyValue,
                   java.lang.String childType,
                   boolean visibleOnly)
            throws java.io.IOException

Count the visible, or all the documents associated with the given key.

Parameters:

keyValue - the value in the index

childType - the value of the base_type to filter by, or null if no base type filtering should be done

visibleOnly - if true, the count of only the visible (not hidden, spam ..) docs is returned

Returns:

The number of matching docs and the number of visible matching docs.

Throws:

java.io.IOException - on failure

countChildren

java.util.Map<java.lang.String,java.lang.Long> countChildren(java.util.List<java.lang.String> keyValues,
                                                             java.lang.String childType,
                                                             boolean visibleOnly)
                                                      throws java.io.IOException

Count the visible, or all the documents associated with the given keys.

Parameters:

keyValues - the path of each parent id to get a child count for

childType - the value of the base_type to filter by, or null if no base type filtering should be done

visibleOnly - if true, the count of only the visible (not hidden, spam ..) docs is returned

Returns:

The number of matching docs and the number of visible matching docs.

Throws:

java.io.IOException - on failure

close

void close()

Close the service.

deleteAttachment

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

Delete an attachment.

Parameters:

key - the key to be deleted.

Throws:

java.io.IOException - on failure

setConfiguration

void setConfiguration(SocialResourceConfiguration configuration)

Set the configuration to use.

Parameters:

configuration - the configuration.

isConfigured

boolean isConfigured()

Returns:

true if configuration was set

facetedSearch

FacetResults facetedSearch(java.lang.String queryToAs,
                           java.util.List<java.lang.String> facetFields,
                           java.util.List<java.lang.String> pivotFields,
                           java.lang.String numRows,
                           java.lang.String mincount,
                           boolean isPivot)
                    throws java.io.IOException

Do a faceted search.

Parameters:

queryToAs - the query to use

facetFields - the facet fields to use

pivotFields - the pivot fields to use

numRows - the number of results to return

mincount - the min number of docs matching the facet to include the result

isPivot - true iff this is a pivot search

Returns:

the results.

Throws:

java.io.IOException - on failure

nonFacetedSearch

java.util.List<java.util.Map<java.lang.String,java.lang.Object>> nonFacetedSearch(java.lang.String queryToAs)
                                                                           throws java.io.IOException

Do a regular search.

Parameters:

queryToAs - the query

Returns:

the matching documents

Throws:

java.io.IOException - on failure

getAttachmentInputStream

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

Get the attachment data as an InputStream and not just the meta data of the attachment

Parameters:

path - path the to attachment resource

Returns:

the attachment as an InputStream

Throws:

java.io.IOException - on error

getDSClient

java.lang.String getDSClient()

Return the placeholder for dataservice client EG: 'ASRP|MSRP'

Returns:

String