com.atlassian.bonnie.index
Interface ObjectToDocumentConverter

public interface ObjectToDocumentConverter

Converts objects to Documents. Implementations must be thread-safe.

Method Summary

org.apache.lucene.document.Document	convert(java.lang.Object o, java.lang.Object context) Converts objects to Documents.
java.lang.String[]	getObjectIdentity(java.lang.Object o) Given an object, provide a way of uniquely identifying the object from an index.

Method Detail

convert

public org.apache.lucene.document.Document convert(java.lang.Object o,
                                                   java.lang.Object context)

Converts objects to Documents.

Parameters:

o - object to be converted

context - the context in which the object exists. Null if not applicable.

Returns:

Document representing the indexable version of the object

getObjectIdentity

public java.lang.String[] getObjectIdentity(java.lang.Object o)

Given an object, provide a way of uniquely identifying the object from an index.

Returns:

array of identity field name and identity value