public class

VotesIndexer

extends BaseFieldIndexer
java.lang.Object
   ↳ com.atlassian.jira.issue.index.indexers.impl.BaseFieldIndexer
     ↳ com.atlassian.jira.issue.index.indexers.impl.VotesIndexer

Summary

[Expand]
Inherited Constants
From interface com.atlassian.jira.issue.index.indexers.FieldIndexer
Public Constructors
VotesIndexer(FieldVisibilityManager fieldVisibilityManager, VoteManager voteManager)
Public Methods
void addIndex(Document doc, Issue issue)
String getDocumentFieldId()
String getId()
boolean isFieldVisibleAndInScope(Issue issue)
This method is used to determine if the indexer is relevant for the provided issue.
[Expand]
Inherited Methods
From class com.atlassian.jira.issue.index.indexers.impl.BaseFieldIndexer
From class java.lang.Object
From interface com.atlassian.jira.issue.index.indexers.FieldIndexer

Public Constructors

public VotesIndexer (FieldVisibilityManager fieldVisibilityManager, VoteManager voteManager)

Public Methods

public void addIndex (Document doc, Issue issue)

public String getDocumentFieldId ()

public String getId ()

public boolean isFieldVisibleAndInScope (Issue issue)

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 NO. The result of this method is used to determine the correct values that should be returned when performing an empty search.

Parameters
issue that is having a document created from.
Returns
  • if true then this field is relevant for the issue, otherwise it is not.