com.attivio.sdk.search.query

Class CompositeJoinQuery

java.lang.Object

com.attivio.sdk.search.query.Query

com.attivio.sdk.search.query.CompositeJoinQuery

All Implemented Interfaces:

QueryParameters, LocaleAware, Serializable, Cloneable

public final class CompositeJoinQuery
extends Query

Join query for querying "composite" document that consists of multiple documents.

A composite document consists of a root document and child documents from one or more clauses. The search query will be evaluated against these documents as if they were a single document. For instance, for a search query of AND(a, b), the composite document will match if "a" is in the root and/or child document and "b" is in the root and/or child document.

NOTE: the "from" query should specify a one to many or a one to one join to the clauses.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CompositeJoinQuery.Clause Clause for a CompositeJoinQuery.
protected static class	QueryComponent.Parameter Linked list of parameters.

Field Summary

Fields

Modifier and Type	Field and Description
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
CompositeJoinQuery()
CompositeJoinQuery(Query query)
CompositeJoinQuery(Query query, Query from, String field)

Method Summary

Modifier and Type	Method and Description
CompositeJoinQuery.Clause	addClause(JoinMode mode, Query query) Add a clause for selecting child documents.
protected static void	addParameter(StringBuilder buffer, String name, Object value) Add "\"name\"=\"value\"" to buffer.
protected static void	appendParameter(StringBuilder buffer, String name, Object value) Add ", \"name\"=\"value\"" to buffer.
CompositeJoinQuery	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() .
List<CompositeJoinQuery.Clause>	getClauses() Get clauses for selecting child documents.
String	getField() Get the key field for joining root documents to child documents.
Query	getFirstNode(QueryHandler selector) Get the first query in the tree that has parameter set to value.
Query	getFromQuery() Get the query for selecting root documents.
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.
Query	getQuery() Get the search query to evaluate against a composite document.
int	hashCode()
protected static StringBuilder	indent(StringBuilder buffer, int indent) Support method to indent a "line" in a StringBuilder.
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 selector) Recursively rewrite this query using handler.
void	rewriteChildren(QueryHandler selector) Rewrite child nodes using handler.
protected void	setBooleanParameter(String key, Object value) Internal method for setting a boolean parameter.
void	setClauses(CompositeJoinQuery.Clause... value) Set clauses for selecting child documents.
void	setClauses(List<CompositeJoinQuery.Clause> value) Set clauses for selecting child documents.
protected void	setEnumParameter(String key, Object value, String... enumValues) Internal method for setting an object parameter.
void	setField(String value) Set the key field for joining root documents to child documents.
void	setFromQuery(Query value) Set the query for selecting root documents.
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.
void	setQuery(Query value) Set the search query to evaluate against a composite document.
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 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

Field Detail

parameters

protected QueryComponent.Parameter parameters

Constructor Detail

CompositeJoinQuery

public CompositeJoinQuery()

CompositeJoinQuery

public CompositeJoinQuery(Query query)

CompositeJoinQuery

public CompositeJoinQuery(Query query,
                          Query from,
                          String field)

Method Detail

getField

public String getField()

Get the key field for joining root documents to child documents.

setField

public void setField(String value)

Set the key field for joining root documents to child documents.

getQuery

public Query getQuery()

Get the search query to evaluate against a composite document.

setQuery

public void setQuery(Query value)

Set the search query to evaluate against a composite document.

getFromQuery

public Query getFromQuery()

Get the query for selecting root documents.

setFromQuery

public void setFromQuery(Query value)

Set the query for selecting root documents.

addClause

public CompositeJoinQuery.Clause addClause(JoinMode mode,
                                           Query query)

Add a clause for selecting child documents.

getClauses

public List<CompositeJoinQuery.Clause> getClauses()

Get clauses for selecting child documents.

setClauses

public void setClauses(List<CompositeJoinQuery.Clause> value)

Set clauses for selecting child documents.

setClauses

public void setClauses(CompositeJoinQuery.Clause... value)

Set clauses for selecting child documents.

setParameter

public void setParameter(String name,
                         Object value)

Overrides:

setParameter 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

rewrite

public Query rewrite(QueryHandler selector)

Recursively rewrite this query using handler.

Overrides:

rewrite in class Query

rewriteChildren

public void rewriteChildren(QueryHandler selector)

Rewrite child nodes using handler.

Overrides:

rewriteChildren in class Query

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

hashCode

public int hashCode()

equals

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

Checks whether query equals this Query object.

Overrides:

equals in class Query

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

toString

protected void toString(StringBuilder buffer,
                        boolean compact)

Write the String representation of this query to buffer.

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

clone

public CompositeJoinQuery clone()

Returns a deep copy of this Query instance.

NOTE: values for parameters are shallow copied.

Overrides:

clone in class Query

Returns:

a copy of this 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.