Package org.ametys.cms.search.query

Class TagQuery

java.lang.Object

org.ametys.cms.search.query.TagQuery

All Implemented Interfaces:

Query

public class TagQuery
extends Object
implements Query

Represents a Query testing if an object possesses one or more tags.

Nested Class Summary

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

Query.LogicalOperator, Query.Operator

Constructor Summary

Constructors

Constructor	Description
TagQuery(String value)	Build a TagQuery.
TagQuery(String... values)	Build a TagQuery.
TagQuery(Query.Operator operator, boolean descendantAutoposting, String value)	Build a TagQuery.
TagQuery(Query.Operator operator, boolean descendantAutoposting, String... values)	Build a TagQuery.
TagQuery(Query.Operator operator, boolean descendantAutoposting, Query.LogicalOperator logicalOperator, String... values)	Build a TagQuery.
TagQuery(Query.Operator operator, String value)	Build a TagQuery.
TagQuery(Query.Operator operator, String... values)	Build a TagQuery.

Method Summary

Modifier and Type	Method	Description
String	build()	Build the solr query string representing the Query object.
boolean	equals(Object obj)
Query.LogicalOperator	getLogicalOperator()	Get the logicalOperator.
Query.Operator	getOperator()	Get the operator.
String[]	getValues()	Get the values.
int	hashCode()

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

toString

Constructor Details

TagQuery

public TagQuery(String value)

Build a TagQuery.

Parameters:

value - the tag id to test.

TagQuery

public TagQuery(String... values)

Build a TagQuery.

Parameters:

values - the tag IDs to test.

TagQuery

public TagQuery(Query.Operator operator,
 String value)

Build a TagQuery.

Parameters:

operator - the operator.

value - the tag id to test.

TagQuery

public TagQuery(Query.Operator operator,
 String... values)

Build a TagQuery.

Parameters:

operator - the operator.

values - the tag IDs to test.

TagQuery

public TagQuery(Query.Operator operator,
 boolean descendantAutoposting,
 String value)

Build a TagQuery.

Parameters:

operator - the operator.

descendantAutoposting - true to enable descendant autoposting (parent tags are found), false otherwise.

value - the tag id to test.

TagQuery

public TagQuery(Query.Operator operator,
 boolean descendantAutoposting,
 String... values)

Build a TagQuery.

Parameters:

operator - the operator.

descendantAutoposting - true to enable descendant autoposting (parent tags are found), false otherwise.

values - the tag IDs to test.

TagQuery

public TagQuery(Query.Operator operator,
 boolean descendantAutoposting,
 Query.LogicalOperator logicalOperator,
 String... values)

Build a TagQuery.

Parameters:

operator - the operator. The operator is applied to each value individually. For instance, if operator is NE and logicalOperator is OR, then the Query represents: (NOT A) OR (NOT B) ...

descendantAutoposting - true to enable descendant autoposting (parent tags are found), false otherwise.

logicalOperator - the logical operator.

values - the tag IDs to test.

Method Details

getOperator

public Query.Operator getOperator()

Get the operator.

Returns:

the operator

getValues

public String[] getValues()

Get the values.

Returns:

the values

getLogicalOperator

public Query.LogicalOperator getLogicalOperator()

Get the logicalOperator.

Returns:

the logicalOperator

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.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object