com.atlassian.jira.issue.index.indexers

Class FieldIndexerWithStats

java.lang.Object

com.atlassian.jira.issue.index.indexers.FieldIndexerWithStats

All Implemented Interfaces:

FieldIndexer

public class FieldIndexerWithStats
extends Object
implements FieldIndexer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FieldIndexerWithStats.Stats

Field Summary

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

LABELS_NO_VALUE_INDEX_VALUE, NO_VALUE_INDEX_VALUE

Method Summary

Modifier and Type	Method and Description
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.
static FieldIndexerWithStats	createKnown(FieldIndexer delegate)
static FieldIndexerWithStats	createOther(FieldIndexer delegate)
boolean	equals(Object o)
String	getDocumentFieldId()
String	getId()
int	hashCode()
boolean	isFieldVisibleAndInScope(Issue issue) This method is used to determine if the indexer is relevant for the provided issue.
FieldIndexerWithStats	overrideTicker(com.google.common.base.Ticker ticker)
void	reset()
FieldIndexerWithStats.Stats	resetSnapshot()
FieldIndexerWithStats.Stats	stats()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

overrideTicker

public FieldIndexerWithStats overrideTicker(com.google.common.base.Ticker ticker)

createKnown

public static FieldIndexerWithStats createKnown(FieldIndexer delegate)

createOther

public static FieldIndexerWithStats createOther(FieldIndexer delegate)

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(org.apache.lucene.document.Document, com.atlassian.jira.issue.Issue) method.

addIndex

public 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.

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.

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.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

stats

public FieldIndexerWithStats.Stats stats()

resetSnapshot

public FieldIndexerWithStats.Stats resetSnapshot()

reset

public void reset()