com.openkm.module.db

Class DbSearchModule

java.lang.Object

com.openkm.module.db.DbSearchModule

All Implemented Interfaces:

SearchModule

public class DbSearchModule
extends Object
implements SearchModule

Constructor Summary

Constructors

Constructor and Description
DbSearchModule()

Method Summary

Methods

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.
org.apache.lucene.search.Query	prepareStatement(QueryParams params) Prepare statement
long	saveSearch(String token, QueryParams params) Save a search for future use.
void	updateSearch(String token, QueryParams params) Updated a saved search.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DbSearchModule

public DbSearchModule()

Method Detail

findByContent

public List<QueryResult> findByContent(String token,
                              String expression)
                                throws IOException,
                                       ParseException,
                                       RepositoryException,
                                       DatabaseException

Description copied from interface: SearchModule

Search for documents using it indexed content.

Specified by:

findByContent in interface SearchModule

expression - Expression to be searched.

Returns:

A collection of document which content matched the searched expression.

Throws:

RepositoryException - If there is any general repository problem.

IOException

ParseException

DatabaseException

findByName

public List<QueryResult> findByName(String token,
                           String expression)
                             throws IOException,
                                    ParseException,
                                    RepositoryException,
                                    DatabaseException

Description copied from interface: SearchModule

Search for documents by document name.

Specified by:

findByName in interface SearchModule

expression - Expression to be searched.

Returns:

A collection of document which name matched the searched expression.

Throws:

RepositoryException - If there is any general repository problem.

IOException

ParseException

DatabaseException

findByKeywords

public List<QueryResult> findByKeywords(String token,
                               Set<String> expression)
                                 throws IOException,
                                        ParseException,
                                        RepositoryException,
                                        DatabaseException

Description copied from interface: SearchModule

Search for documents using it associated keywords.

Specified by:

findByKeywords in interface SearchModule

expression - Expression to be searched.

Returns:

A collection of document which keywords matched the searched expression.

Throws:

RepositoryException - If there is any general repository problem.

IOException

ParseException

DatabaseException

find

public List<QueryResult> find(String token,
                     QueryParams params)
                       throws IOException,
                              ParseException,
                              RepositoryException,
                              DatabaseException

Description copied from interface: SearchModule

Performs a complex search by content, name and keywords (between others).

Specified by:

find in interface SearchModule

params - The complex search elements.

Returns:

A collection of documents.

Throws:

IOException - If something fails when parsing metadata.

RepositoryException - If there is any general repository problem.

ParseException

DatabaseException

findPaginated

public ResultSet findPaginated(String token,
                      QueryParams params,
                      int offset,
                      int limit)
                        throws IOException,
                               ParseException,
                               RepositoryException,
                               DatabaseException

Description copied from interface: SearchModule

Performs a complex search by content, name and keywords. Paginated version.

Specified by:

findPaginated in interface SearchModule

params - The complex search elements.

offset - Query result list offset.

limit - Query result list limit.

Returns:

A result set with the total of the results and a collection of document from the resulting query statement.

Throws:

RepositoryException - If there is any general repository problem.

IOException

ParseException

DatabaseException

prepareStatement

public org.apache.lucene.search.Query prepareStatement(QueryParams params)
                                                throws IOException,
                                                       ParseException,
                                                       RepositoryException,
                                                       DatabaseException

Prepare statement

Throws:

IOException

ParseException

RepositoryException

DatabaseException

saveSearch

public long saveSearch(String token,
              QueryParams params)
                throws AccessDeniedException,
                       RepositoryException,
                       DatabaseException

Description copied from interface: SearchModule

Save a search for future use.

Specified by:

saveSearch in interface SearchModule

params - The query params.

Throws:

RepositoryException - If there is any general repository problem or the query fails.

AccessDeniedException

DatabaseException

updateSearch

public void updateSearch(String token,
                QueryParams params)
                  throws AccessDeniedException,
                         RepositoryException,
                         DatabaseException

Description copied from interface: SearchModule

Updated a saved search.

Specified by:

updateSearch in interface SearchModule

params - The query params.

Throws:

RepositoryException - If there is any general repository problem or the query fails.

AccessDeniedException

DatabaseException

getSearch

public QueryParams getSearch(String token,
                    int qpId)
                      throws PathNotFoundException,
                             RepositoryException,
                             DatabaseException

Description copied from interface: SearchModule

Get a saved search.

Specified by:

getSearch in interface SearchModule

Returns:

The saved search query params.

Throws:

RepositoryException - If there is any general repository problem or the query fails.

PathNotFoundException

DatabaseException

getAllSearchs

public List<QueryParams> getAllSearchs(String token)
                                throws RepositoryException,
                                       DatabaseException

Description copied from interface: SearchModule

Get all saved search.

Specified by:

getAllSearchs in interface SearchModule

Returns:

A collection with the names of the saved search.

Throws:

RepositoryException - If there is any general repository problem or the query fails.

DatabaseException

deleteSearch

public void deleteSearch(String token,
                long qpId)
                  throws AccessDeniedException,
                         RepositoryException,
                         DatabaseException

Description copied from interface: SearchModule

Delete a saved search.

Specified by:

deleteSearch in interface SearchModule

Throws:

RepositoryException - If there is any general repository problem or the query fails

AccessDeniedException

DatabaseException

getKeywordMap

public Map<String,Integer> getKeywordMap(String token,
                                List<String> filter)
                                  throws RepositoryException,
                                         DatabaseException

Description copied from interface: SearchModule

Return a Keyword map. This is a hash with the keywords and the occurrence.

Specified by:

getKeywordMap in interface SearchModule

filter - A collection of keywords used to obtain the related document keywords.

Returns:

The keyword map.

Throws:

RepositoryException - If there is any general repository problem or the query fails.

DatabaseException

getCategorizedDocuments

public List<Document> getCategorizedDocuments(String token,
                                     String categoryId)
                                       throws RepositoryException,
                                              DatabaseException

Description copied from interface: SearchModule

Get the documents within a category

Specified by:

getCategorizedDocuments in interface SearchModule

categoryId - The category id (UUID)

Returns:

A Collection of documents in the category

Throws:

RepositoryException - If there is any general repository problem or the query fails.

DatabaseException

getCategorizedFolders

public List<Folder> getCategorizedFolders(String token,
                                 String categoryId)
                                   throws RepositoryException,
                                          DatabaseException

Description copied from interface: SearchModule

Get the folders within a category

Specified by:

getCategorizedFolders in interface SearchModule

categoryId - The category id (UUID)

Returns:

A Collection of folders in the category

Throws:

RepositoryException - If there is any general repository problem or the query fails.

DatabaseException

getCategorizedMails

public List<Mail> getCategorizedMails(String token,
                             String categoryId)
                               throws RepositoryException,
                                      DatabaseException

Description copied from interface: SearchModule

Get the mails within a category

Specified by:

getCategorizedMails in interface SearchModule

categoryId - The category id (UUID)

Returns:

A Collection of mails in the category

Throws:

RepositoryException - If there is any general repository problem or the query fails.

DatabaseException

getDocumentsByKeyword

public List<Document> getDocumentsByKeyword(String token,
                                   String keyword)
                                     throws RepositoryException,
                                            DatabaseException

Description copied from interface: SearchModule

Get the documents with a keyword

Specified by:

getDocumentsByKeyword in interface SearchModule

keyword - The keyword

Returns:

A Collection of documents with the keyword

Throws:

RepositoryException - If there is any general repository problem or the query fails.

DatabaseException

getFoldersByKeyword

public List<Folder> getFoldersByKeyword(String token,
                               String keyword)
                                 throws RepositoryException,
                                        DatabaseException

Description copied from interface: SearchModule

Get the folders with a keyword

Specified by:

getFoldersByKeyword in interface SearchModule

keyword - The keyword

Returns:

A Collection of folders with the keyword

Throws:

RepositoryException - If there is any general repository problem or the query fails.

DatabaseException

getMailsByKeyword

public List<Mail> getMailsByKeyword(String token,
                           String keyword)
                             throws RepositoryException,
                                    DatabaseException

Description copied from interface: SearchModule

Get the mails with a keyword

Specified by:

getMailsByKeyword in interface SearchModule

keyword - The keyword

Returns:

A Collection of mails with the keyword

Throws:

RepositoryException - If there is any general repository problem or the query fails.

DatabaseException

getDocumentsByPropertyValue

public List<Document> getDocumentsByPropertyValue(String token,
                                         String group,
                                         String property,
                                         String value)
                                           throws RepositoryException,
                                                  DatabaseException

Description copied from interface: SearchModule

Get the documents with a property value

Specified by:

getDocumentsByPropertyValue in interface SearchModule

Returns:

A Collection of documents with the property value

Throws:

RepositoryException - If there is any general repository problem or the query fails.

DatabaseException

getFoldersByPropertyValue

public List<Folder> getFoldersByPropertyValue(String token,
                                     String group,
                                     String property,
                                     String value)
                                       throws RepositoryException,
                                              DatabaseException

Description copied from interface: SearchModule

Get the folders with a property value

Specified by:

getFoldersByPropertyValue in interface SearchModule

property - The property value

Returns:

A Collection of folders with the property value

Throws:

RepositoryException - If there is any general repository problem or the query fails.

DatabaseException

getMailsByPropertyValue

public List<Mail> getMailsByPropertyValue(String token,
                                 String group,
                                 String property,
                                 String value)
                                   throws RepositoryException,
                                          DatabaseException

Description copied from interface: SearchModule

Get the mails with a property value

Specified by:

getMailsByPropertyValue in interface SearchModule

property - The property value

Returns:

A Collection of mails with the property value

Throws:

RepositoryException - If there is any general repository problem or the query fails.

DatabaseException

findSimpleQuery

public List<QueryResult> findSimpleQuery(String token,
                                String statement)
                                  throws RepositoryException,
                                         DatabaseException

Description copied from interface: SearchModule

Performs a simple search using on GQL language.

Specified by:

findSimpleQuery in interface SearchModule

statement - The simple search in GQL language.

Returns:

A collection of documents.

Throws:

RepositoryException - If there is any general repository problem.

DatabaseException

See Also:

http://jackrabbit.apache.org/api/1.6/org/apache/jackrabbit/commons/query/GQL.html

findSimpleQueryPaginated

public ResultSet findSimpleQueryPaginated(String token,
                                 String statement,
                                 int offset,
                                 int limit)
                                   throws RepositoryException,
                                          DatabaseException

Description copied from interface: SearchModule

Performs a simple search using GQL languahe. Paginated version.

Specified by:

findSimpleQueryPaginated in interface SearchModule

statement - The simple search in GQL language.

offset - Query result list offset.

limit - Query result list limit.

Returns:

A result set with the total of the results and a collection of document from the resulting query statement.

Throws:

RepositoryException - If there is any general repository problem.

DatabaseException

See Also:

http://jackrabbit.apache.org/api/1.6/org/apache/jackrabbit/commons/query/GQL.html

findMoreLikeThis

public ResultSet findMoreLikeThis(String token,
                         String uuid,
                         int maxResults)
                           throws RepositoryException,
                                  DatabaseException

Description copied from interface: SearchModule

Find documents like a given one.

Specified by:

findMoreLikeThis in interface SearchModule

uuid - Uuid of the document to find other similar.

maxResults - Maximum number of returned documents.

Returns:

A result set with the total of the results and a collection of document from the resulting query statement.

Throws:

RepositoryException - If there is any general repository problem.

DatabaseException