com.atlassian.jira.issue.search.searchers.information
Class GenericSearcherInformation<T extends SearchableField>

java.lang.Object
  com.atlassian.jira.issue.search.searchers.information.GenericSearcherInformation<T>

All Implemented Interfaces:

SearcherInformation<T>

Direct Known Subclasses:

CustomFieldSearcherInformation

public class GenericSearcherInformation<T extends SearchableField>
extends Object
implements SearcherInformation<T>

Provides name and index information for the resolution searcher.

Since:

v4.0

Constructor Summary

GenericSearcherInformation(String id, String nameKey, List<Class<? extends FieldIndexer>> indexers, AtomicReference<T> fieldReference, SearcherGroupType searcherGroupType)

Method Summary

T	getField()
String	getId() The unique id of the searcher.
String	getNameKey() The i18n key that is used to lookup the searcher's name when it is displayed.
List<FieldIndexer>	getRelatedIndexers() Returns a list of FieldIndexer objects.
SearcherGroupType	getSearcherGroupType() The searcher group the searcher should be placed in.

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericSearcherInformation

public GenericSearcherInformation(String id,
                                  String nameKey,
                                  List<Class<? extends FieldIndexer>> indexers,
                                  AtomicReference<T> fieldReference,
                                  SearcherGroupType searcherGroupType)

Method Detail

getId

public String getId()

Description copied from interface: SearcherInformation

The unique id of the searcher.

Specified by:

getId in interface SearcherInformation<T extends SearchableField>

Returns:

unique id of the searcher.

getNameKey

public String getNameKey()

Description copied from interface: SearcherInformation

The i18n key that is used to lookup the searcher's name when it is displayed.

Specified by:

getNameKey in interface SearcherInformation<T extends SearchableField>

Returns:

i18n key that is used to lookup the searcher's name when it is displayed.

getRelatedIndexers

public List<FieldIndexer> getRelatedIndexers()

Description copied from interface: SearcherInformation

Returns a list of FieldIndexer objects. The objects should be initialised and ready for action

Specified by:

getRelatedIndexers in interface SearcherInformation<T extends SearchableField>

Returns:

List of FieldIndexer objects. Must not be null. Return an empty list if none available

getSearcherGroupType

public SearcherGroupType getSearcherGroupType()

Description copied from interface: SearcherInformation

The searcher group the searcher should be placed in. Really only useful for system fields as custom fields are forced into the SearcherGroupType.CUSTOM group.

Specified by:

getSearcherGroupType in interface SearcherInformation<T extends SearchableField>

Returns:

the group the searcher should be associated with. Cannot not be null.

getField

public T getField()

Specified by:

getField in interface SearcherInformation<T extends SearchableField>

Returns:

the field that this searcher was initialised with. If the searcher has not yet been initialised, this will return null.