Package org.ametys.cms.search.query

Class JoinQuery

java.lang.Object

org.ametys.cms.search.query.JoinQuery

All Implemented Interfaces:

Query

Direct Known Subclasses:

ContentPageQuery, HistoryStepQuery, PageContentQuery, ProgramSearchable.ProgramThroughProgramPartsQuery

public class JoinQuery
extends Object
implements Query

Represents a Query on a joined document.

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.cms.search.query.Query

Query.LogicalOperator, Query.Operator

Field Summary

Fields

Modifier and Type	Field	Description
protected List<JoinKey>	_joinKeys	The join keys (paths and optional nested queries)
protected Query	_subQuery	The field path.

Fields inherited from interface org.ametys.cms.search.query.Query

BOOL_FILTER, BOOL_MUST, BOOL_MUST_NOT, BOOL_SHOULD

Constructor Summary

Constructors

Constructor	Description
JoinQuery(JoinKey... joinKeys)	Build a join query.
JoinQuery(Query subQuery, String... joinPaths)	Build a join query.
JoinQuery(Query subQuery, List<String> joinPaths)	Build a join query.
JoinQuery(Query subQuery, JoinKey... joinKeys)	Build a join query.

Method Summary

Modifier and Type	Method	Description
String	build()	Build the solr query string representing the Query object.
Optional<Object>	buildAsJson()	Build the solr query representing the Query object. The return type may be either String or Map<String, Object> following the Solr JSON Query DSL.
boolean	equals(Object obj)
int	hashCode()
String	toString(int indent)	Gets a representation of this Query, for pretty-printing for logging and debugging purposes

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.ametys.cms.search.query.Query

rewrite

Field Details

_subQuery

protected Query _subQuery

The field path.

_joinKeys

protected List<JoinKey> _joinKeys

The join keys (paths and optional nested queries)

Constructor Details

JoinQuery

public JoinQuery(Query subQuery,
 String... joinPaths)

Build a join query.

Parameters:

subQuery - The sub query.

joinPaths - The field's join paths

JoinQuery

public JoinQuery(Query subQuery,
 List<String> joinPaths)

Build a join query.

Parameters:

subQuery - The sub query.

joinPaths - The field's join paths

JoinQuery

public JoinQuery(JoinKey... joinKeys)

Build a join query.

Parameters:

joinKeys - The join paths and optional nested queries

JoinQuery

public JoinQuery(Query subQuery,
 JoinKey... joinKeys)

Build a join query.

Parameters:

subQuery - The sub query.

joinKeys - The join paths and optional nested queries

Method Details

build

public String build()
             throws QuerySyntaxException

Description copied from interface: Query

Build the solr query string representing the Query object.

Specified by:

build in interface Query

Returns:

the solr query string representing the Query object.

Throws:

QuerySyntaxException - if the query can't be built because of a syntax error.

buildAsJson

public Optional<Object> buildAsJson()
                             throws QuerySyntaxException

Description copied from interface: Query

Build the solr query representing the Query object.
The return type may be either String or Map<String, Object> following the Solr JSON Query DSL.

Specified by:

buildAsJson in interface Query

Returns:

the solr query representing the Query object. Can be empty in case of empty query.

Throws:

QuerySyntaxException - if the query can't be built because of a syntax error.

toString

public String toString(int indent)

Description copied from interface: Query

Gets a representation of this Query, for pretty-printing for logging and debugging purposes

Specified by:

toString in interface Query

Parameters:

indent - The current indentation. Base indentation is 2 (for printing a sub-level)

Returns:

a representation of this Query

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object