com.attivio.sdk.search.query

Class Query

java.lang.Object

com.attivio.sdk.search.query.Query

All Implemented Interfaces:

QueryParameters, LocaleAware, Serializable, Cloneable

Direct Known Subclasses:

AccessControlQuery, BooleanAndQuery, BooleanNotQuery, BooleanOrQuery, BoostQuery, CompositeJoinQuery, FacetQuery, FieldExpressionQuery, FilterQuery, GeoDistanceQuery, GraphQuery, JoinQuery, PhraseQuery, QueryPlugin, QueryString, SavedFilter, ShapeQuery, SubQuery

public abstract class Query
extends Object
implements LocaleAware, QueryParameters

Abstract base class for queries.

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 int	boost
protected static BaseTypesMap<String,Object>	DEFAULT_PARAMETERS Map of default values for query parameters
protected static Set<String>	IGNORE_PARAMETERS Set of parameters to ignore for equality checks.
protected QueryComponent.Parameter	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

Modifier	Constructor and Description
protected	Query()

Method Summary

Modifier and Type	Method and Description
protected static void	addParameter(StringBuilder buffer, String name, Object value) Add "\"name\"=\"value\"" to buffer.
protected void	addParameters(StringBuilder buffer, boolean compact) Append all parameters for this query to buffer.
protected static void	appendParameter(StringBuilder buffer, String name, Object value) Add ", \"name\"=\"value\"" to buffer.
protected void	appendParameters(StringBuilder buffer, boolean compact) Append all parameters to buffer.
Query	clone() Returns a deep copy of this Query instance.
boolean	containsParameter(String name) Returns true if the specified parameter exists for this Query object.
boolean	containsParameters()
boolean	equals(Object other)
protected boolean	equals(Object other, Map<String,Object> defaults, Set<String> ignore) Checks whether query equals this Query object.
boolean	equals(Query other, Map<String,Object> defaults, String... ignore) Checks whether query equals this Query object.
protected static boolean	equals(Query a, Query b, Map<String,Object> defaults, Set<String> ignore) Query equality method for 2 arbitrary query objects (null aware).
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() .
int	getBoost() Gets the boost value for this Query.
Query	getFirstNode(QueryHandler selector) Get the first query in the tree that has parameter set to value.
protected Object	getInternalParameter(String name)
Locale	getLocale() Gets the local associated with this object or null if not set.
protected void	getNodes(List<Query> nodes, QueryHandler selector) Internal method to collect all nodes that have parameter set to value.
Iterable<Query>	getNodes(QueryHandler selector) Get all nodes in the query tree 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.
String	getQueryLanguage() Get the query language for this query.
String	getQueryString() Get the query string used to create this query.
int	hashCode()
protected static StringBuilder	indent(StringBuilder buffer, int indent) Support method to indent a "line" in a StringBuilder.
protected boolean	isCompactParameter(String key, Object value) Check if parameter should be included in compact representation.
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.
protected void	prettyFormatParameters(StringBuilder buffer, int indent)
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	setBoost(int value) Sets the boost for this Query.
void	setBoost(String value) Sets the boost for this Query.
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	setLocale(Locale locale) Sets the local associated with this object.
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.
void	setParameters(Query query) Copies all parameters from another query into this Query instance.
void	setParameters(Query query, boolean override) Copies all parameters from another query into this Query instance.
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.
String	toString()
String	toString(boolean compact)
protected abstract void	toString(StringBuilder buffer, boolean compact) Write the String representation of this query to buffer.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PARAMETERS

protected static final BaseTypesMap<String,Object> DEFAULT_PARAMETERS

Map of default values for query parameters

IGNORE_PARAMETERS

protected static final Set<String> IGNORE_PARAMETERS

Set of parameters to ignore for equality checks.

boost

protected int boost

parameters

protected QueryComponent.Parameter parameters

Constructor Detail

Query

protected Query()

Method Detail

setParameters

public void setParameters(Query query)

Copies all parameters from another query into this Query instance.

Parameters:

query - the Query to copy parameters from

setParameters

public void setParameters(Query query,
                          boolean override)

Copies all parameters from another query into this Query instance.

Parameters:

query - the Query to copy parameters from.

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

isCompactParameter

protected boolean isCompactParameter(String key,
                                     Object value)

Check if parameter should be included in compact representation.

containsParameters

public boolean containsParameters()

setParameter

public void setParameter(String name,
                         Object value)

getInternalParameter

protected Object getInternalParameter(String name)

addParameters

protected void addParameters(StringBuilder buffer,
                             boolean compact)

Append all parameters for this query to buffer.

appendParameters

protected void appendParameters(StringBuilder buffer,
                                boolean compact)

Append all parameters to buffer.

prettyFormatParameters

protected void prettyFormatParameters(StringBuilder buffer,
                                      int indent)

getBoost

public int getBoost()

Gets the boost value for this Query.

setBoost

public void setBoost(int value)

Sets the boost for this Query.

setBoost

public void setBoost(String value)
              throws IllegalArgumentException

Sets the boost for this Query.

Parameters:

value - the boost to set

Throws:

IllegalArgumentException - if value is not parsable as a number

getLocale

public Locale getLocale()

Gets the local associated with this object or null if not set.

Specified by:

getLocale in interface LocaleAware

setLocale

public void setLocale(Locale locale)

Sets the local associated with this object.

Specified by:

setLocale in interface LocaleAware

getQueryString

public String getQueryString()

Get the query string used to create this query.

NOTE: this may be null if the query object was created manually.

See Also:

QueryParameters.QUERY

getQueryLanguage

public String getQueryLanguage()

Get the query language for this query.

NOTE: this may not be meaningful in the event that this query was programatically created.

rewrite

public Query rewrite(QueryHandler handler)

Recursively rewrite this query using handler.

rewriteChildren

public void rewriteChildren(QueryHandler handler)

Rewrite child nodes using handler.

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.

Returns:

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

getNodes

public final Iterable<Query> getNodes(QueryHandler selector)

Get all nodes in the query tree that have parameter set to value.

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

getNodes

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

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

optimize

public Query optimize()

Optimizes this query object, removing unnecessary levels of expressions.

Returns:

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

equals

public final boolean equals(Object other)

Overrides:

equals in class Object

equals

public final boolean equals(Query other,
                            Map<String,Object> defaults,
                            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 - varargs of query parameter names to ignore when checking for equality

Returns:

true if other is equal to this Query

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 Query clone()

Returns a deep copy of this Query instance.

NOTE: values for parameters are shallow copied.

Returns:

a copy of this Query.

equals

protected static boolean equals(Query a,
                                Query b,
                                Map<String,Object> defaults,
                                Set<String> ignore)

Query equality method for 2 arbitrary query objects (null aware).

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)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

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)

toString

protected abstract void toString(StringBuilder buffer,
                                 boolean compact)

Write the String representation of this query to buffer.

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.

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

indent

protected static StringBuilder indent(StringBuilder buffer,
                                      int indent)

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