Atlassian JIRA
| java.lang.Object | |
| ↳ | com.atlassian.jira.issue.index.indexers.impl.AbstractCustomFieldIndexer |
@PublicSpi
Clients of @PublicSpi can expect
that programs compiled against a given version will remain binary compatible with later versions of the
@PublicSpi as per each product's API policy (clients should refer to each product's API policy for
the exact guarantee -- usually binary compatibility is guaranteed at least across minor versions).
@PublicSpi interfaces and classes are specifically designed to be implemented/extended by clients.
Hence, the guarantee of binary compatibility is different to that of @PublicApi elements (if an element
is both @PublicApi and @PublicSpi, both guarantees apply).
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.
|
[Expand]
Inherited Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From interface
com.atlassian.jira.issue.index.indexers.FieldIndexer
| |||||||||||
| Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| customField | |||||||||||
| Protected Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
This method allows an indexer the opportunity to modifiy 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.
| |||||||||||
This method is used to determine if the indexer is relevant for the provided issue.
| |||||||||||
| Protected Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
java.lang.Object
| |||||||||||
|
From interface
com.atlassian.jira.issue.index.indexers.FieldIndexer
| |||||||||||
This method allows an indexer the opportunity to modifiy 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 isFieldVisibleAndInScope(com.atlassian.jira.issue.Issue) returns false then
this method should create fields that have an Indexed type of NO.
This allows us to store the value in the index but renderes 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.
| 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. |
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.
| issue | that is having a document created from. |
|---|