com.atlassian.jira.issue.search.parameters
Class AbstractSearchParameter

java.lang.Object
  com.atlassian.jira.issue.search.parameters.AbstractSearchParameter

All Implemented Interfaces:

SearchParameter

Direct Known Subclasses:

AbstractLuceneParameter, FilterParameter, OfbizParameter

public abstract class AbstractSearchParameter

extends Object

implements SearchParameter

Field Summary

protected String	JIRA_ENCODING
protected org.apache.log4j.Category	log
(package private) String	name
protected List	values

Constructor Summary

AbstractSearchParameter()

AbstractSearchParameter(String name)

Method Summary

void	addValue(Object value)
protected void	clearValues()
boolean	equals(Object o)
String	getName() Get issue field name.
String	getQueryString()
protected String	getQueryStringPrefix() Query parameter name, suitable for inclusion in URL.
List	getValues()
abstract electric.xml.Element	getXml() Return an XML representation of this search parameter.
int	hashCode()
abstract boolean	isValid()
void	setName(String name) Specify issue field name to limit search by.
void	setXml(electric.xml.Element el) Initialise this search parameter using an XML element.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final org.apache.log4j.Category log

name

String name

values

protected List values

JIRA_ENCODING

protected final String JIRA_ENCODING

Constructor Detail

AbstractSearchParameter

public AbstractSearchParameter()

AbstractSearchParameter

public AbstractSearchParameter(String name)

Method Detail

getXml

public abstract electric.xml.Element getXml()

Description copied from interface: SearchParameter

Return an XML representation of this search parameter.

Specified by:

getXml in interface SearchParameter

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

isValid

public abstract boolean isValid()

Specified by:

isValid in interface SearchParameter

getQueryString

public String getQueryString()

Specified by:

getQueryString in interface SearchParameter

getQueryStringPrefix

protected String getQueryStringPrefix()

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.

addValue

public void addValue(Object value)

Specified by:

addValue in interface SearchParameter

getValues

public List getValues()

Specified by:

getValues in interface SearchParameter

clearValues

protected void clearValues()

getName

public String getName()

Description copied from interface: SearchParameter

Get issue field name.

Specified by:

getName in interface SearchParameter

setName

public void setName(String name)

Description copied from interface: SearchParameter

Specify issue field name to limit search by. Either a predefined name (from IssueFieldConstants, or Field.getId().

Specified by:

setName in interface SearchParameter

equals

public boolean equals(Object o)

hashCode

public int hashCode()

toString

public String toString()