BaseEditorSearchIndex (Kie Workbench - Common

java.lang.Object
- org.kie.workbench.common.widgets.client.search.common.BaseEditorSearchIndex<T>

All Implemented Interfaces:: EditorSearchIndex<T>

public abstract class BaseEditorSearchIndex<T extends Searchable>
extends Object
implements EditorSearchIndex<T>

Constructor Summary

Constructors
Constructor and Description

BaseEditorSearchIndex()

Constructors
Constructor and Description
`BaseEditorSearchIndex()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Resets the index state.
`Integer`	`getCurrentAssetHashcode()` This method is used by the `isDirty` logic.
`Optional<T>`	`getCurrentResult()` Returns the current result.
`int`	`getCurrentResultNumber()` Returns the number of the current result.
`protected abstract List<T>`	`getSearchableElements()`
`List<HasSearchableElements<T>>`	`getSubIndexes()` Returns the list of sub-indexes.
`int`	`getTotalOfResultsNumber()` Returns the number of results.
`boolean`	`isDirty()` Check if the index is dirty.
`void`	`nextResult()` Triggers the `onFound` callback for the next result.
`void`	`previousResult()` Triggers the `onFound` callback for the previous result.
`void`	`registerSubIndex(HasSearchableElements<T> hasSearchableElements)` Registers a new sub-index into `EditorSearchIndex`.
`void`	`search(String term)` Searches for any `Searchable` that satisfies the parameter, and triggers the `onFound` callback for the first result.
`void`	`setClearCurrentResultsCallback(org.uberfire.mvp.Command callback)` Sets the callback that will be triggered when the current search results needs to be cleared.
`void`	`setCurrentAssetHashcodeSupplier(Supplier<Integer> currentAssetHashcodeSupplier)`
`void`	`setNoResultsFoundCallback(org.uberfire.mvp.Command callback)` Sets the callback that will be triggered when no result is found.
`void`	`setSearchClosedCallback(org.uberfire.mvp.Command searchClosedCallback)`
`void`	`setSearchPerformedCallback(org.uberfire.mvp.Command searchPerformedCallback)` Sets the callback that will be triggered when search is performed.

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

- Constructor Detail
  - BaseEditorSearchIndex
```
public BaseEditorSearchIndex()
```
- Method Detail
  - setSearchPerformedCallback
```
public void setSearchPerformedCallback(org.uberfire.mvp.Command searchPerformedCallback)
```
    Description copied from interface: EditorSearchIndex
    
    Sets the callback that will be triggered when search is performed.
    
    Specified by:
    
    setSearchPerformedCallback in interface EditorSearchIndex<T extends Searchable>
    
    Parameters:
    
    searchPerformedCallback - the callback that will be triggered
  - getSubIndexes
```
public List<HasSearchableElements<T>> getSubIndexes()
```
    Description copied from interface: EditorSearchIndex
    
    Returns the list of sub-indexes.
    
    Specified by:
    
    getSubIndexes in interface EditorSearchIndex<T extends Searchable>
    
    Returns:
    
    the list of HasSearchableElements.
  - registerSubIndex
```
public void registerSubIndex(HasSearchableElements<T> hasSearchableElements)
```
    Description copied from interface: EditorSearchIndex
    
    Registers a new sub-index into EditorSearchIndex.
    
    Specified by:
    
    registerSubIndex in interface EditorSearchIndex<T extends Searchable>
    
    Parameters:
    
    hasSearchableElements - represents a new index.
  - search
```
public void search(String term)
```
    Description copied from interface: EditorSearchIndex
    
    Searches for any Searchable that satisfies the parameter, and triggers the onFound callback for the first result.
    
    Specified by:
    
    search in interface EditorSearchIndex<T extends Searchable>
    
    Parameters:
    
    term - the string that will trigger the search
  - getCurrentResultNumber
```
public int getCurrentResultNumber()
```
    Description copied from interface: EditorSearchIndex
    
    Returns the number of the current result.
    
    Specified by:
    
    getCurrentResultNumber in interface EditorSearchIndex<T extends Searchable>
    
    Returns:
    
    a int value representing the number of current result.
  - getTotalOfResultsNumber
```
public int getTotalOfResultsNumber()
```
    Description copied from interface: EditorSearchIndex
    
    Returns the number of results.
    
    Specified by:
    
    getTotalOfResultsNumber in interface EditorSearchIndex<T extends Searchable>
    
    Returns:
    
    a int value representing the number of results.
  - close
```
public void close()
```
    Description copied from interface: EditorSearchIndex
    
    Resets the index state. It affects the isDirty, the nextResult, the previousResult, the getCurrentResultNumber, and the getTotalOfResultsNumber method.
    
    Specified by:
    
    close in interface EditorSearchIndex<T extends Searchable>
  - setNoResultsFoundCallback
```
public void setNoResultsFoundCallback(org.uberfire.mvp.Command callback)
```
    Description copied from interface: EditorSearchIndex
    
    Sets the callback that will be triggered when no result is found.
    
    Specified by:
    
    setNoResultsFoundCallback in interface EditorSearchIndex<T extends Searchable>
    
    Parameters:
    
    callback - the callback that will be triggered
  - setClearCurrentResultsCallback
```
public void setClearCurrentResultsCallback(org.uberfire.mvp.Command callback)
```
    Description copied from interface: EditorSearchIndex
    
    Sets the callback that will be triggered when the current search results needs to be cleared.
    
    Specified by:
    
    setClearCurrentResultsCallback in interface EditorSearchIndex<T extends Searchable>
    
    Parameters:
    
    callback - the callback that will be triggered
  - setSearchClosedCallback
```
public void setSearchClosedCallback(org.uberfire.mvp.Command searchClosedCallback)
```
    Specified by:
    
    setSearchClosedCallback in interface EditorSearchIndex<T extends Searchable>
  - isDirty
```
public boolean isDirty()
```
    Description copied from interface: EditorSearchIndex
    
    Check if the index is dirty.
    
    Specified by:
    
    isDirty in interface EditorSearchIndex<T extends Searchable>
    
    Returns:
    
    true if the index is dirty.
  - nextResult
```
public void nextResult()
```
    Description copied from interface: EditorSearchIndex
    
    Triggers the onFound callback for the next result.
    
    Specified by:
    
    nextResult in interface EditorSearchIndex<T extends Searchable>
  - previousResult
```
public void previousResult()
```
    Description copied from interface: EditorSearchIndex
    
    Triggers the onFound callback for the previous result.
    
    Specified by:
    
    previousResult in interface EditorSearchIndex<T extends Searchable>
  - getCurrentAssetHashcode
```
public Integer getCurrentAssetHashcode()
```
    Description copied from interface: EditorSearchIndex
    
    This method is used by the isDirty logic.
    
    Specified by:
    
    getCurrentAssetHashcode in interface EditorSearchIndex<T extends Searchable>
    
    Returns:
    
    the asset hashcode.
  - setCurrentAssetHashcodeSupplier
```
public void setCurrentAssetHashcodeSupplier(Supplier<Integer> currentAssetHashcodeSupplier)
```
  - getCurrentResult
```
public Optional<T> getCurrentResult()
```
    Description copied from interface: EditorSearchIndex
    
    Returns the current result.
    
    Specified by:
    
    getCurrentResult in interface EditorSearchIndex<T extends Searchable>
    
    Returns:
    
    The current result.
  - getSearchableElements
```
protected abstract List<T> getSearchableElements()
```

Class BaseEditorSearchIndex<T extends Searchable>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BaseEditorSearchIndex

Method Detail

setSearchPerformedCallback

getSubIndexes

registerSubIndex

search

getCurrentResultNumber

getTotalOfResultsNumber

close

setNoResultsFoundCallback

setClearCurrentResultsCallback

setSearchClosedCallback

isDirty

nextResult

previousResult

getCurrentAssetHashcode

setCurrentAssetHashcodeSupplier

getCurrentResult

getSearchableElements