Package org.ametys.cms.search.query.join

Class JoinKey

java.lang.Object

org.ametys.cms.search.query.join.JoinKey

public class JoinKey
extends Object

Class representing a join key and its (optional) nested query for creating a JoinQuery

Constructor Summary

Constructors

Constructor	Description
JoinKey(String key)	Creates a JoinKey
JoinKey(String key, String joinField, Query nestedQuery)	Creates a JoinKey
JoinKey(String key, Query nestedQuery)	Creates a JoinKey

Method Summary

Modifier and Type	Method	Description
String	build(boolean escape)	Build the Solr JoinQuery part representing this JoinKey.
boolean	equals(Object obj)
Optional<String>	getJoinField()	Returns the join field, if any.
String	getKey()	Gets the key of the JoinKey
Optional<Query>	getNestedQuery()	Gets the optional nested query of the join key
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

JoinKey

public JoinKey(String key)

Creates a JoinKey

Parameters:

key - The key. Cannot be null

JoinKey

public JoinKey(String key,
 Query nestedQuery)

Creates a JoinKey

Parameters:

key - The key. Cannot be null

nestedQuery - The nested query of the join key. Can be null

JoinKey

public JoinKey(String key,
 String joinField,
 Query nestedQuery)

Creates a JoinKey

Parameters:

key - The key. Cannot be null

joinField - the field to join on. Can be null in which case "id_dv" will be assumed on Solr side.

nestedQuery - The nested query of the join key. Can be null

Method Details

getKey

public String getKey()

Gets the key of the JoinKey

Returns:

the key of the JoinKey

getJoinField

public Optional<String> getJoinField()

Returns the join field, if any.

Returns:

the join field, if any.

getNestedQuery

public Optional<Query> getNestedQuery()

Gets the optional nested query of the join key

Returns:

the optional nested query of the join key

build

public String build(boolean escape)
             throws QuerySyntaxException

Build the Solr JoinQuery part representing this JoinKey.

Parameters:

escape - if the nested query should be escaped

Returns:

a Solr query part

Throws:

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object