org.hibernate.search.elasticsearch.nulls.codec.impl

Class ElasticsearchAsNullNullMarkerCodec

java.lang.Object

org.hibernate.search.elasticsearch.nulls.codec.impl.ElasticsearchAsNullNullMarkerCodec

All Implemented Interfaces:

NullMarkerCodec

Direct Known Subclasses:

ElasticsearchAsNullStringNullMarkerCodec, ElasticsearchBooleanNullMarkerCodec, ElasticsearchDoubleNullMarkerCodec, ElasticsearchFloatNullMarkerCodec, ElasticsearchIntegerNullMarkerCodec, ElasticsearchLongNullMarkerCodec

public abstract class ElasticsearchAsNullNullMarkerCodec
extends Object
implements NullMarkerCodec

A base class for NullMarkerCodecs that index null values as the JSON "null" value.

Author:

Yoann Rodiere

Field Summary

Fields

Modifier and Type	Field and Description
protected NullMarker	nullMarker

Constructor Summary

Constructors

Constructor and Description
ElasticsearchAsNullNullMarkerCodec(NullMarker nullMarker)

Method Summary

Modifier and Type	Method and Description
void	encodeNullValue(String fieldName, Document document, LuceneOptions luceneOptions) Store the null marker in the Document.
NullMarker	getNullMarker()
boolean	representsNullValue(IndexableField field) Check if the field represents the encoding for a null element
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.search.engine.nulls.codec.impl.NullMarkerCodec

createNullMatchingQuery

Field Detail

nullMarker

protected final NullMarker nullMarker

Constructor Detail

ElasticsearchAsNullNullMarkerCodec

public ElasticsearchAsNullNullMarkerCodec(NullMarker nullMarker)

Method Detail

getNullMarker

public NullMarker getNullMarker()

Specified by:

getNullMarker in interface NullMarkerCodec

Returns:

The null marker used by this codec.

encodeNullValue

public void encodeNullValue(String fieldName,
                            Document document,
                            LuceneOptions luceneOptions)

Description copied from interface: NullMarkerCodec

Store the null marker in the Document. Some implementations might not do anything

Specified by:

encodeNullValue in interface NullMarkerCodec

Parameters:

fieldName - the name of the field

document - the document where to store the null marker

luceneOptions - indexing options

representsNullValue

public boolean representsNullValue(IndexableField field)

Description copied from interface: NullMarkerCodec

Check if the field represents the encoding for a null element

Specified by:

representsNullValue in interface NullMarkerCodec

Parameters:

field - the fields to check

Returns:

true if the field argument is representing the encoding for a null element.

toString

public String toString()

Overrides:

toString in class Object