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

java.lang.Object
- org.hibernate.search.backend.lucene.document.impl.LuceneModernIdReaderWriter

All Implemented Interfaces:: LuceneIdReader, LuceneIdReaderWriter, LuceneIdWriter

public final class LuceneModernIdReaderWriter
extends Object
implements LuceneIdReaderWriter

Field Summary

Fields
Modifier and Type Field Description

static LuceneIdReaderWriter INSTANCE

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`org.apache.lucene.index.BinaryDocValues`	`idDocValues(org.apache.lucene.index.LeafReader reader)`	Creates a `BinaryDocValues` backed up by a specific field depending on a configured ID read/write strategy.
`void`	`write(String id, org.apache.lucene.document.Document document)`	Writes an ID to the document.

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

- Field Detail
  - INSTANCE
```
public static final LuceneIdReaderWriter INSTANCE
```
- Method Detail
  - idDocValues
```
public org.apache.lucene.index.BinaryDocValues idDocValues(org.apache.lucene.index.LeafReader reader)
                                                    throws IOException
```
    Description copied from interface: LuceneIdReader
    
    Creates a BinaryDocValues backed up by a specific field depending on a configured ID read/write strategy.
    
    Specified by:
    
    idDocValues in interface LuceneIdReader
    
    Parameters:
    
    reader - The reader to retrieve IDs from.
    
    Returns:
    
    Returns BinaryDocValues for the ID field.
    
    Throws:
    
    IOException - On I/O error occurred while creating doc values.
    
    See Also:
    
    LuceneBackendSettings.SCHEMA_ID_STRATEGY
  - write
```
public void write(String id,
                  org.apache.lucene.document.Document document)
```
    Description copied from interface: LuceneIdWriter
    
    Writes an ID to the document. Implementations chose which filed name to use and how many fields are used to represent the ID.
    
    Specified by:
    
    write in interface LuceneIdWriter
    
    Parameters:
    
    id - The id to add to the document.
    
    document - The document to write to.
    
    See Also:
    
    LuceneBackendSettings.SCHEMA_ID_STRATEGY