AbstractSingleDocumentIndexingWork (Red Hat JBoss Enterprise Application Platform 8.0.0.GA public API)

java.lang.Object
- org.hibernate.search.backend.lucene.work.impl.AbstractIndexingWork<Long>
- - org.hibernate.search.backend.lucene.work.impl.AbstractSingleDocumentIndexingWork

All Implemented Interfaces:

IndexingWork<Long>, SingleDocumentIndexingWork

Direct Known Subclasses:

AddEntryWork, DeleteEntryWork, UpdateEntryWork
```
public abstract class AbstractSingleDocumentIndexingWork
extends AbstractIndexingWork<Long>
implements SingleDocumentIndexingWork
```

Field Summary

Fields
Modifier and Type Field Description

protected String documentIdentifier

protected Object entityIdentifier

protected String entityTypeName

protected String tenantId
- Fields inherited from class org.hibernate.search.backend.lucene.work.impl.AbstractIndexingWork
  workType

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Object`	`getEntityIdentifier()`
`String`	`getEntityTypeName()`
`String`	`getQueuingKey()`
`String`	`toString()`

Methods inherited from class org.hibernate.search.backend.lucene.work.impl.AbstractIndexingWork
getInfo

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

Methods inherited from interface org.hibernate.search.backend.lucene.work.impl.IndexingWork
execute, getInfo

- Field Detail
  - tenantId
```
protected final String tenantId
```
  - entityTypeName
```
protected final String entityTypeName
```
  - entityIdentifier
```
protected final Object entityIdentifier
```
  - documentIdentifier
```
protected final String documentIdentifier
```
- Method Detail
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getEntityTypeName
```
public String getEntityTypeName()
```
    Specified by:
    
    getEntityTypeName in interface SingleDocumentIndexingWork
  - getEntityIdentifier
```
public Object getEntityIdentifier()
```
    Specified by:
    
    getEntityIdentifier in interface SingleDocumentIndexingWork
  - getQueuingKey
```
public String getQueuingKey()
```
    Specified by:
    
    getQueuingKey in interface IndexingWork<Long>
    
    Returns:
    
    A string that will be used to route the work to a specific queue. Never null. Works that must be executed in the same relative order they were submitted in (i.e. works pertaining to the same document) should return the same string.