org.hibernate.search.bridge.spi

Interface NullMarker

All Known Implementing Classes:

ElasticsearchNullMarkerField, ToStringNullMarker

public interface NullMarker

Representation of a missing value.

When encoding a marker the index field type shall match the other fields', as field types often need to be consistent across the whole index.

Author:

Sanne Grinovero

Experimental

This contract is currently under active development and may be altered in future releases, breaking existing users.

Method Summary

Modifier and Type	Method and Description
Object	nullEncoded() This returns the actual value to be indexed in place of null.
String	nullRepresentedAsString() This is mostly a requirement for integration with other old-style contracts which expect a strongly String based strategy.

Method Detail

nullRepresentedAsString

String nullRepresentedAsString()

This is mostly a requirement for integration with other old-style contracts which expect a strongly String based strategy.

Returns:

a string representation of the null-marker, or null if no marker is used.

nullEncoded

Object nullEncoded()

This returns the actual value to be indexed in place of null.

The returned value may be:

• A String, for text fields.
• A Number, for numeric fields.

Returns:

a representation of the null-marker ready to be indexed.