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

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

All Implemented Interfaces:

LuceneParameter, SearchParameter

public class FreeTextParameter
extends SingleFieldSingleValueLuceneParameter

This parameter is similar to the StringParameter except that it passes the query through Lucene, which means that you get word stemming etc.

Field Summary

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

log

Constructor Summary

FreeTextParameter()

FreeTextParameter(String name, String value)

FreeTextParameter(String name, String elementName, String value)

Method Summary

org.apache.lucene.search.Query	getQuery(org.ofbiz.core.entity.GenericValue project, User searcher)
protected String	getQueryStringPrefix() Query parameter name, suitable for inclusion in URL.
protected String	getXmlElementName() For some parameters, the parameter name may not be a valid XML element name (eg, if it contains a ':' in the case of custom fields.
void	setXml(electric.xml.Element el) Initialise this search parameter using an XML element.

Methods inherited from class com.atlassian.jira.issue.search.parameters.lucene.SingleFieldSingleValueLuceneParameter

getXml, isValid

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

addValue, clearValues, equals, getName, getQueryString, getValues, hashCode, 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, getQueryString, getValues, setName

Constructor Detail

FreeTextParameter

public FreeTextParameter()

FreeTextParameter

public FreeTextParameter(String name,
                         String value)

FreeTextParameter

public FreeTextParameter(String name,
                         String elementName,
                         String value)

Method Detail

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

Overrides:

getQuery in class SingleFieldSingleValueLuceneParameter

Returns:

a collection of Query objects.

Throws:

org.apache.lucene.queryParser.ParseException

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

Parameters:

el - XML element

getXmlElementName

protected String getXmlElementName()

Description copied from class: SingleFieldSingleValueLuceneParameter

For some parameters, the parameter name may not be a valid XML element name (eg, if it contains a ':' in the case of custom fields. For those parameters, you can override the element name here).

Overrides:

getXmlElementName in class SingleFieldSingleValueLuceneParameter

Returns:

The element name to describe this parameter. By default, it returns the same as AbstractSearchParameter.getName()

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