public interface SearchModule
Modifier and Type | Method and Description |
---|---|
void |
deleteSearch(String token,
long qpId)
Delete a saved search.
|
List<QueryResult> |
find(String token,
QueryParams params)
Performs a complex search by content, name and keywords (between others).
|
List<QueryResult> |
findByContent(String token,
String expression)
Search for documents using it indexed content.
|
List<QueryResult> |
findByKeywords(String token,
Set<String> expression)
Search for documents using it associated keywords.
|
List<QueryResult> |
findByName(String token,
String expression)
Search for documents by document name.
|
ResultSet |
findMoreLikeThis(String token,
String uuid,
int maxResults)
Find documents like a given one.
|
ResultSet |
findPaginated(String token,
QueryParams params,
int offset,
int limit)
Performs a complex search by content, name and keywords.
|
List<QueryResult> |
findSimpleQuery(String token,
String statement)
Performs a simple search using on GQL language.
|
ResultSet |
findSimpleQueryPaginated(String token,
String statement,
int offset,
int limit)
Performs a simple search using GQL languahe.
|
List<QueryParams> |
getAllSearchs(String token)
Get all saved search.
|
List<Document> |
getCategorizedDocuments(String token,
String categoryId)
Get the documents within a category
|
List<Folder> |
getCategorizedFolders(String token,
String categoryId)
Get the folders within a category
|
List<Mail> |
getCategorizedMails(String token,
String categoryId)
Get the mails within a category
|
List<Document> |
getDocumentsByKeyword(String token,
String keyword)
Get the documents with a keyword
|
List<Document> |
getDocumentsByPropertyValue(String token,
String group,
String property,
String value)
Get the documents with a property value
|
List<Folder> |
getFoldersByKeyword(String token,
String keyword)
Get the folders with a keyword
|
List<Folder> |
getFoldersByPropertyValue(String token,
String group,
String property,
String value)
Get the folders with a property value
|
Map<String,Integer> |
getKeywordMap(String token,
List<String> filter)
Return a Keyword map.
|
List<Mail> |
getMailsByKeyword(String token,
String keyword)
Get the mails with a keyword
|
List<Mail> |
getMailsByPropertyValue(String token,
String group,
String property,
String value)
Get the mails with a property value
|
QueryParams |
getSearch(String token,
int qpId)
Get a saved search.
|
long |
saveSearch(String token,
QueryParams params)
Save a search for future use.
|
void |
updateSearch(String token,
QueryParams params)
Updated a saved search.
|
List<QueryResult> findByContent(String token, String expression) throws IOException, ParseException, AccessDeniedException, RepositoryException, DatabaseException
expression
- Expression to be searched.RepositoryException
- If there is any general repository problem.IOException
ParseException
AccessDeniedException
DatabaseException
List<QueryResult> findByName(String token, String expression) throws IOException, ParseException, AccessDeniedException, RepositoryException, DatabaseException
expression
- Expression to be searched.RepositoryException
- If there is any general repository problem.IOException
ParseException
AccessDeniedException
DatabaseException
List<QueryResult> findByKeywords(String token, Set<String> expression) throws IOException, ParseException, AccessDeniedException, RepositoryException, DatabaseException
expression
- Expression to be searched.RepositoryException
- If there is any general repository problem.IOException
ParseException
AccessDeniedException
DatabaseException
List<QueryResult> find(String token, QueryParams params) throws IOException, ParseException, AccessDeniedException, RepositoryException, DatabaseException
params
- The complex search elements.RepositoryException
- If there is any general repository problem.IOException
- If something fails when parsing metadata.ParseException
AccessDeniedException
DatabaseException
ResultSet findPaginated(String token, QueryParams params, int offset, int limit) throws IOException, ParseException, AccessDeniedException, RepositoryException, DatabaseException
params
- The complex search elements.offset
- Query result list offset.limit
- Query result list limit.RepositoryException
- If there is any general repository problem.IOException
ParseException
AccessDeniedException
DatabaseException
long saveSearch(String token, QueryParams params) throws AccessDeniedException, RepositoryException, DatabaseException
params
- The query params.name
- The name of the query to be saved.RepositoryException
- If there is any general repository problem or the query fails.AccessDeniedException
DatabaseException
void updateSearch(String token, QueryParams params) throws AccessDeniedException, RepositoryException, DatabaseException
params
- The query params.name
- The name of the query to be saved.RepositoryException
- If there is any general repository problem or the query fails.AccessDeniedException
DatabaseException
QueryParams getSearch(String token, int qpId) throws AccessDeniedException, PathNotFoundException, RepositoryException, DatabaseException
name
- The name of the saved search to retrieve.RepositoryException
- If there is any general repository problem or the query fails.AccessDeniedException
PathNotFoundException
DatabaseException
List<QueryParams> getAllSearchs(String token) throws AccessDeniedException, RepositoryException, DatabaseException
RepositoryException
- If there is any general repository problem or the query fails.AccessDeniedException
DatabaseException
void deleteSearch(String token, long qpId) throws AccessDeniedException, RepositoryException, DatabaseException
name
- The name of the saved searchPathNotFoundException
- If there is no saved search with this name.RepositoryException
- If there is any general repository problem or the query failsAccessDeniedException
DatabaseException
Map<String,Integer> getKeywordMap(String token, List<String> filter) throws AccessDeniedException, RepositoryException, DatabaseException
filter
- A collection of keywords used to obtain the related document keywords.RepositoryException
- If there is any general repository problem or the query fails.AccessDeniedException
DatabaseException
List<Document> getCategorizedDocuments(String token, String categoryId) throws AccessDeniedException, RepositoryException, DatabaseException
categoryId
- The category id (UUID)RepositoryException
- If there is any general repository problem or the query fails.AccessDeniedException
DatabaseException
List<Folder> getCategorizedFolders(String token, String categoryId) throws AccessDeniedException, RepositoryException, DatabaseException
categoryId
- The category id (UUID)RepositoryException
- If there is any general repository problem or the query fails.AccessDeniedException
DatabaseException
List<Mail> getCategorizedMails(String token, String categoryId) throws AccessDeniedException, RepositoryException, DatabaseException
categoryId
- The category id (UUID)RepositoryException
- If there is any general repository problem or the query fails.AccessDeniedException
DatabaseException
List<Document> getDocumentsByKeyword(String token, String keyword) throws AccessDeniedException, RepositoryException, DatabaseException
keyword
- The keywordRepositoryException
- If there is any general repository problem or the query fails.AccessDeniedException
DatabaseException
List<Folder> getFoldersByKeyword(String token, String keyword) throws AccessDeniedException, RepositoryException, DatabaseException
keyword
- The keywordRepositoryException
- If there is any general repository problem or the query fails.AccessDeniedException
DatabaseException
List<Mail> getMailsByKeyword(String token, String keyword) throws AccessDeniedException, RepositoryException, DatabaseException
keyword
- The keywordRepositoryException
- If there is any general repository problem or the query fails.AccessDeniedException
DatabaseException
List<Document> getDocumentsByPropertyValue(String token, String group, String property, String value) throws AccessDeniedException, RepositoryException, DatabaseException
keyword
- The property valueRepositoryException
- If there is any general repository problem or the query fails.AccessDeniedException
DatabaseException
List<Folder> getFoldersByPropertyValue(String token, String group, String property, String value) throws AccessDeniedException, RepositoryException, DatabaseException
property
- The property valueRepositoryException
- If there is any general repository problem or the query fails.AccessDeniedException
DatabaseException
List<Mail> getMailsByPropertyValue(String token, String group, String property, String value) throws AccessDeniedException, RepositoryException, DatabaseException
property
- The property valueRepositoryException
- If there is any general repository problem or the query fails.AccessDeniedException
DatabaseException
List<QueryResult> findSimpleQuery(String token, String statement) throws AccessDeniedException, RepositoryException, DatabaseException
statement
- The simple search in GQL language.RepositoryException
- If there is any general repository problem.AccessDeniedException
DatabaseException
http://jackrabbit.apache.org/api/1.6/org/apache/jackrabbit/commons/query/GQL.html
ResultSet findSimpleQueryPaginated(String token, String statement, int offset, int limit) throws AccessDeniedException, RepositoryException, DatabaseException
statement
- The simple search in GQL language.offset
- Query result list offset.limit
- Query result list limit.RepositoryException
- If there is any general repository problem.AccessDeniedException
DatabaseException
http://jackrabbit.apache.org/api/1.6/org/apache/jackrabbit/commons/query/GQL.html
ResultSet findMoreLikeThis(String token, String uuid, int maxResults) throws AccessDeniedException, RepositoryException, DatabaseException
uuid
- Uuid of the document to find other similar.maxResults
- Maximum number of returned documents.RepositoryException
- If there is any general repository problem.AccessDeniedException
DatabaseException
Copyright © 2016. All rights reserved.