org.hibernate.search.bridge.util.impl

Class String2FieldBridgeAdaptor

java.lang.Object

org.hibernate.search.bridge.util.impl.String2FieldBridgeAdaptor

All Implemented Interfaces:

AppliedOnTypeAwareBridge, FieldBridge, StringBridge, BridgeAdaptor

Direct Known Subclasses:

TwoWayString2FieldBridgeAdaptor

public class String2FieldBridgeAdaptor
extends Object
implements FieldBridge, StringBridge, AppliedOnTypeAwareBridge, BridgeAdaptor

Bridge to use a StringBridge as a FieldBridge.

Author:

Emmanuel Bernard (C) 2011 Red Hat Inc., Sanne Grinovero (C) 2011 Red Hat Inc.

Constructor Summary

Constructors

Constructor and Description
String2FieldBridgeAdaptor(StringBridge stringBridge)

Method Summary

Modifier and Type	Method and Description
String	objectToString(Object object) Converts 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	setAppliedOnType(Class<?> returnType) Set the return type of the bridge (the type of the field linked to the bridge).
String	toString()
<T> T	unwrap(Class<T> bridgeClass) Return an object of the specified type to allow access to specific bridge interfaces.

Methods inherited from class java.lang.Object

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

Constructor Detail

String2FieldBridgeAdaptor

public String2FieldBridgeAdaptor(StringBridge stringBridge)

Method Detail

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.

objectToString

public String objectToString(Object object)

Description copied from interface: StringBridge

Converts the object representation to a string.

Specified by:

objectToString in interface StringBridge

Parameters:

object - The object to transform into a string representation.

Returns:

String representation of the given object to be stored in Lucene index. The return string must not be null. It can be empty though.

toString

public String toString()

Overrides:

toString in class Object

setAppliedOnType

public void setAppliedOnType(Class<?> returnType)

Description copied from interface: AppliedOnTypeAwareBridge

Set the return type of the bridge (the type of the field linked to the bridge).

Specified by:

setAppliedOnType in interface AppliedOnTypeAwareBridge

Parameters:

returnType - return type

unwrap

public <T> T unwrap(Class<T> bridgeClass)

Description copied from interface: BridgeAdaptor

Return an object of the specified type to allow access to specific bridge interfaces.

If no adapted bridge matches this type, null is returned.

Specified by:

unwrap in interface BridgeAdaptor

Returns:

An instance of the specified class, or null if there is none.