com.tridion.smarttarget.entitymodel.query.location.criteria

Class ValueSet

java.lang.Object

com.tridion.smarttarget.entitymodel.query.location.criteria.ValueSet

All Implemented Interfaces:

Serializable

public class ValueSet
extends Object
implements Serializable

A wrapper class around a Set instance that models properties specific to value sets as used by the Elasticsearch Query Language.

Every instance of this class has an AggregationType that describes how the elements of this class are to be interpreted.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ValueSet.AggregationType Sets values are obligatory(ValueSet.AggregationType.AND) or requires non-empty intersection (ValueSet.AggregationType.OR).

Constructor Summary

Constructors

Constructor and Description
ValueSet(ValueSet.AggregationType aggregationType) Creates an empty value set with the given ValueSet.AggregationType.

Method Summary

Modifier and Type	Method and Description
ValueSet	add(String value) Adds a value to this ValueSet instance.
ValueSet	addAll(Collection collection) Adds string representations of all elements of the given collection to this ValueSet.
ValueSet	clear() Removes all values from this ValueSet instance.
boolean	contains(String value) Determines whether the given value is present in this ValueSet instance.
boolean	equals(Object o)
ValueSet.AggregationType	getAggregationType() Returns the ValueSet.AggregationType of this ValueSet.
int	hashCode()
boolean	isEmpty() Tells whether this value set is empty.
ValueSet	remove(String value) Removes a value from this ValueSet instance.
void	setAggregationType(ValueSet.AggregationType aggregationType) Sets the ValueSet.AggregationType of this ValueSet.
int	size() Returns the size of this ValueSet instance.
String	toString() Returns a string presentation of this ValueSet instance.
void	toStringBuilder(StringBuilder builder) Appends the string presentation of this ValueSet to the given StringBuilder.
String[]	values() Returns an array containing all values in this ValueSet.
Set	valueSet() Returns a new, mutable Set that contains all values of this ValueSet.

Methods inherited from class java.lang.Object

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

Constructor Detail

ValueSet

public ValueSet(ValueSet.AggregationType aggregationType)

Creates an empty value set with the given ValueSet.AggregationType.

Parameters:

aggregationType - The aggregation type for this set; will become relevant once the set is populated.

Method Detail

getAggregationType

public ValueSet.AggregationType getAggregationType()

Returns the ValueSet.AggregationType of this ValueSet.

Returns:

The aggregation type of this value set.

See Also:

setAggregationType(AggregationType)

setAggregationType

public void setAggregationType(ValueSet.AggregationType aggregationType)

Sets the ValueSet.AggregationType of this ValueSet.

Parameters:

aggregationType - The new aggregation type of this value set.

Throws:

IllegalArgumentException - If aggregationType is null.

See Also:

getAggregationType()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Returns a string presentation of this ValueSet instance.

The returned representation is consistent with the value set syntax used for location criteria.

Overrides:

toString in class Object

Returns:

A string presentation of this ValueSet.

See Also:

toStringBuilder(StringBuilder)

toStringBuilder

public void toStringBuilder(StringBuilder builder)

Appends the string presentation of this ValueSet to the given StringBuilder.

The output string representation is identical to the result of a call to toString().

Parameters:

builder - The buffer to which the string representation is to be added.

See Also:

toString()

size

public int size()

Returns the size of this ValueSet instance.

Returns:

The number of values contained in this value set.

clear

public ValueSet clear()

Removes all values from this ValueSet instance.

Returns:

This ValueSet instance; useful for chained manipulations.

contains

public boolean contains(String value)

Determines whether the given value is present in this ValueSet instance.

Parameters:

value - The value for which to perform a membership test.

Returns:

true if the value is contained in the set, false otherwise.

add

public ValueSet add(String value)

Adds a value to this ValueSet instance.

Parameters:

value - The value that is to be added, if not already present.

Returns:

This ValueSet instance; useful for chained manipulations.

Throws:

IllegalArgumentException - If value is null or the empty string.

remove

public ValueSet remove(String value)

Removes a value from this ValueSet instance.

Parameters:

value - The value that is to be removed, if present.

Returns:

This ValueSet instance; useful for chained manipulations.

values

public String[] values()

Returns an array containing all values in this ValueSet.

Returns:

An array that is not backed by this ValueSet instance.

valueSet

public Set valueSet()

Returns a new, mutable Set that contains all values of this ValueSet.

Note: for backwards compatibility reasons the return type of this method is Set. Callers of this method may however assume that this method returns a SortedSet. Actually changing the return type would require recompilation of code that calls this method; as such we have (for now) refrained from doing so.

Returns:

A new SortedSet instance that is not backed by this ValueSet instance.

addAll

public ValueSet addAll(Collection collection)

Adds string representations of all elements of the given collection to this ValueSet.

Parameters:

collection - The elements that are to be added.

Returns:

This ValueSet instance; useful for chained manipulations.

Throws:

IllegalArgumentException - If an element of collection is null or the empty string.

isEmpty

public boolean isEmpty()

Tells whether this value set is empty.

Returns:

true if this value set does not contain any elements; false otherwise.