SearchIndexBuilderWorker (sakai-search-api 12.6 API)

public interface SearchIndexBuilderWorker

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`checkRunning()` Check running, and ping the thread if in a wait state
`void`	`destroy()` destroy the search index builder worker and release all resources
`String`	`getCurrentDocument()`
`String`	`getCurrentElapsed()`
`String`	`getLastDocument()`
`String`	`getLastElapsed()`
`long`	`getLastEventTime()` Get the ms time of the last search add/remove event (excluding master events)
`long`	`getLastIndex()`
`boolean`	`getLockTransaction(long lifetime)`
`boolean`	`getLockTransaction(long nodeLifetime, boolean forceLock)`
`String`	`getNowIndexing()`
`long`	`getStartDocIndex()`
`boolean`	`isLocalLock()`
`boolean`	`isRunning()` Should the thread be running
`boolean`	`removeWorkerLock()` forge the removal of the worker lock
`void`	`setLastIndex(long l)`
`void`	`setNowIndexing(String reference)`
`void`	`setStartDocIndex(long startDocIndex)`
`void`	`updateNodeLock(long l)`

- Method Detail
  - checkRunning
```
void checkRunning()
```
    Check running, and ping the thread if in a wait state
  - isRunning
```
boolean isRunning()
```
    Should the thread be running
  - destroy
```
void destroy()
```
    destroy the search index builder worker and release all resources
  - removeWorkerLock
```
boolean removeWorkerLock()
```
    forge the removal of the worker lock
    
    Returns:
  - getLastEventTime
```
long getLastEventTime()
```
    Get the ms time of the last search add/remove event (excluding master events)
    
    Returns:
  - getLockTransaction
```
boolean getLockTransaction(long lifetime)
```
    Parameters:
    
    lifetime -
    
    Returns:
  - getLockTransaction
```
boolean getLockTransaction(long nodeLifetime,
                           boolean forceLock)
```
    Parameters:
    
    nodeLifetime -
    
    forceLock - force the lock to be taken even if there are no items in the queue
    
    Returns:
  - updateNodeLock
```
void updateNodeLock(long l)
             throws SQLException
```
    Parameters:
    
    l -
    
    Throws:
    
    SQLException
  - setLastIndex
```
void setLastIndex(long l)
```
    Parameters:
    
    l -
  - setStartDocIndex
```
void setStartDocIndex(long startDocIndex)
```
    Parameters:
    
    startDocIndex -
  - setNowIndexing
```
void setNowIndexing(String reference)
```
    Parameters:
    
    reference -
  - getLastIndex
```
long getLastIndex()
```
    Returns:
  - getNowIndexing
```
String getNowIndexing()
```
    Returns:
  - getStartDocIndex
```
long getStartDocIndex()
```
    Returns:
  - getLastDocument
```
String getLastDocument()
```
  - getLastElapsed
```
String getLastElapsed()
```
  - getCurrentDocument
```
String getCurrentDocument()
```
  - getCurrentElapsed
```
String getCurrentElapsed()
```
  - isLocalLock
```
boolean isLocalLock()
```
    Returns:

Interface SearchIndexBuilderWorker

Method Summary

Method Detail

checkRunning

isRunning

destroy

removeWorkerLock

getLastEventTime

getLockTransaction

getLockTransaction

updateNodeLock

setLastIndex

setStartDocIndex

setNowIndexing

getLastIndex

getNowIndexing

getStartDocIndex

getLastDocument

getLastElapsed

getCurrentDocument

getCurrentElapsed

isLocalLock