public abstract class BaseFieldIndexer extends Object implements FieldIndexer
Modifier and Type | Field and Description |
---|---|
protected FieldVisibilityManager |
fieldVisibilityManager |
LABELS_NO_VALUE_INDEX_VALUE, NO_VALUE_INDEX_VALUE
Modifier | Constructor and Description |
---|---|
protected |
BaseFieldIndexer(FieldVisibilityManager fieldVisibilityManager) |
Modifier and Type | Method and Description |
---|---|
int |
compareTo(Object obj) |
boolean |
equals(Object o) |
int |
hashCode() |
void |
indexDateField(org.apache.lucene.document.Document doc,
String indexField,
Timestamp date,
Issue issue)
Index a single keyword field, with a date-time value
|
void |
indexDependentEntities(Issue issue,
org.apache.lucene.document.Document doc,
String associationType,
String indexField)
Index the dependent entities of an issue.
|
void |
indexFoldedKeyword(org.apache.lucene.document.Document doc,
String indexField,
String fieldValue,
Locale locale,
Issue issue)
Case fold the passed keyword and add it to the passed document.
|
void |
indexKeyword(org.apache.lucene.document.Document doc,
String indexField,
String fieldValue,
Issue issue)
Index a single keyword field
|
void |
indexKeywords(org.apache.lucene.document.Document doc,
String indexField,
String fieldValue,
Issue issue) |
void |
indexKeywordWithDefault(org.apache.lucene.document.Document doc,
String indexField,
Long aLong,
String defaultValue,
Issue issue) |
void |
indexKeywordWithDefault(org.apache.lucene.document.Document doc,
String indexField,
String fieldValue,
String defaultValue,
Issue issue)
Index a single keyword field, with a default if the issue field is not set
|
void |
indexLocalDateField(org.apache.lucene.document.Document doc,
String indexField,
LocalDate localDate,
Issue issue)
Index a single keyword field, with a LocalDate value
|
void |
indexLongAsKeyword(org.apache.lucene.document.Document doc,
String indexField,
Long fieldValue,
Issue issue) |
void |
indexLongAsPaddedKeywordWithDefault(org.apache.lucene.document.Document doc,
String indexField,
Long aLong,
Long defaultLong,
Issue issue)
Useful for storing a
Long value for range query searches. |
void |
indexLongAsPaddedKeywordWithDefault(org.apache.lucene.document.Document doc,
String indexField,
Long aLong,
String defaultValue,
Issue issue)
Useful for storing a
Long value for range query searches. |
void |
indexText(org.apache.lucene.document.Document doc,
String indexField,
String fieldValue,
Issue issue)
Index a single text field
|
void |
indexTextForSorting(org.apache.lucene.document.Document doc,
String indexField,
String fieldValue,
Issue issue)
Index a single text field
|
boolean |
isFieldVisibleAndInScope(Issue issue)
This method is used to determine if the indexer is relevant for the provided issue.
|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
addIndex, addIndex, addIndex, getDocumentFieldId, getId, skipsIndexingNull
protected final FieldVisibilityManager fieldVisibilityManager
protected BaseFieldIndexer(FieldVisibilityManager fieldVisibilityManager)
public void indexKeyword(org.apache.lucene.document.Document doc, String indexField, String fieldValue, Issue issue)
doc
- the document to add the field to.indexField
- the document field name to user.fieldValue
- the value to index. This value will NOT be folded before adding it to the document.issue
- the issue that defines the context and contains the value we are indexing.public void indexKeywords(org.apache.lucene.document.Document doc, String indexField, String fieldValue, Issue issue)
public void indexFoldedKeyword(org.apache.lucene.document.Document doc, String indexField, String fieldValue, Locale locale, Issue issue)
doc
- the document to add the field to.indexField
- the document field name to use.fieldValue
- the value to index. This value will be folded before adding it to the document.locale
- the locale to use in the case folding. Null can be passed to use the Locale given in Locale.getDefault()
.issue
- the issue that defines the context and contains the value we are indexing.CaseFolding
public void indexKeywordWithDefault(org.apache.lucene.document.Document doc, String indexField, String fieldValue, String defaultValue, Issue issue)
shared with CommentDocumentFactory
public void indexKeywordWithDefault(org.apache.lucene.document.Document doc, String indexField, Long aLong, String defaultValue, Issue issue)
public void indexLongAsPaddedKeywordWithDefault(org.apache.lucene.document.Document doc, String indexField, Long aLong, String defaultValue, Issue issue)
Long
value for range query searches.
Uses NumberTools.longToString(long)
to pad and convert the value to base 36
before indexing. Does not pad the default value.doc
- the documentindexField
- the index field idaLong
- the long value to be converteddefaultValue
- the default value if aLong is nullissue
- the issue that defines the context and contains the value we are indexing.public void indexLongAsPaddedKeywordWithDefault(org.apache.lucene.document.Document doc, String indexField, Long aLong, Long defaultLong, Issue issue)
Long
value for range query searches.
Uses NumberTools.longToString(long)
to pad and convert the values to base 36
before indexing. Also pads and converts the default Value.doc
- the documentindexField
- the index field idaLong
- the long value to be converteddefaultLong
- the default value if aLong is nullissue
- the issue that defines the context and contains the value we are indexing.public void indexText(org.apache.lucene.document.Document doc, String indexField, String fieldValue, Issue issue)
public void indexDateField(org.apache.lucene.document.Document doc, String indexField, Timestamp date, Issue issue)
public void indexLocalDateField(org.apache.lucene.document.Document doc, String indexField, LocalDate localDate, Issue issue)
public void indexDependentEntities(Issue issue, org.apache.lucene.document.Document doc, String associationType, String indexField)
public void indexLongAsKeyword(org.apache.lucene.document.Document doc, String indexField, Long fieldValue, Issue issue)
public void indexTextForSorting(org.apache.lucene.document.Document doc, String indexField, String fieldValue, Issue issue)
public int compareTo(Object obj)
public boolean isFieldVisibleAndInScope(Issue issue)
FieldIndexer
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.
isFieldVisibleAndInScope
in interface FieldIndexer
issue
- that is having a document created from.Copyright © 2002-2022 Atlassian. All Rights Reserved.