com.atlassian.jira.issue.index.indexers.impl

Class AbstractCustomFieldIndexer

java.lang.Object

com.atlassian.jira.issue.index.indexers.impl.AbstractCustomFieldIndexer

All Implemented Interfaces:

FieldIndexer

Direct Known Subclasses:

CascadingSelectCustomFieldIndexer, CustomFieldLabelsIndexer, DateCustomFieldIndexer, ExactTextCustomFieldIndexer, GroupCustomFieldIndexer, LabelsCustomFieldIndexer, LocalDateIndexer, NumberCustomFieldIndexer, ProjectCustomFieldIndexer, SelectCustomFieldIndexer, SlowFieldIndexer, SortableTextCustomFieldIndexer, UserCustomFieldIndexer, VersionCustomFieldIndexer

@PublicSpi
public abstract class AbstractCustomFieldIndexer
extends Object
implements FieldIndexer

A base-class for custom field indexers that performs the logic of checking if the CustomField isVisibleAndInScope and then delegates off to the base class to add the correct document fields.

Since:

v4.0

Field Summary

Fields

Modifier and Type	Field and Description
protected CustomField	customField

Fields inherited from interface com.atlassian.jira.issue.index.indexers.FieldIndexer

LABELS_NO_VALUE_INDEX_VALUE, NO_VALUE_INDEX_VALUE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCustomFieldIndexer(FieldVisibilityManager fieldVisibilityManager, CustomField customField)

Method Summary

Modifier and Type	Method and Description
void	addDocumentFieldsNotSearchable(org.apache.lucene.document.Document doc, Issue issue) Deprecated. since 8.10 implement addDocumentFieldsNotSearchable(Document, Issue, CustomFieldPrefetchedData) instead
protected void	addDocumentFieldsNotSearchable(org.apache.lucene.document.Document doc, Issue issue, CustomFieldPrefetchedData prefetchedData) Deprecated. since 8.12 implement addDocumentFieldsNotSearchable(Document, Issue, CustomFieldPrefetchedData) instead
protected void	addDocumentFieldsNotSearchable(org.apache.lucene.document.Document doc, Issue issue, CustomFieldPrefetchedData prefetchedData)
void	addDocumentFieldsSearchable(org.apache.lucene.document.Document doc, Issue issue) Deprecated. since 8.10 implement addDocumentFieldsSearchable(Document, Issue, CustomFieldPrefetchedData) instead
protected void	addDocumentFieldsSearchable(org.apache.lucene.document.Document doc, Issue issue, CustomFieldPrefetchedData prefetchedData) Deprecated. since 8.12 implement addDocumentFieldsNotSearchable(Document, Issue, CustomFieldPrefetchedData) instead
protected void	addDocumentFieldsSearchable(org.apache.lucene.document.Document doc, Issue issue, CustomFieldPrefetchedData prefetchedData)
void	addIndex(org.apache.lucene.document.Document doc, Issue issue) This method allows an indexer the opportunity to modify the provided Lucene document (by reference) such that it will contain fields that are relevant for searching and storage of the portion of the issue that the FieldIndexer handles.
void	addIndex(org.apache.lucene.document.Document doc, Issue issue, CustomFieldPrefetchedData prefetchedData)
void	addIndex(org.apache.lucene.document.Document doc, Issue issue, CustomFieldPrefetchedData prefetchedData) This method allows an indexer the opportunity to modify the provided Lucene document (by reference) such that it will contain fields that are relevant for searching and storage of the portion of the issue that the FieldIndexer handles.
String	getDocumentFieldId()
String	getId()
boolean	isFieldVisibleAndInScope(Issue issue) This method is used to determine if the indexer is relevant for the provided issue.
protected boolean	isRelevantForIssue(Issue issue)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.jira.issue.index.indexers.FieldIndexer

skipsIndexingNull

Field Detail

customField

protected final CustomField customField

Constructor Detail

AbstractCustomFieldIndexer

protected AbstractCustomFieldIndexer(FieldVisibilityManager fieldVisibilityManager,
                                     CustomField customField)

Method Detail

getId

public String getId()

Specified by:

getId in interface FieldIndexer

Returns:

the String representation of the field id that this indexer is indexing, this must be unique for each independent FieldIndexer. If the Indexer does not represent a System or Custom field in JIRA this should still return a unique string that describes the indexer.

getDocumentFieldId

public String getDocumentFieldId()

Specified by:

getDocumentFieldId in interface FieldIndexer

Returns:

the String representation of the primary field id that will be added to the Document as a result of a successful call to the FieldIndexer.addIndex(Document, Issue, CustomFieldPrefetchedData) method.

addDocumentFieldsSearchable

@Deprecated
public void addDocumentFieldsSearchable(org.apache.lucene.document.Document doc,
                                                    Issue issue)

Deprecated. since 8.10 implement addDocumentFieldsSearchable(Document, Issue, CustomFieldPrefetchedData) instead

addDocumentFieldsNotSearchable

@Deprecated
public void addDocumentFieldsNotSearchable(org.apache.lucene.document.Document doc,
                                                       Issue issue)

Deprecated. since 8.10 implement addDocumentFieldsNotSearchable(Document, Issue, CustomFieldPrefetchedData) instead

addDocumentFieldsSearchable

@Deprecated
protected void addDocumentFieldsSearchable(org.apache.lucene.document.Document doc,
                                                       Issue issue,
                                                       CustomFieldPrefetchedData prefetchedData)

Deprecated. since 8.12 implement addDocumentFieldsNotSearchable(Document, Issue, CustomFieldPrefetchedData) instead

addDocumentFieldsNotSearchable

@Deprecated
protected void addDocumentFieldsNotSearchable(org.apache.lucene.document.Document doc,
                                                          Issue issue,
                                                          CustomFieldPrefetchedData prefetchedData)

Deprecated. since 8.12 implement addDocumentFieldsNotSearchable(Document, Issue, CustomFieldPrefetchedData) instead

addDocumentFieldsSearchable

protected void addDocumentFieldsSearchable(org.apache.lucene.document.Document doc,
                                           Issue issue,
                                           CustomFieldPrefetchedData prefetchedData)

addDocumentFieldsNotSearchable

protected void addDocumentFieldsNotSearchable(org.apache.lucene.document.Document doc,
                                              Issue issue,
                                              CustomFieldPrefetchedData prefetchedData)

addIndex

public final void addIndex(org.apache.lucene.document.Document doc,
                           Issue issue)

Description copied from interface: FieldIndexer

This method allows an indexer the opportunity to modify the provided Lucene document (by reference) such that it will contain fields that are relevant for searching and storage of the portion of the issue that the FieldIndexer handles.

If calling FieldIndexer.isFieldVisibleAndInScope(com.atlassian.jira.issue.Issue) returns false then this method should create fields that have an Indexed type of org.apache.lucene.document.Field.Index#NO. This allows us to store the value in the index but renders its value unsearchable.

If, for example, the indexer handles indexing an issues summary then this indexer will add a field to the document that represents the stored and searchable summary of the issue.

Note that trying to index very large (i.e. larger than ~32 kB) fields as StringFields or DocValues will result in them being removed to prevent the indexing operation from crashing. This is a limitation of how Lucene stores terms and DocValues.

Specified by:

addIndex in interface FieldIndexer

Parameters:

doc - the lucene document that should be modified by adding relevant fields to.

issue - the issue that contains the data that will be indexed and which can be used to determine the project/issue type context that will allow you to determine if we should add the value as searchable or unsearchable.

addIndex

public void addIndex(org.apache.lucene.document.Document doc,
                     Issue issue,
                     CustomFieldPrefetchedData prefetchedData)

Specified by:

addIndex in interface FieldIndexer

addIndex

public void addIndex(org.apache.lucene.document.Document doc,
                     Issue issue,
                     CustomFieldPrefetchedData prefetchedData)

Description copied from interface: FieldIndexer

This method allows an indexer the opportunity to modify the provided Lucene document (by reference) such that it will contain fields that are relevant for searching and storage of the portion of the issue that the FieldIndexer handles.

If calling FieldIndexer.isFieldVisibleAndInScope(com.atlassian.jira.issue.Issue) returns false then this method should create fields that have FieldType.stored() } property set to true. This allows us to store the value in the index but renders its value unsearchable.

If, for example, the indexer handles indexing an issues summary then this indexer will add a field to the document that represents the stored and searchable summary of the issue.

Note that trying to index very large (i.e. larger than ~32 kB) fields as StringFields or DocValues will result in them being removed to prevent the indexing operation from crashing. This is a limitation of how Lucene stores terms and DocValues.

Specified by:

addIndex in interface FieldIndexer

Parameters:

doc - the Lucene document that should be modified by adding relevant fields to.

issue - the issue that contains the data that will be indexed and which can be used to determine the project/issue type context that will allow you to determine if we should add the value as searchable or unsearchable.

prefetchedData - if the custom field type implemented CustomFieldType.getNonNullCustomFieldProvider() this reference will hold the matching value returned from NonNullCustomFieldProvider.getCustomFieldInfo(List <Issue>)

isFieldVisibleAndInScope

public boolean isFieldVisibleAndInScope(Issue issue)

Description copied from interface: FieldIndexer

This method is used to determine if the indexer is relevant for the provided issue. This method must check the fields visibility, in relation to the field configuration scheme, must check any global flags that would enable or disable a field (such as enable votes flag), and must check, if the field is a custom field, if the custom field is relevant for this issue.

All these checks should take into account the IssueContext as defined by the passed in issue.

If this method returns false then the FieldIndexer, when performing addIndex, should make sure to make the indexed values have an Indexed type of org.apache.lucene.document.Field.Index#NO.

The result of this method is used to determine the correct values that should be returned when performing an empty search.

Specified by:

isFieldVisibleAndInScope in interface FieldIndexer

Parameters:

issue - that is having a document created from.

Returns:

if true then this field is relevant for the issue, otherwise it is not.

isRelevantForIssue

protected boolean isRelevantForIssue(Issue issue)