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

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

All Implemented Interfaces:

SearchParameter

Direct Known Subclasses:

CustomFieldObjectParameter, DateParameter, FreeTextParameter, NumberParameter, PeriodParameter, ProjectParameter, StringParameter, WorkRatioParameter

public abstract class SingleFieldSingleValueLuceneParameter

extends LuceneParameter

Field Summary

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

log

Constructor Summary

SingleFieldSingleValueLuceneParameter()

SingleFieldSingleValueLuceneParameter(java.lang.String name)

Method Summary

org.apache.lucene.search.Query	getQuery(org.ofbiz.core.entity.GenericValue project, com.opensymphony.user.User searcher)
electric.xml.Element	getXml() Return an XML representation of this search parameter
protected java.lang.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.
boolean	isValid()

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

addValue, clearValues, equals, getName, getQueryString, getQueryStringPrefix, getValues, hashCode, setName, setXml, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SingleFieldSingleValueLuceneParameter

public SingleFieldSingleValueLuceneParameter()

SingleFieldSingleValueLuceneParameter

public SingleFieldSingleValueLuceneParameter(java.lang.String name)

Method Detail

getQuery

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

Specified by:

getQuery in class 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

getXmlElementName

protected java.lang.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. For those parameters, you can override the element name here).

Returns:

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

isValid

public boolean isValid()

Specified by:

isValid in interface SearchParameter

Specified by:

isValid in class AbstractSearchParameter