SearchDAO (OpenKM Web Application 6.3.0 API)

java.lang.Object
- com.openkm.dao.SearchDAO

```
public class SearchDAO
extends Object
```
Search results are filtered by com.openkm.module.db.stuff.ReadAccessFilterFactory, which limit the results only for those which have read access.

Author:

pavila

Field Summary

Fields
Modifier and Type	Field and Description
`static org.apache.lucene.analysis.Analyzer`	`analyzer`
`static String`	`SEARCH_ACCESS_MANAGER_LIMITED`
`static String`	`SEARCH_ACCESS_MANAGER_MORE`
`static String`	`SEARCH_ACCESS_MANAGER_WINDOW`
`static String`	`SEARCH_LUCENE`

Method Summary

Methods
Modifier and Type	Method and Description
`NodeResultSet`	`findByQuery(org.apache.lucene.search.Query query, int offset, int limit)` Search by query
`NodeResultSet`	`findBySimpleQuery(String expression, int offset, int limit)` Search by simple query
`List<String>`	`findFoldersInDepth(String parentUuid)` Find by parent in depth TODO This cache should be for every user (no pass through access manager) and cleaned after a create, move or copy folder operation.
`static SearchDAO`	`getInstance()`
`List<String>`	`getTerms(Class<?> entityType, String nodeUuid)` Get Lucent document terms.
`NodeResultSet`	`moreLikeThis(String uuid, int maxResults)` Return a list of similar documents.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SEARCH_LUCENE

public static final String SEARCH_LUCENE

See Also:: Constant Field Values

SEARCH_ACCESS_MANAGER_MORE

public static final String SEARCH_ACCESS_MANAGER_MORE

See Also:: Constant Field Values

SEARCH_ACCESS_MANAGER_WINDOW

public static final String SEARCH_ACCESS_MANAGER_WINDOW

See Also:: Constant Field Values

SEARCH_ACCESS_MANAGER_LIMITED

public static final String SEARCH_ACCESS_MANAGER_LIMITED

See Also:: Constant Field Values

analyzer

public static org.apache.lucene.analysis.Analyzer analyzer

Method Detail

getInstance
```
public static SearchDAO getInstance()
```

findByQuery

public NodeResultSet findByQuery(org.apache.lucene.search.Query query,
                        int offset,
                        int limit)
                          throws ParseException,
                                 DatabaseException

Search by query

Throws:: ParseException; DatabaseException

findBySimpleQuery

public NodeResultSet findBySimpleQuery(String expression,
                              int offset,
                              int limit)
                                throws ParseException,
                                       DatabaseException

Search by simple query

Throws:: ParseException; DatabaseException

findFoldersInDepth

public List<String> findFoldersInDepth(String parentUuid)
                                throws PathNotFoundException,
                                       DatabaseException

Find by parent in depth TODO This cache should be for every user (no pass through access manager) and cleaned after a create, move or copy folder operation.

Throws:: PathNotFoundException; DatabaseException

moreLikeThis

public NodeResultSet moreLikeThis(String uuid,
                         int maxResults)
                           throws DatabaseException,
                                  PathNotFoundException

Return a list of similar documents.

Throws:: DatabaseException; PathNotFoundException

getTerms

public List<String> getTerms(Class<?> entityType,
                    String nodeUuid)
                      throws org.apache.lucene.index.CorruptIndexException,
                             IOException

Get Lucent document terms.

Throws:: org.apache.lucene.index.CorruptIndexException; IOException

Class SearchDAO