com.attivio.sdk.search.query

Class BooleanAndQuery

java.lang.Object

com.attivio.sdk.search.query.Query

com.attivio.sdk.search.query.BooleanAndQuery

All Implemented Interfaces:

QueryParameters, LocaleAware, Serializable, Cloneable, Iterable<Query>

public final class BooleanAndQuery
extends Query

A BooleanAndQuery requires all sub queries must match.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	QueryComponent.Parameter Linked list of parameters.

Field Summary

Fields

Modifier and Type	Field and Description
protected LinkedList<Query>	clauses List of all clauses for this expression
protected QueryComponent.Parameter	parameters

Fields inherited from class com.attivio.sdk.search.query.Query

boost, DEFAULT_PARAMETERS, IGNORE_PARAMETERS

Fields inherited from interface com.attivio.sdk.search.query.QueryParameters

ACL, ACRONYMS, ACRONYMS_EXPANDED, ACRONYMS_ORIGINAL, ALIAS, ALLOW, ANONYMOUS, BOOST, BOOST_FREQUENCY, BOOST_POSITION, BOOST_PROXIMITY, COMPLETENESS_BOOST, DEFAULT_BOOST, DEFAULT_DEPTH, DEFAULT_FIELD_NORMS, DEFAULT_FUZZY_MAX_TERMS, DEFAULT_MINIMUM, DEFAULT_QUOTED, DEFAULT_RECURSIVE, DEFAULT_ROLLUP_LIMIT, DEFAULT_SCORE_DEPTH, DEFAULT_SCORE_EXPLAIN, DEFAULT_SEARCH_FIELD, DEFAULT_SIMILARITY, DEFAULT_SPAN, DENY, DEPTH, DISABLE_COORD, DISTANCE, FACET, FIELD_NORMS, FUZZY_MAX_TERMS, LANGUAGE, LOWER, METHOD, MINIMUM, ON, ORDER, QUERY, QUERY_LANGUAGE, QUOTED, RECURSIVE, RELEVANCY_MODEL, ROLLUP, SCORE_DEPTH, SCORE_EXPLAIN, SCORE_FUNCTIONS, SCORE_MODE, SIMILARITY, SIMILARITY_PREFIX, SOUNDS_LIKE, SPAN, SPELLCHECK_CORRECTED, SPELLCHECK_EXPANDED, SPELLCHECK_MODE, SPELLCHECK_ORIGINAL, SPELLCHECK_SUGGESTIONS, STOPWORDS, SYNONYMS, SYNONYMS_EXPANDED, SYNONYMS_ORIGINAL, TOKENIZE, UNSECURED_ZONES, UPPER, WARNING, WILDCARD, XON

Constructor Summary

Constructors

Constructor and Description
BooleanAndQuery()
BooleanAndQuery(List<? extends Query> clauses) Construct a new BooleanAndQuery.
BooleanAndQuery(Query... clauses) Construct a new BooleanAndQuery.
BooleanAndQuery(Query a, Query b) Construct a new BooleanAndQuery.
BooleanAndQuery(String... terms) Construct a new BooleanAndQuery.
BooleanAndQuery(String a, String b) Construct a new BooleanAndQuery.

Method Summary

Modifier and Type	Method and Description
void	add(List<? extends Query> args) Add queries.
void	add(Query... args) Add queries.
void	add(Query query) Add query.
void	add(String... terms) Add search terms.
void	add(String term) Add search term.
void	addFirst(Query query) Add query as the first subquery.
protected static void	addParameter(StringBuilder buffer, String name, Object value) Add "\"name\"=\"value\"" to buffer.
BooleanAndQuery	append(Query... args) Adds required sub queries.
BooleanAndQuery	append(String... terms) Adds required search terms.
protected static void	appendParameter(StringBuilder buffer, String name, Object value) Add ", \"name\"=\"value\"" to buffer.
BooleanAndQuery	clone() Returns a deep copy of this Query instance.
boolean	containsParameter(String name) Returns true if the specified parameter exists for this Query object.
protected boolean	equals(Object other, Map<String,Object> defaults, Set<String> ignore) Checks whether query equals this Query object.
protected static void	escape(StringBuilder buffer, Object value)
protected void	escape(StringBuilder buffer, String value, boolean quote) Helper method to escape a string for toString() .
Query[]	getClauses()
Query	getFirstNode(QueryHandler selector) Get the first query in the tree that has parameter set to value.
protected void	getNodes(List<Query> nodes, QueryHandler selector) Internal method to collect all nodes that have parameter set to value.
Object	getParameter(String name) Returns a named property for this Query object.
boolean	getParameter(String name, boolean defaultValue) Gets a boolean parameter.
double	getParameter(String name, double defaultValue) Gets a double parameter.
float	getParameter(String name, float defaultValue) Gets a float parameter.
int	getParameter(String name, int defaultValue) Gets an integer parameter.
long	getParameter(String name, long defaultValue) Gets a long parameter.
Object	getParameter(String name, Object defaultValue) Gets a parameter.
String	getParameter(String name, String defaultValue) Gets a String parameter.
int	hashCode()
protected static StringBuilder	indent(StringBuilder buffer, int indent) Support method to indent a "line" in a StringBuilder.
Iterator<Query>	iterator() Gets an iterator for iterating over sub queries.
ListIterator<Query>	listIterator() Gets a list iterator for iterating over sub queries.
Query	optimize() Optimizes this query object, removing unnecessary levels of expressions.
Iterator<Map.Entry<String,Object>>	parameters() Get an iterator for returning all custom parameters.
protected static int	parseIntParameter(Object value, int defaultValue)
String	prettyFormat() Returns a hierarchical representation of this query as a string.
protected void	prettyFormat(StringBuilder buffer, int indent) Pretty format all parameters for this Query instance.
void	prettyPrint() Sends a hierarchical representation of this query to standard out.
void	prettyPrint(PrintStream out) Sends a hierarchical representation of this query specified PrintStream.
Object	removeParameter(String name) Remove the value for a parameter for this Query object.
Query	rewrite(QueryHandler handler) Recursively rewrite this query using handler.
void	rewriteChildren(QueryHandler handler) Rewrite child nodes using handler.
protected void	setBooleanParameter(String key, Object value) Internal method for setting a boolean parameter.
void	setClauses(List<Query> value)
void	setClauses(Query... value)
protected void	setEnumParameter(String key, Object value, String... enumValues) Internal method for setting an object parameter.
protected void	setIntegerParameter(String key, Object value) Internal method for setting an integer parameter.
void	setParameter(String name, Object value)
void	setParameters(Map<String,Object> value)
void	setParameters(Map<String,Object> params, boolean override) Copies parameters from a Map into this Query.
protected void	setRollupParameter(String key, Object value)
protected void	setStringParameter(String key, Object value) Internal method for setting a string parameter.
protected void	setUnsignedParameter(String key, Object value) Internal method for setting an integer parameter.
int	size() Gets the number of sub queries.
String	toString()
String	toString(boolean compact)
protected void	toString(StringBuilder buffer, boolean compact) Write the String representation of this query to buffer.

Methods inherited from class com.attivio.sdk.search.query.Query

addParameters, appendParameters, containsParameters, equals, equals, equals, getBoost, getInternalParameter, getLocale, getNodes, getQueryLanguage, getQueryString, isCompactParameter, prettyFormatParameters, setBoost, setBoost, setLocale, setParameters, setParameters

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

clauses

protected LinkedList<Query> clauses

List of all clauses for this expression

parameters

protected QueryComponent.Parameter parameters

Constructor Detail

BooleanAndQuery

public BooleanAndQuery()

BooleanAndQuery

public BooleanAndQuery(Query a,
                       Query b)

Construct a new BooleanAndQuery.

BooleanAndQuery

public BooleanAndQuery(Query... clauses)

Construct a new BooleanAndQuery.

Parameters:

clauses - the clauses to add to this BooleanAndQuery

BooleanAndQuery

public BooleanAndQuery(List<? extends Query> clauses)

Construct a new BooleanAndQuery.

Parameters:

clauses - the clauses to add to this BooleanAndQuery

BooleanAndQuery

public BooleanAndQuery(String a,
                       String b)

Construct a new BooleanAndQuery.

BooleanAndQuery

public BooleanAndQuery(String... terms)

Construct a new BooleanAndQuery.

Parameters:

terms - the search terms to add to this BooleanAndQuery

Method Detail

append

public BooleanAndQuery append(Query... args)

Adds required sub queries.

Parameters:

args - the sub queries to add.

Returns:

this (for call chaining)

append

public BooleanAndQuery append(String... terms)

Adds required search terms.

Parameters:

terms - the search terms to add.

Returns:

this (for call chaining)

prettyFormat

protected void prettyFormat(StringBuilder buffer,
                            int indent)

Pretty format all parameters for this Query instance.

Parameters:

buffer - buffer to write pretty formated parameters to.

indent - the indentation level

toString

protected void toString(StringBuilder buffer,
                        boolean compact)

Write the String representation of this query to buffer.

hashCode

public int hashCode()

equals

protected boolean equals(Object other,
                         Map<String,Object> defaults,
                         Set<String> ignore)

Checks whether query equals this Query object.

Parameters:

other - the query to compare to

defaults - map of default values for query parameters

ignore - set of query parameters to ignore during equality check.

Returns:

true if other is equal to this Query

clone

public BooleanAndQuery clone()

Returns a deep copy of this Query instance.

NOTE: values for parameters are shallow copied.

Returns:

a copy of this Query.

setParameter

public void setParameter(String name,
                         Object value)

Overrides:

setParameter in class Query

iterator

public Iterator<Query> iterator()

Gets an iterator for iterating over sub queries.

Specified by:

iterator in interface Iterable<Query>

listIterator

public ListIterator<Query> listIterator()

Gets a list iterator for iterating over sub queries.

getClauses

public Query[] getClauses()

setClauses

public void setClauses(Query... value)

setClauses

public void setClauses(List<Query> value)

size

public int size()

Gets the number of sub queries.

add

public void add(Query... args)

Add queries.

add

public void add(List<? extends Query> args)

Add queries.

add

public void add(String... terms)

Add search terms.

addFirst

public void addFirst(Query query)

Add query as the first subquery.

add

public void add(Query query)

Add query.

add

public void add(String term)

Add search term.

optimize

public Query optimize()

Optimizes this query object, removing unnecessary levels of expressions.

Overrides:

optimize in class Query

Returns:

an optimized form of this Query, or null if this Query is a no-op

rewrite

public Query rewrite(QueryHandler handler)

Recursively rewrite this query using handler.

Overrides:

rewrite in class Query

rewriteChildren

public void rewriteChildren(QueryHandler handler)

Rewrite child nodes using handler.

Overrides:

rewriteChildren in class Query

getFirstNode

public Query getFirstNode(QueryHandler selector)

Get the first query in the tree that has parameter set to value.

WARNING: this is an experimental API and may change in the near future.

Overrides:

getFirstNode in class Query

Returns:

the first query in the query tree that matches selector, or null if no match found.

getNodes

protected void getNodes(List<Query> nodes,
                        QueryHandler selector)

Internal method to collect all nodes that have parameter set to value.

Overrides:

getNodes in class Query

parameters

public Iterator<Map.Entry<String,Object>> parameters()

Get an iterator for returning all custom parameters.

containsParameter

public boolean containsParameter(String name)

Returns true if the specified parameter exists for this Query object.

Parameters:

name - parameter name.

Returns:

true if the specified parameter exists.

getParameter

public final Object getParameter(String name)

Returns a named property for this Query object.

Parameters:

name - parameter name.

Returns:

the value for the named property (or null if not found)

getParameter

public final String getParameter(String name,
                                 String defaultValue)

Gets a String parameter.

Parameters:

name - parameter name.

defaultValue - default value to return if not set.

getParameter

public final boolean getParameter(String name,
                                  boolean defaultValue)

Gets a boolean parameter.

Parameters:

name - parameter name.

defaultValue - default value to return if not set.

getParameter

public final int getParameter(String name,
                              int defaultValue)

Gets an integer parameter.

Parameters:

name - parameter name.

defaultValue - default value to return if not set.

getParameter

public final long getParameter(String name,
                               long defaultValue)

Gets a long parameter.

Parameters:

name - parameter name.

defaultValue - default value to return if not set.

getParameter

public final float getParameter(String name,
                                float defaultValue)

Gets a float parameter.

Parameters:

name - parameter name.

defaultValue - default value to return if not set.

getParameter

public final double getParameter(String name,
                                 double defaultValue)

Gets a double parameter.

Parameters:

name - parameter name.

defaultValue - default value to return if not set.

getParameter

public Object getParameter(String name,
                           Object defaultValue)

Gets a parameter.

Parameters:

name - name of parameter to return.

defaultValue - default value to return if not set.

setParameters

public final void setParameters(Map<String,Object> value)

setParameters

public void setParameters(Map<String,Object> params,
                          boolean override)

Copies parameters from a Map into this Query.

Parameters:

params - the parameters to copy into this Query instance.

override - indicates if parameters from params should overwrite existing parameters in this Query

parseIntParameter

protected static int parseIntParameter(Object value,
                                       int defaultValue)

removeParameter

public Object removeParameter(String name)

Remove the value for a parameter for this Query object.

Parameters:

name - the parameter to remove.

setEnumParameter

protected final void setEnumParameter(String key,
                                      Object value,
                                      String... enumValues)

Internal method for setting an object parameter.

NOTE: enumValues must contain lower case strings.

setStringParameter

protected final void setStringParameter(String key,
                                        Object value)

Internal method for setting a string parameter.

setIntegerParameter

protected final void setIntegerParameter(String key,
                                         Object value)

Internal method for setting an integer parameter.

setUnsignedParameter

protected final void setUnsignedParameter(String key,
                                          Object value)

Internal method for setting an integer parameter.

setBooleanParameter

protected final void setBooleanParameter(String key,
                                         Object value)

Internal method for setting a boolean parameter.

setRollupParameter

protected final void setRollupParameter(String key,
                                        Object value)

appendParameter

protected static void appendParameter(StringBuilder buffer,
                                      String name,
                                      Object value)

Add ", \"name\"=\"value\"" to buffer.

addParameter

protected static void addParameter(StringBuilder buffer,
                                   String name,
                                   Object value)

Add "\"name\"=\"value\"" to buffer.

escape

protected static void escape(StringBuilder buffer,
                             Object value)

escape

protected void escape(StringBuilder buffer,
                      String value,
                      boolean quote)

Helper method to escape a string for toString() .

Parameters:

buffer - buffer to write escaped value to

value - the value to escape

quote - if true, escaped value will be wrapped in double quotes.

toString

public final String toString()

Overrides:

toString in class Object

toString

public final String toString(boolean compact)

prettyPrint

public final void prettyPrint()

Sends a hierarchical representation of this query to standard out.

prettyPrint

public final void prettyPrint(PrintStream out)

Sends a hierarchical representation of this query specified PrintStream.

Parameters:

out - stream to output query representation to

prettyFormat

public final String prettyFormat()

Returns a hierarchical representation of this query as a string.

indent

protected static StringBuilder indent(StringBuilder buffer,
                                      int indent)

Support method to indent a "line" in a StringBuilder.