Package org.hibernate.search.engine.backend.document.spi

Class NoOpDocumentElement

java.lang.Object

org.hibernate.search.engine.backend.document.spi.NoOpDocumentElement

All Implemented Interfaces:

DocumentElement

public class NoOpDocumentElement
extends Object
implements DocumentElement

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

get

public static NoOpDocumentElement get()

addValue

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

Description copied from interface: DocumentElement

Add a new value to a 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.

Specified by:

addValue in interface DocumentElement

Type Parameters:

F - The type of values for the given field.

Parameters:

fieldReference - A reference to the field to add a value to. References are returned by IndexSchemaFieldFinalStep.toReference() in the field definition DSL.

value - The value to add to the field.

addObject

public DocumentElement addObject(IndexObjectFieldReference fieldReference)

Description copied from interface: DocumentElement

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

Specified by:

addObject in interface DocumentElement

Parameters:

fieldReference - A reference to the object field to add an object to. References are returned by IndexSchemaFieldFinalStep.toReference() in the field definition DSL.

Returns:

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

addNullObject

public void addNullObject(IndexObjectFieldReference fieldReference)

Description copied from interface: DocumentElement

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.

Specified by:

addNullObject in interface DocumentElement

Parameters:

fieldReference - A reference to the object field to add a null object to. References are returned by IndexSchemaFieldFinalStep.toReference() in the field definition DSL.

addValue

public void addValue(String relativeFieldName,
 Object value)

Description copied from interface: DocumentElement

Add a new value to a 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.

Specified by:

addValue in interface DocumentElement

Parameters:

relativeFieldName - The name of the field to add a value to, relative to this document element. The field must have been defined previously, either directly through IndexSchemaElement.field(String, Function), or indirectly through IndexSchemaElement.fieldTemplate(String, Function).

value - The value to add to the field.

addObject

public DocumentElement addObject(String relativeFieldName)

Description copied from interface: DocumentElement

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

Specified by:

addObject in interface DocumentElement

Parameters:

relativeFieldName - The name of the object field to add a value to, relative to this document element. The field must have been defined previously, either directly through IndexSchemaElement.objectField(String, ObjectStructure), or indirectly through IndexSchemaElement.objectFieldTemplate(String, ObjectStructure).

Returns:

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

addNullObject

public void addNullObject(String relativeFieldName)

Description copied from interface: DocumentElement

Add a null object to a 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.

Specified by:

addNullObject in interface DocumentElement

Parameters:

relativeFieldName - The name of the object field to add a value to, relative to this document element. The field must have been defined previously, either directly through IndexSchemaElement.objectField(String, ObjectStructure), or indirectly through IndexSchemaElement.objectFieldTemplate(String, ObjectStructure).