Package com.simplicite.util.tools
Interface IndexTool
-
- All Known Implementing Classes:
IndexSQLTool
public interface IndexTool
Indexation interface
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
INDEX_LAST_SCAN
System param to store last scan date of objectsstatic java.lang.String
ORIGIN
Origin date for full rebuildsstatic java.lang.String
TYPE_LUCENE
Deprecated.Indexation with Apache Lucenestatic java.lang.String
TYPE_SQL
Indexation with SQLstatic java.lang.String
USE_FULLTEXT_INDEXES
System parameter to enable the fulltext indexationstatic java.lang.String
USE_SEARCH_INDEX
System parameter to activate the indexationstatic java.lang.String
USE_UNACCENTUATED_INDEX
System parameter to enable the unaccentuated indexation
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
delete(java.lang.String object, java.lang.String row_id)
Delete object indexvoid
indexation(ObjectDB obj)
Single object indexationlong
indexation(ObjectDB index, Grant g, boolean reset)
Bulk indexation of every indexed fields (take several minutes/hours for huge model)long
indexObject(java.lang.String objectName, java.lang.String fromDate, java.lang.String toDate)
Bulk indexation of single objectSearchResult
search(Grant g, java.lang.String query, int pageNum, int pageSize)
Global search (any object)SearchResult
search(Grant g, java.lang.String object, java.lang.String input, java.lang.String query, int pageNum, int pageSize, java.lang.String context, org.json.JSONObject values)
Field search (useful for field completion)SearchResult
search(Grant g, java.util.List<java.lang.String> objects, java.lang.String query, int pageNum, int pageSize)
Object search (listed objects)SearchResult
searchDoc(Grant g, java.lang.String query, java.util.List<java.lang.String> bookshelfs, java.util.Map<java.lang.String,java.lang.String> filter, int max)
Global document search
-
-
-
Field Detail
-
INDEX_LAST_SCAN
static final java.lang.String INDEX_LAST_SCAN
System param to store last scan date of objects- See Also:
- Constant Field Values
-
ORIGIN
static final java.lang.String ORIGIN
Origin date for full rebuilds- See Also:
- Constant Field Values
-
USE_SEARCH_INDEX
static final java.lang.String USE_SEARCH_INDEX
System parameter to activate the indexation- See Also:
- Constant Field Values
-
USE_FULLTEXT_INDEXES
static final java.lang.String USE_FULLTEXT_INDEXES
System parameter to enable the fulltext indexation- See Also:
- Constant Field Values
-
USE_UNACCENTUATED_INDEX
static final java.lang.String USE_UNACCENTUATED_INDEX
System parameter to enable the unaccentuated indexation- See Also:
- Constant Field Values
-
TYPE_LUCENE
@Deprecated(forRemoval=false, since="3.x") static final java.lang.String TYPE_LUCENE
Deprecated.Indexation with Apache Lucene- See Also:
- Constant Field Values
-
TYPE_SQL
static final java.lang.String TYPE_SQL
Indexation with SQL- See Also:
- Constant Field Values
-
-
Method Detail
-
delete
void delete(java.lang.String object, java.lang.String row_id) throws java.lang.Exception
Delete object index- Parameters:
object
- Object namerow_id
- Record id- Throws:
java.lang.Exception
-
indexation
long indexation(ObjectDB index, Grant g, boolean reset) throws java.lang.Exception
Bulk indexation of every indexed fields (take several minutes/hours for huge model)- Parameters:
index
- Index objectg
- User rightsreset
- true to rebuild all, false to replace/append to the existing index- Returns:
- index size
- Throws:
java.lang.Exception
-
indexObject
long indexObject(java.lang.String objectName, java.lang.String fromDate, java.lang.String toDate) throws java.lang.InterruptedException
Bulk indexation of single object- Parameters:
objectName
- Object to indexfromDate
- Optional start datetoDate
- Optional end date- Returns:
- index size
- Throws:
java.lang.InterruptedException
-
indexation
void indexation(ObjectDB obj) throws java.lang.Exception
Single object indexation- Parameters:
obj
- Business object (row_id must be selected)- Throws:
java.lang.Exception
-
search
SearchResult search(Grant g, java.lang.String object, java.lang.String input, java.lang.String query, int pageNum, int pageSize, java.lang.String context, org.json.JSONObject values) throws java.lang.Exception
Field search (useful for field completion)- Parameters:
g
- User rightsobject
- Object nameinput
- Field input namequery
- Search querypageNum
- Page number (0 = first page)pageSize
- Page sizecontext
- search, list or formvalues
- optional fields values from UI- Returns:
- List of (score, value)
- Throws:
java.lang.Exception
-
search
SearchResult search(Grant g, java.util.List<java.lang.String> objects, java.lang.String query, int pageNum, int pageSize) throws java.lang.Exception
Object search (listed objects)- Parameters:
g
- User rightsobjects
- Object namesquery
- Search querypageNum
- Page number (0 = first page)pageSize
- Page size- Returns:
- List of (score, row_id, ukey)
- Throws:
java.lang.Exception
-
search
SearchResult search(Grant g, java.lang.String query, int pageNum, int pageSize) throws java.lang.Exception
Global search (any object)- Parameters:
g
- User rightsquery
- Search querypageNum
- Page number (0 = first page)pageSize
- Page size- Returns:
- List of (score, object, row_id, ukey, all)
- Throws:
java.lang.Exception
-
searchDoc
SearchResult searchDoc(Grant g, java.lang.String query, java.util.List<java.lang.String> bookshelfs, java.util.Map<java.lang.String,java.lang.String> filter, int max) throws java.lang.Exception
Global document search- Parameters:
g
- User rightsquery
- Search querymax
- Max rows- Returns:
- List of (docId, path, score)
- Throws:
java.lang.Exception
-
-