org.hibernate.search.bridge.builtin

Class NumericEncodingDateBridge

java.lang.Object

org.hibernate.search.bridge.builtin.NumericEncodingDateBridge

All Implemented Interfaces:

FieldBridge, ParameterizedBridge, TwoWayFieldBridge

Direct Known Subclasses:

NumericEncodingCalendarBridge

public class NumericEncodingDateBridge
extends Object
implements TwoWayFieldBridge, ParameterizedBridge

Bridge a java.util.Date truncated to the specified resolution to a numerically indexed long. GMT is used as time zone.

• Resolution.YEAR: yyyy
• Resolution.MONTH: yyyyMM
• Resolution.DAY: yyyyMMdd
• Resolution.HOUR: yyyyMMddHH
• Resolution.MINUTE: yyyyMMddHHmm
• Resolution.SECOND: yyyyMMddHHmmss
• Resolution.MILLISECOND: yyyyMMddHHmmssSSS

Author:

Emmanuel Bernard, Hardy Ferentschik

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
NumericEncodingDateBridge()
NumericEncodingDateBridge(Resolution resolution)

Method Summary

Methods

Modifier and Type	Method and Description
Object	get(String name, org.apache.lucene.document.Document document) Build the element object from the Document
org.apache.lucene.document.DateTools.Resolution	getResolution()
String	objectToString(Object object) Convert the object representation to a string.
void	set(String name, Object value, org.apache.lucene.document.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 java.lang.Object

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

Field Detail

DATE_YEAR

public static final TwoWayFieldBridge DATE_YEAR

DATE_MONTH

public static final TwoWayFieldBridge DATE_MONTH

DATE_DAY

public static final TwoWayFieldBridge DATE_DAY

DATE_HOUR

public static final TwoWayFieldBridge DATE_HOUR

DATE_MINUTE

public static final TwoWayFieldBridge DATE_MINUTE

DATE_SECOND

public static final TwoWayFieldBridge DATE_SECOND

DATE_MILLISECOND

public static final TwoWayFieldBridge DATE_MILLISECOND

Constructor Detail

NumericEncodingDateBridge

public NumericEncodingDateBridge()

NumericEncodingDateBridge

public NumericEncodingDateBridge(Resolution resolution)

Method Detail

get

public Object get(String name,
         org.apache.lucene.document.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 TwoWayFieldBridge

Parameters:

object - The object to index.

Returns:

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

set

public void set(String name,
       Object value,
       org.apache.lucene.document.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.

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.

getResolution

public org.apache.lucene.document.DateTools.Resolution getResolution()