com.attivio.sdk.search.query

Class JoinClause

java.lang.Object

com.attivio.sdk.search.query.JoinClause

All Implemented Interfaces:

Serializable, Cloneable

public final class JoinClause
extends Object

Represents a clause to join to the primary query. The field(s) used to join this clause to the primary query will be resolved as follows:

• If a PrimaryKey and a ForeignKey is set on this clause, the join will be on PrimaryKey = ForeignKey
• If only a PrimaryKey is set on this clause, the join will be on PrimaryKey = PrimaryKey

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
static boolean	DEFAULT_FACET Default value for AbstractJoinClause.isFacet().
protected QueryComponent.Parameter	parameters

Constructor Summary

Constructors

Constructor and Description
JoinClause() Constructor
JoinClause(Query query, JoinMode mode) Constructor
JoinClause(Query query, JoinMode mode, String primaryKey, String foreignKey) Constructor

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.
JoinClause	clone()
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.
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() .
String	getAlias() Get the name for this clause.
int	getBoost() Gets the boost for this clause.
String	getForeignKey() Get the field that is the foreign key for this join.
protected Object	getInternalParameter(String name)
FieldExpression	getJoinConstraint() (Experimental) Get the join constraint.
FieldExpression	getJoinExpression() Get the compiled FieldExpression that will be used to evaluate the join criteria.
int	getMinimum() Get the minimum number of child documents a parent document must have.
JoinMode	getMode() Gets the mode for joining.
Sort	getOrder() Get the order for child documents.
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	getPrimaryKey() Get the field that is the primary key for this join.
Query	getQuery() Gets the query for this clause.
int	getRollupLimit() Get the maximum number of child documents to collect for this clause per parent document.
int	getRollupLimit(int defaultValue) Get the maximum number of child documents to collect for this clause per parent document.
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.
boolean	isFacet() true if documents for this clause should be used in facet document collection.
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) Support prettyFormat on JoinQuery.
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.
void	setAlias(String value) Set the name for this clause.
protected void	setBooleanParameter(String key, Object value) Internal method for setting a boolean parameter.
void	setBoost(int value) Sets the boost for this clause.
protected void	setEnumParameter(String key, Object value, String... enumValues) Internal method for setting an object parameter.
void	setFacet(boolean value) Set if documents for this clause should be used in facet document collection.
void	setForeignKey(String value) Set the field that is the foreign key for this join.
protected void	setIntegerParameter(String key, Object value) Internal method for setting an integer parameter.
void	setJoinConstraint(FieldExpression value) (Experimental) Set the join constraint.
void	setMinimum(int value) Set the minimum number of child documents a parent document must have.
void	setMode(JoinMode mode) Sets the mode for joining.
void	setOrder(Sort value) Set the order for child documents.
void	setParameter(String parameter, 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	setPrimaryKey(String value) Set the field that is the primary key for this join.
void	setQuery(Query value) Sets the query for this clause.
void	setRollupLimit(int value) Set the maximum number of child documents to collect for this clause per parent 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 java.lang.Object

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

Field Detail

DEFAULT_FACET

public static final boolean DEFAULT_FACET

Default value for AbstractJoinClause.isFacet().

See Also:

Constant Field Values

parameters

protected QueryComponent.Parameter parameters

Constructor Detail

JoinClause

public JoinClause()

Constructor

JoinClause

public JoinClause(Query query,
                  JoinMode mode)

Constructor

JoinClause

public JoinClause(Query query,
                  JoinMode mode,
                  String primaryKey,
                  String foreignKey)

Constructor

Method Detail

getOrder

public Sort getOrder()

Get the order for child documents.

setOrder

public void setOrder(Sort value)

Set the order for child documents.

getMode

public JoinMode getMode()

Gets the mode for joining.

setMode

public void setMode(JoinMode mode)

Sets the mode for joining.

getMinimum

public int getMinimum()

Get the minimum number of child documents a parent document must have.

NOTE: this only applies to JoinMode.INNER join clauses.

setMinimum

public void setMinimum(int value)

Set the minimum number of child documents a parent document must have.

NOTE: this only applies to JoinMode.INNER join clauses.

getJoinExpression

public FieldExpression getJoinExpression()

Get the compiled FieldExpression that will be used to evaluate the join criteria.

getJoinConstraint

public FieldExpression getJoinConstraint()

(Experimental) Get the join constraint.

setJoinConstraint

public void setJoinConstraint(FieldExpression value)

(Experimental) Set the join constraint.

getPrimaryKey

public String getPrimaryKey()

Get the field that is the primary key for this join.

setPrimaryKey

public void setPrimaryKey(String value)

Set the field that is the primary key for this join.

getForeignKey

public String getForeignKey()

Get the field that is the foreign key for this join.

setForeignKey

public void setForeignKey(String value)

Set the field that is the foreign key for this join.

setParameter

public void setParameter(String parameter,
                         Object value)

hashCode

public int hashCode()

clone

public JoinClause clone()

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

appendParameters

protected void appendParameters(StringBuilder buffer,
                                boolean compact)

Append all parameters to buffer.

prettyFormatParameters

protected void prettyFormatParameters(StringBuilder buffer,
                                      int indent)

getAlias

public String getAlias()

Get the name for this clause.

This name can be used for selecting fields for child documents generated by this clause. Use ClauseContext to identify fields that should be returned only for this clause.

setAlias

public void setAlias(String value)

Set the name for this clause.

getQuery

public Query getQuery()

Gets the query for this clause.

setQuery

public void setQuery(Query value)

Sets the query for this clause.

getRollupLimit

public int getRollupLimit()

Get the maximum number of child documents to collect for this clause per parent document.

getRollupLimit

public int getRollupLimit(int defaultValue)

Get the maximum number of child documents to collect for this clause per parent document.

setRollupLimit

public void setRollupLimit(int value)

Set the maximum number of child documents to collect for this clause per parent document.

isFacet

public boolean isFacet()

true if documents for this clause should be used in facet document collection.

setFacet

public void setFacet(boolean value)

Set if documents for this clause should be used in facet document collection.

getBoost

public int getBoost()

Gets the boost for this clause.

setBoost

public void setBoost(int value)

Sets the boost for this clause.

toString

protected void toString(StringBuilder buffer,
                        boolean compact)

Write the String representation of this query to buffer.

equals

public final boolean equals(Object other)

Overrides:

equals in class Object

prettyFormat

protected void prettyFormat(StringBuilder buffer,
                            int indent)

Support prettyFormat on JoinQuery.

Parameters:

buffer - buffer to write pretty formated parameters to.

indent - the indentation level

parameters

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

Get an iterator for returning all custom parameters.

containsParameters

public boolean containsParameters()

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)

getInternalParameter

protected Object getInternalParameter(String name)

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)

isCompactParameter

protected boolean isCompactParameter(String key,
                                     Object value)

Check if parameter should be included in compact representation.

addParameters

protected void addParameters(StringBuilder buffer,
                             boolean compact)

Append all parameters for this query to buffer.

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.