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

Class NumberCustomFieldIndexer

java.lang.Object

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

All Implemented Interfaces:

CustomFieldIndexer, FieldIndexer

@PublicApi
public class NumberCustomFieldIndexer
extends Object
implements CustomFieldIndexer, FieldIndexer

Field indexer for number custom fields

Since:

10.4

Field Summary

Fields

Modifier and Type	Field	Description
protected final FieldVisibilityManager	fieldVisibilityManager

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

LABELS_NO_VALUE_INDEX_VALUE, NO_VALUE_INDEX_VALUE

Constructor Summary

Constructors

Constructor	Description
NumberCustomFieldIndexer(FieldVisibilityManager fieldVisibilityManager, CustomField customField, boolean skipsIndexingNull)

Method Summary

Modifier and Type	Method	Description
CustomField	getCustomField()	Returns the custom field associated with this indexer
Collection<Field>	getFields()	Declares the fields to be added to the index schema
String	getId()
void	indexFields(FieldValueCollector collector, Issue issue, CustomFieldPrefetchedData prefetchedData)	This method allows an indexer the opportunity to add values to the provided collector that are relevant for searching and storage of the portion of the issue that the FieldIndexer handles.
void	indexFieldsWithVisibility(FieldValueCollector collector, Issue issue, CustomFieldPrefetchedData prefetchedData, boolean visible)	The same as indexField but accepts an additional parameter to indicate if the field is visible and in scope.
boolean	isFieldVisibleAndInScope(Issue issue)	This method is used to determine if the indexer is relevant for the provided issue.
boolean	skipsIndexingNull()	Used to declare how the indexer handles nulls.

Methods inherited from class java.lang.Object

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

Field Details

fieldVisibilityManager

protected final FieldVisibilityManager fieldVisibilityManager

Constructor Details

NumberCustomFieldIndexer

public NumberCustomFieldIndexer(FieldVisibilityManager fieldVisibilityManager,
 CustomField customField,
 boolean skipsIndexingNull)

Method Details

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.

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.

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.

getCustomField

public CustomField getCustomField()

Description copied from interface: CustomFieldIndexer

Returns the custom field associated with this indexer

Specified by:

getCustomField in interface CustomFieldIndexer

Returns:

CustomField

indexFields

public void indexFields(FieldValueCollector collector,
 Issue issue,
 CustomFieldPrefetchedData prefetchedData)

Description copied from interface: FieldIndexer

This method allows an indexer the opportunity to add values to the provided collector that are relevant for searching and storage of the portion of the issue that the FieldIndexer handles.

If, for example, the indexer handles indexing an issues summary then this indexer will add a field value to the collector 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 KeywordField will result in them being removed to prevent the indexing operation from crashing. This is a limitation of how OpenSearch and Lucene store terms.

Specified by:

indexFields in interface FieldIndexer

Parameters:

collector - the collector for collecting indexed values

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>)

indexFieldsWithVisibility

public void indexFieldsWithVisibility(FieldValueCollector collector,
 Issue issue,
 CustomFieldPrefetchedData prefetchedData,
 boolean visible)

Description copied from interface: FieldIndexer

The same as indexField but accepts an additional parameter to indicate if the field is visible and in scope. Thanks to that there is no need to call FieldIndexer.isFieldVisibleAndInScope(Issue) method inside. The default implementation is for backward compatibility. An indexer that wants to take advantage of performance gain should implement FieldWithVisibilityIndexer interface

Specified by:

indexFieldsWithVisibility in interface FieldIndexer

Parameters:

collector - the collector for collecting indexed values

issue - that is having a document created from.

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

getFields

public Collection<Field> getFields()

Description copied from interface: FieldIndexer

Declares the fields to be added to the index schema

Specified by:

getFields in interface FieldIndexer

skipsIndexingNull

public boolean skipsIndexingNull()

Description copied from interface: FieldIndexer

Used to declare how the indexer handles nulls.

Specified by:

skipsIndexingNull in interface FieldIndexer

Returns:

true if the indexer doesn't do anything when the field value is null