com.atlassian.bamboo.index.fields

Interface IndexedEntityField<T>

All Known Subinterfaces:

IndexedEntityDateField, IndexedEntityEnumField<T>, IndexedEntityIdField, IndexedEntityIntegerField, IndexedEntityLongField, IndexedEntityPlanResultKeyField, IndexedEntityTextField

All Known Implementing Classes:

IndexedEntityDateFieldImpl, IndexedEntityEnumFieldImpl, IndexedEntityIdFieldImpl, IndexedEntityIntegerFieldImpl, IndexedEntityLongFieldImpl, IndexedEntityPlanResultKeyFieldImpl, IndexedEntityTextFieldImpl, LuceneStringField

public interface IndexedEntityField<T>

Method Summary

Modifier and Type	Method and Description
void	addToDocument(org.apache.lucene.document.Document document, T value)
org.apache.lucene.search.Query	createQuery(T value)
org.apache.lucene.index.Term	createTerm(org.apache.lucene.document.Document document)
org.apache.lucene.index.Term	createTerm(T value)
String	getFieldId()
T	getValue(org.apache.lucene.document.Document document)
com.google.common.base.Function<org.apache.lucene.document.Document,T>	getValueFunction()
void	removeFromDocument(org.apache.lucene.document.Document document)

Method Detail

getFieldId

@NotNull
String getFieldId()

getValue

@Nullable
T getValue(@NotNull
                     org.apache.lucene.document.Document document)

addToDocument

void addToDocument(@NotNull
                   org.apache.lucene.document.Document document,
                   @Nullable
                   T value)

removeFromDocument

void removeFromDocument(@NotNull
                        org.apache.lucene.document.Document document)

createTerm

@NotNull
org.apache.lucene.index.Term createTerm(@NotNull
                                                 T value)

createTerm

@NotNull
org.apache.lucene.index.Term createTerm(@NotNull
                                                 org.apache.lucene.document.Document document)

createQuery

@NotNull
org.apache.lucene.search.Query createQuery(@NotNull
                                                    T value)

getValueFunction

@NotNull
com.google.common.base.Function<org.apache.lucene.document.Document,T> getValueFunction()