com.ibm.ram.client
Class RAMQueryBuilder

java.lang.Object
  extended by com.ibm.ram.common.data.SearchQuery
      extended by com.ibm.ram.client.RAMQueryBuilder
Direct Known Subclasses:
RAMAssetQueryBuilder

public abstract class RAMQueryBuilder
extends SearchQuery

Constructs a search query

Since:
7.1
Author:
kbauer

Field Summary
static java.lang.String AND_OPERATOR
          Use and boolean logic on query parts.
static java.lang.String OR_OPERATOR
          Use or boolean logic on query parts.
protected  java.lang.String QUERY_FIELD_TEXT
           
static int UNLIMITED_RESULTS
          Allow unlimited search results
 
Fields inherited from class com.ibm.ram.common.data.SearchQuery
SEARCH_WITHIN_ARTIFACTS_FLAG, SEARCH_WITHIN_FORUMS_FLAG, SYNCHRONIZED_SEARCH_FLAG
 
Constructor Summary
RAMQueryBuilder(RAMSession session)
          Constructor
 
Method Summary
protected abstract  void invalidateQuery()
           
 boolean isMatchAnyQueryField()
          By default all the query field are anded together (Only results that match every field are returned).
 void setMatchAnyField(boolean matchAnyQueryField)
          By default all the query field are anded together (Only results that match every field are returned).
 void setQueryString(java.lang.String queryString)
           
 
Methods inherited from class com.ibm.ram.common.data.SearchQuery
escapeLuceneCharacters, getMaxResults, getQueryString, getResultsStartIndex, getSearchModes, getSortByField, isSortAscending, isThisSearchRecorded, setMaxResults, setResultsStartIndex, setSearchModes, setSortAscending, setSortByField, setThisSearchRecorded
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

QUERY_FIELD_TEXT

protected java.lang.String QUERY_FIELD_TEXT

UNLIMITED_RESULTS

public static final int UNLIMITED_RESULTS
Allow unlimited search results

Since:
7.1
See Also:
Constant Field Values

OR_OPERATOR

public static final java.lang.String OR_OPERATOR
Use or boolean logic on query parts.

Since:
7.1
See Also:
Constant Field Values

AND_OPERATOR

public static final java.lang.String AND_OPERATOR
Use and boolean logic on query parts.

Since:
7.1
See Also:
Constant Field Values
Constructor Detail

RAMQueryBuilder

public RAMQueryBuilder(RAMSession session)
Constructor

Parameters:
session -
Since:
7.1
Method Detail

isMatchAnyQueryField

public boolean isMatchAnyQueryField()
By default all the query field are anded together (Only results that match every field are returned). If this returns true they will be ored together instead (Return all results that match any query field.

Since:
7.1

setMatchAnyField

public void setMatchAnyField(boolean matchAnyQueryField)
By default all the query field are anded together (Only results that match every field are returned). If this is set to true they will be ored together instead (Return all results that match any query field.

Since:
7.1

invalidateQuery

protected abstract void invalidateQuery()

setQueryString

public void setQueryString(java.lang.String queryString)
Overrides:
setQueryString in class SearchQuery
Parameters:
queryString - The queryString to set.