org.hibernate.search.bridge.builtin

Class StringEncodingCalendarBridge

java.lang.Object

org.hibernate.search.bridge.builtin.StringEncodingDateBridge

org.hibernate.search.bridge.builtin.StringEncodingCalendarBridge

All Implemented Interfaces:

FieldBridge, ParameterizedBridge, TwoWayFieldBridge

public class StringEncodingCalendarBridge
extends StringEncodingDateBridge

Bridge a java.util.Calendar to a String, truncated to the specified resolution.

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

Author:

Davide D'Alto

Field Summary

Fields

Modifier and Type	Field and Description
static TwoWayFieldBridge	CALENDAR_DAY
static TwoWayFieldBridge	CALENDAR_HOUR
static TwoWayFieldBridge	CALENDAR_MILLISECOND
static TwoWayFieldBridge	CALENDAR_MINUTE
static TwoWayFieldBridge	CALENDAR_MONTH
static TwoWayFieldBridge	CALENDAR_SECOND
static TwoWayFieldBridge	CALENDAR_YEAR

Fields inherited from class org.hibernate.search.bridge.builtin.StringEncodingDateBridge

DATE_DAY, DATE_HOUR, DATE_MILLISECOND, DATE_MINUTE, DATE_MONTH, DATE_SECOND, DATE_YEAR

Constructor Summary

Constructors

Constructor and Description
StringEncodingCalendarBridge()
StringEncodingCalendarBridge(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
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.

Methods inherited from class org.hibernate.search.bridge.builtin.StringEncodingDateBridge

setParameterValues

Methods inherited from class java.lang.Object

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

Field Detail

CALENDAR_YEAR

public static final TwoWayFieldBridge CALENDAR_YEAR

CALENDAR_MONTH

public static final TwoWayFieldBridge CALENDAR_MONTH

CALENDAR_DAY

public static final TwoWayFieldBridge CALENDAR_DAY

CALENDAR_HOUR

public static final TwoWayFieldBridge CALENDAR_HOUR

CALENDAR_MINUTE

public static final TwoWayFieldBridge CALENDAR_MINUTE

CALENDAR_SECOND

public static final TwoWayFieldBridge CALENDAR_SECOND

CALENDAR_MILLISECOND

public static final TwoWayFieldBridge CALENDAR_MILLISECOND

Constructor Detail

StringEncodingCalendarBridge

public StringEncodingCalendarBridge()

StringEncodingCalendarBridge

public StringEncodingCalendarBridge(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

Overrides:

get in class StringEncodingDateBridge

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

Overrides:

objectToString in class StringEncodingDateBridge

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

Overrides:

set in class StringEncodingDateBridge

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.