org.hibernate.search.elasticsearch.bridge.builtin.impl

Class ElasticsearchDateBridge

java.lang.Object

org.hibernate.search.bridge.util.impl.EncodingStringBridge<Date>

org.hibernate.search.elasticsearch.bridge.builtin.impl.ElasticsearchDateBridge

All Implemented Interfaces:

FieldBridge, ParameterizedBridge, EncodingBridge, IgnoreAnalyzerBridge, StringBridge, TwoWayFieldBridge

public class ElasticsearchDateBridge
extends EncodingStringBridge<Date>
implements TwoWayFieldBridge, ParameterizedBridge, IgnoreAnalyzerBridge

Bridge a java.util.Date to a String using the ISO 8601 standard which is the default date format of Elasticsearch. UTC is used as time zone. Typically, a java.util.Date will be converted to "2016-04-28T15:24:25Z".

Author:

Guillaume Smet

Field Summary

Fields

Modifier and Type	Field and Description
static ElasticsearchDateBridge	DATE_DAY
static ElasticsearchDateBridge	DATE_HOUR
static ElasticsearchDateBridge	DATE_MILLISECOND
static ElasticsearchDateBridge	DATE_MINUTE
static ElasticsearchDateBridge	DATE_MONTH
static ElasticsearchDateBridge	DATE_SECOND
static ElasticsearchDateBridge	DATE_YEAR

Constructor Summary

Constructors

Constructor and Description
ElasticsearchDateBridge()
ElasticsearchDateBridge(Resolution resolution)

Method Summary

Modifier and Type	Method and Description
Object	get(String name, Document document) Build the element object from the Document
String	objectToString(Object object) Convert the object representation to a string.
protected Date	parseIndexNullAs(String indexNullAs) Parse the 'indexNullAs' string to an indexable value.
void	set(String name, Object value, Document document, LuceneOptions luceneOptions) Manipulate the document to index the given value.
void	setParameterValues(Map<String,String> parameters) Called on the bridge implementation to pass the parameters.

Methods inherited from class org.hibernate.search.bridge.util.impl.EncodingStringBridge

createNullMarker, getEncodingType

Methods inherited from class java.lang.Object

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

Field Detail

DATE_YEAR

public static final ElasticsearchDateBridge DATE_YEAR

DATE_MONTH

public static final ElasticsearchDateBridge DATE_MONTH

DATE_DAY

public static final ElasticsearchDateBridge DATE_DAY

DATE_HOUR

public static final ElasticsearchDateBridge DATE_HOUR

DATE_MINUTE

public static final ElasticsearchDateBridge DATE_MINUTE

DATE_SECOND

public static final ElasticsearchDateBridge DATE_SECOND

DATE_MILLISECOND

public static final ElasticsearchDateBridge DATE_MILLISECOND

Constructor Detail

ElasticsearchDateBridge

public ElasticsearchDateBridge()

ElasticsearchDateBridge

public ElasticsearchDateBridge(Resolution resolution)

Method Detail

set

public void set(String name,
                Object value,
                Document document,
                LuceneOptions luceneOptions)

Description copied from interface: FieldBridge

Manipulate the document to index the given value.

A common implementation is to add a Field with the given name to document following the parameters luceneOptions if the value is not null.

 
 String fieldValue = convertToString(value);
 luceneOptions.addFieldToDocument(name, fieldValue, document);
 
 

Specified by:

set in interface FieldBridge

Parameters:

name - The field to add to the Lucene document

value - The actual value to index

document - The Lucene document into which we want to index the value.

luceneOptions - Contains the parameters used for adding value to the Lucene document.

get

public Object get(String name,
                  Document document)

Description copied from interface: TwoWayFieldBridge

Build the element object from the Document

Specified by:

get in interface TwoWayFieldBridge

Parameters:

name - field name

document - document

Returns:

The return value is the entity property value.

objectToString

public String objectToString(Object object)

Description copied from interface: TwoWayFieldBridge

Convert the object representation to a string.

Specified by:

objectToString in interface StringBridge

Specified by:

objectToString in interface TwoWayFieldBridge

Parameters:

object - The object to index.

Returns:

string (index) representation of the specified object. Must not be null, but can be empty.

setParameterValues

public void setParameterValues(Map<String,String> parameters)

Description copied from interface: ParameterizedBridge

Called on the bridge implementation to pass the parameters.

Specified by:

setParameterValues in interface ParameterizedBridge

Parameters:

parameters - map containing string based parameters to be passed to the parameterized bridge. The map is never null.

parseIndexNullAs

protected Date parseIndexNullAs(String indexNullAs)
                         throws IllegalArgumentException

Description copied from class: EncodingStringBridge

Parse the 'indexNullAs' string to an indexable value.

The required format does not have to be the same as the encoded format.

Specified by:

parseIndexNullAs in class EncodingStringBridge<Date>

Throws:

IllegalArgumentException - If the given string does not match the required format.