org.hibernate.search.engine.backend.document

Interface DocumentElement

All Known Implementing Classes:

NoOpDocumentElement

public interface DocumentElement

An element of a document.

Instances may represent the document root as well as a partial view of the document, for instance a view on a specific "object" field nested inside the document.

Author:

Yoann Rodiere

Method Summary

Modifier and Type	Method and Description
void	addNullObject(IndexObjectFieldReference fieldReference) Add a null object to the referenced field in this document element.
DocumentElement	addObject(IndexObjectFieldReference fieldReference) Add a new object to the referenced field in this document element.
<F> void	addValue(IndexFieldReference<F> fieldReference, F value) Add a new value to the referenced field in this document element.

Method Detail

addValue

<F> void addValue(IndexFieldReference<F> fieldReference,
                  F value)

Add a new value to the referenced field in this document element.

This method can be called multiple times for the same field, which will result in multiple values being added to the same field.

Type Parameters:

F - The type of values for the given field.

Parameters:

fieldReference - The field to add a value to.

value - The value to add to the field.

addObject

DocumentElement addObject(IndexObjectFieldReference fieldReference)

Add a new object to the referenced field in this document element.

Parameters:

fieldReference - The object field to add an object to.

Returns:

The new object, that can be populated with its own fields.

addNullObject

void addNullObject(IndexObjectFieldReference fieldReference)

Add a null object to the referenced field in this document element.

The null object may have a representation in the backend (such as a JSON null), or it may be ignored completely, depending on the backend implementation.

Parameters:

fieldReference - The object field to add a null object to.