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

java.lang.Object
- org.hibernate.search.backend.lucene.search.common.impl.LuceneDocumentReference

All Implemented Interfaces:: DocumentReference

public class LuceneDocumentReference
extends Object
implements DocumentReference

Constructor Summary

Constructors
Constructor Description

LuceneDocumentReference(String typeName, String id)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object obj)`
`int`	`hashCode()`
`String`	`id()`
`String`	`toString()`
`String`	`typeName()`

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

- Constructor Detail
  - LuceneDocumentReference
```
public LuceneDocumentReference(String typeName,
                               String id)
```
- Method Detail
  - typeName
```
public String typeName()
```
    Specified by:
    
    typeName in interface DocumentReference
    
    Returns:
    
    The name of the type of the referenced document. The type name is mapper-specific. For example, in the Hibernate ORM mapper, it will be the JPA entity name.
  - id
```
public String id()
```
    Specified by:
    
    id in interface DocumentReference
    
    Returns:
    
    The identifier of the referenced document. The identifier is returned as it was generated during document building, i.e. it does not take into account backend-specific transformations such as appending a tenant ID when using multi-tenancy.
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object