IndexingServiceConnector (eXo PLF:: Commons - Commons Search 6.2.0-RC06 API)

java.lang.Object
- org.exoplatform.container.component.BaseComponentPlugin
- - org.exoplatform.commons.search.index.IndexingServiceConnector

All Implemented Interfaces:

org.exoplatform.container.component.ComponentPlugin

Direct Known Subclasses:

ElasticIndexingServiceConnector
```
public abstract class IndexingServiceConnector
extends org.exoplatform.container.component.BaseComponentPlugin
```
Created by The eXo Platform SAS Author : Thibault Clement tclement@exoplatform.com 7/22/15

Field Summary

Fields
Modifier and Type Field Description

protected String connectorName

protected boolean enable
- Fields inherited from class org.exoplatform.container.component.BaseComponentPlugin
  desc, name

Constructor Summary

Constructors
Constructor Description

IndexingServiceConnector()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract Document`	`create(String id)`	Transform an entity to Document in order to be indexed
`abstract String`	`delete(String id)`	Transform a list of entities to Document in order to be deleted from create
`abstract List<String>`	`getAllIds(int offset, int limit)`
`abstract String`	`getConnectorName()`
`boolean`	`isEnable()`
`void`	`setEnable(boolean enable)`
`abstract Document`	`update(String id)`	Transform an entity to Document in order to be reindexed

Methods inherited from class org.exoplatform.container.component.BaseComponentPlugin
getDescription, getName, setDescription, setName

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

- Field Detail
  - connectorName
```
protected String connectorName
```
  - enable
```
protected boolean enable
```
- Constructor Detail
  - IndexingServiceConnector
```
public IndexingServiceConnector()
```
- Method Detail
  - create
```
public abstract Document create(String id)
```
    Transform an entity to Document in order to be indexed
    
    Parameters:
    
    id - Id of entity to create
    
    Returns:
    
    List of Document to create
    
    eXo level API
    
    Experimental
  - update
```
public abstract Document update(String id)
```
    Transform an entity to Document in order to be reindexed
    
    Parameters:
    
    id - Id of entity to reindex
    
    Returns:
    
    List of Document to reindex
    
    eXo level API
    
    Experimental
  - delete
```
public abstract String delete(String id)
```
    Transform a list of entities to Document in order to be deleted from create
    
    Parameters:
    
    id - Ids of entities to delete from
    
    Returns:
    
    List of Ids to delete from create
    
    eXo level API
    
    Experimental
  - getAllIds
```
public abstract List<String> getAllIds(int offset,
                                       int limit)
```
  - getConnectorName
```
public abstract String getConnectorName()
```
  - isEnable
```
public boolean isEnable()
```
  - setEnable
```
public void setEnable(boolean enable)
```