com.atlassian.jira.issue.statistics
Class TextFieldSorter

java.lang.Object
  extended by com.atlassian.jira.issue.statistics.TextFieldSorter
All Implemented Interfaces:
LuceneFieldSorter<java.lang.String>

public class TextFieldSorter
extends java.lang.Object
implements LuceneFieldSorter<java.lang.String>


Constructor Summary
TextFieldSorter(java.lang.String documentConstant)
           
 
Method Summary
 boolean equals(java.lang.Object o)
          As this object is used as a key in a cache, this method must be provided and respect all internal state.
 java.util.Comparator<java.lang.String> getComparator()
          A comparator that can be used to order objects returned by LuceneFieldSorter.getValueFromLuceneField(String).
 java.lang.String getDocumentConstant()
          Get the constant that this field is indexed with.
 java.lang.String getValueFromLuceneField(java.lang.String documentValue)
          Convert the lucene document field back to the object that you wish to use to display it.
 int hashCode()
          As this object is used as a key in a cache, this method must be provided and respect all internal state.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TextFieldSorter

public TextFieldSorter(java.lang.String documentConstant)
Method Detail

getDocumentConstant

public java.lang.String getDocumentConstant()
Description copied from interface: LuceneFieldSorter
Get the constant that this field is indexed with.

Specified by:
getDocumentConstant in interface LuceneFieldSorter<java.lang.String>
See Also:
IssueDocument, CustomFieldSearcher

getValueFromLuceneField

public java.lang.String getValueFromLuceneField(java.lang.String documentValue)
Description copied from interface: LuceneFieldSorter
Convert the lucene document field back to the object that you wish to use to display it.

eg. '1000' -> Version 1.

This does the reverse of what IssueDocument does.

For custom fields, the return value will be passed to CustomFieldSearcherModuleDescriptor.getStatHtml(com.atlassian.jira.issue.fields.CustomField, Object, String)

Specified by:
getValueFromLuceneField in interface LuceneFieldSorter<java.lang.String>
Parameters:
documentValue - The value of the field in the lucene index
Returns:
The value that will be passed to the display

getComparator

public java.util.Comparator<java.lang.String> getComparator()
Description copied from interface: LuceneFieldSorter
A comparator that can be used to order objects returned by LuceneFieldSorter.getValueFromLuceneField(String).

The Comparator must be reentrant as it could be used by Lucene from multiple threads at once.

Specified by:
getComparator in interface LuceneFieldSorter<java.lang.String>

equals

public boolean equals(java.lang.Object o)
Description copied from interface: LuceneFieldSorter
As this object is used as a key in a cache, this method must be provided and respect all internal state.

See the class javadoc entry for more details.

Specified by:
equals in interface LuceneFieldSorter<java.lang.String>
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Description copied from interface: LuceneFieldSorter
As this object is used as a key in a cache, this method must be provided and respect all internal state.

See the class javadoc entry for more details.

Specified by:
hashCode in interface LuceneFieldSorter<java.lang.String>
Overrides:
hashCode in class java.lang.Object


Copyright © 2002-2010 Atlassian. All Rights Reserved.