org.hibernate.search.engine.impl.nullencoding

Class KeywordBasedNullCodec

java.lang.Object

org.hibernate.search.engine.impl.nullencoding.KeywordBasedNullCodec

All Implemented Interfaces:

NullMarkerCodec

public class KeywordBasedNullCodec
extends Object
implements NullMarkerCodec

Author:

Sanne Grinovero

Constructor Summary

Constructors

Constructor and Description
KeywordBasedNullCodec(String indexNullAs)

Method Summary

Modifier and Type	Method and Description
org.apache.lucene.search.Query	createNullMatchingQuery(String fieldName) Create a Query to find all documents which have a 'null' value encoded in the specified field
void	encodeNullValue(String name, org.apache.lucene.document.Document document, LuceneOptions luceneOptions) Store the null marker in the Document.
String	nullRepresentedAsString() This is mostly a requirement for integration with other old-style contracts which expect a strongly String based strategy.
boolean	representsNullValue(org.apache.lucene.index.IndexableField field) Check if the field represents the encoding for a null element

Methods inherited from class java.lang.Object

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

Constructor Detail

KeywordBasedNullCodec

public KeywordBasedNullCodec(String indexNullAs)

Method Detail

nullRepresentedAsString

public String nullRepresentedAsString()

Description copied from interface: NullMarkerCodec

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

Specified by:

nullRepresentedAsString in interface NullMarkerCodec

Returns:

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

encodeNullValue

public void encodeNullValue(String name,
                            org.apache.lucene.document.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:

name - the name of the field

document - the document where to store the null marker

luceneOptions - indexing options

createNullMatchingQuery

public org.apache.lucene.search.Query createNullMatchingQuery(String fieldName)

Description copied from interface: NullMarkerCodec

Create a Query to find all documents which have a 'null' value encoded in the specified field

Specified by:

createNullMatchingQuery in interface NullMarkerCodec

Parameters:

fieldName - the field to target with the Query

Returns:

a new Lucene Query

representsNullValue

public boolean representsNullValue(org.apache.lucene.index.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.