com.atlassian.jira.issue.search.parameters.lucene
Class MultipleFieldSingleValueLuceneParameter

java.lang.Object
  com.atlassian.jira.issue.search.parameters.AbstractSearchParameter
      com.atlassian.jira.issue.search.parameters.AbstractLuceneParameter
          com.atlassian.jira.issue.search.parameters.lucene.MultipleFieldSingleValueLuceneParameter

All Implemented Interfaces:

CommentParameter, IssueParameter, LuceneParameter, SearchParameter

public class MultipleFieldSingleValueLuceneParameter

extends AbstractLuceneParameter

implements IssueParameter, CommentParameter

This is a parameter that will search multiple Lucene fields for a single query

Field Summary

(package private) List

fields

Fields inherited from class com.atlassian.jira.issue.search.parameters.AbstractSearchParameter

JIRA_ENCODING, log, values

Constructor Summary

MultipleFieldSingleValueLuceneParameter()

MultipleFieldSingleValueLuceneParameter(Collection fields, String query)

Method Summary

boolean	equals(Object o)
org.apache.lucene.search.Query	getCommentQuery(org.ofbiz.core.entity.GenericValue project, User searcher)
List	getFields()
org.apache.lucene.search.Query	getIssueQuery(org.ofbiz.core.entity.GenericValue project, User searcher)
org.apache.lucene.search.Query	getQuery(org.ofbiz.core.entity.GenericValue project, User searcher)
String	getQueryString()
protected String	getQueryStringPrefix() Query parameter name, suitable for inclusion in URL.
electric.xml.Element	getXml() Return an XML representation of this search parameter.
int	hashCode()
boolean	isValid()
void	setXml(electric.xml.Element el) Initialise this search parameter using an XML element.

Methods inherited from class com.atlassian.jira.issue.search.parameters.AbstractSearchParameter

addValue, clearValues, getName, getValues, setName, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.jira.issue.search.SearchParameter

addValue, getName, getValues, setName

Field Detail

fields

List fields

Constructor Detail

MultipleFieldSingleValueLuceneParameter

public MultipleFieldSingleValueLuceneParameter()

MultipleFieldSingleValueLuceneParameter

public MultipleFieldSingleValueLuceneParameter(Collection fields,
                                               String query)

Method Detail

getFields

public List getFields()

getIssueQuery

public org.apache.lucene.search.Query getIssueQuery(org.ofbiz.core.entity.GenericValue project,
                                                    User searcher)
                                             throws org.apache.lucene.queryParser.ParseException

Specified by:

getIssueQuery in interface IssueParameter

Throws:

org.apache.lucene.queryParser.ParseException

getCommentQuery

public org.apache.lucene.search.Query getCommentQuery(org.ofbiz.core.entity.GenericValue project,
                                                      User searcher)
                                               throws org.apache.lucene.queryParser.ParseException

Specified by:

getCommentQuery in interface CommentParameter

Throws:

org.apache.lucene.queryParser.ParseException

getQuery

public org.apache.lucene.search.Query getQuery(org.ofbiz.core.entity.GenericValue project,
                                               User searcher)
                                        throws org.apache.lucene.queryParser.ParseException

Specified by:

getQuery in interface LuceneParameter

Returns:

a collection of Query objects.

Throws:

org.apache.lucene.queryParser.ParseException

getXml

public electric.xml.Element getXml()

Description copied from interface: SearchParameter

Return an XML representation of this search parameter.

Specified by:

getXml in interface SearchParameter

Specified by:

getXml in class AbstractSearchParameter

setXml

public void setXml(electric.xml.Element el)

Description copied from interface: SearchParameter

Initialise this search parameter using an XML element. Usual process is:

    SearchParameter param = new MySearchParameter();
    param.setXml(element);
 

Specified by:

setXml in interface SearchParameter

Overrides:

setXml in class AbstractSearchParameter

isValid

public boolean isValid()

Specified by:

isValid in interface SearchParameter

Specified by:

isValid in class AbstractSearchParameter

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractSearchParameter

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractSearchParameter

getQueryString

public String getQueryString()

Specified by:

getQueryString in interface SearchParameter

Overrides:

getQueryString in class AbstractSearchParameter

getQueryStringPrefix

protected String getQueryStringPrefix()

Description copied from class: AbstractSearchParameter

Query parameter name, suitable for inclusion in URL. Note that implementations of this method should ensure that the values that they return are URLEncoded, perhaps using the URLEncoder.encode(String) method.

Overrides:

getQueryStringPrefix in class AbstractSearchParameter