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

java.lang.Object
  extended by com.atlassian.jira.issue.search.parameters.AbstractSearchParameter
      extended by com.atlassian.jira.issue.search.parameters.AbstractLuceneParameter
          extended by com.atlassian.jira.issue.search.parameters.lucene.SingleFieldMultiValueLuceneParameter
              extended by com.atlassian.jira.issue.search.parameters.lucene.LongListParameter
                  extended by com.atlassian.jira.issue.search.parameters.lucene.ProjectParameter
All Implemented Interfaces:
CommentParameter, IssueCommentParameter, IssueParameter, LuceneParameter, SearchParameter

public class ProjectParameter
extends LongListParameter
implements IssueCommentParameter

Limits search to issues within a certain project.


Constructor Summary
ProjectParameter()
           
ProjectParameter(Collection projects)
           
ProjectParameter(Collection projects, ProjectManager projectManager)
          Creates a ProjectParameter for the given projects backed by the given projectManager.
ProjectParameter(Long projectId)
           
 
Method Summary
 org.apache.lucene.search.Query getCommentQuery(Set projectIds, User searcher)
          This method should never be called
 org.apache.lucene.search.Query getIssueQuery(org.ofbiz.core.entity.GenericValue project, User searcher)
           
protected  String getQueryStringPrefix()
          Query parameter name, suitable for inclusion in URL.
 boolean isValid()
          Returns true if this parameter is valid, false otherwise.
 
Methods inherited from class com.atlassian.jira.issue.search.parameters.lucene.LongListParameter
getXml, setXml
 
Methods inherited from class com.atlassian.jira.issue.search.parameters.lucene.SingleFieldMultiValueLuceneParameter
constructQueryFromValues, equals, getOccurance, getQuery, hashCode, isAndQuery, setAndQuery
 
Methods inherited from class com.atlassian.jira.issue.search.parameters.AbstractSearchParameter
addValue, clearValues, getName, getQueryString, 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, getQueryString, getValues, setName
 

Constructor Detail

ProjectParameter

public ProjectParameter(Collection projects,
                        ProjectManager projectManager)
Creates a ProjectParameter for the given projects backed by the given projectManager.

Parameters:
projects - a Collection of Project objects, project id Longs or project GenericValues.
projectManager - the ProjectManager used to

ProjectParameter

public ProjectParameter(Collection projects)

ProjectParameter

public ProjectParameter(Long projectId)

ProjectParameter

public ProjectParameter()
Method Detail

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(Set projectIds,
                                                      User searcher)
                                               throws org.apache.lucene.queryParser.ParseException
This method should never be called

Specified by:
getCommentQuery in interface CommentParameter
Throws:
org.apache.lucene.queryParser.ParseException

isValid

public boolean isValid()
Description copied from interface: SearchParameter
Returns true if this parameter is valid, false otherwise.

Specified by:
isValid in interface SearchParameter
Overrides:
isValid in class LongListParameter
Returns:
true if valid, false otherwise

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
Returns:
nothing, always throws UnsupportedOperationException


Copyright © 2002-2007 Atlassian. All Rights Reserved.