Package com.apptus.esales.connector

Class Facets

java.lang.Object

com.apptus.esales.connector.Facets

public class Facets
extends Object

Class for creating a facets argument, used for check-box navigation. It also has support for parsing and toggling facet values, so it can be used to keep track of selection changes.

Example:

 Facets f = new Facets("color", "yellow", "blue").add("brand", "nike");
 // f.toString() is: brand:nike,color:blue|yellow
 ArgMap panelArguments = new ArgMap();
 panelArguments.put("facets", f);
 // ... other arguments...
 

If it is convenient in your scenario you can serialize the current selected values using toString() and store them in the browser. When a check-box is clicked, deserialize it afterwards like this:

 Facets f = Facets.parse(facetsString);
 

Then update it with the last click and send a new request:

 f = f.toggle(clickedAttribute, clickedValue);
 panelArguments.put("facets", f);
 // ... add other arguments and send request...
 

Note that Facets are immutable and all methods return new Facets objects.

Constructor Summary

Constructors

Constructor	Description
Facets()	Create a new empty Facets.
Facets(String attribute, String... values)	Create a new Facets with the given attribute and values.
Facets(String attribute, List<String> values)	Create a new Facets with the given attribute and values.

Method Summary

Modifier and Type	Method	Description
Facets	add(String attribute, String... values)	Return a new Facets with the given attribute and values added.
Facets	add(String attribute, List<String> values)	Return a new Facets with the given attribute and values added.
Facets	addRange(String attribute, String min, String max)	Return a new Facets with the given attribute range added.
boolean	equals(Object obj)
int	hashCode()
static Facets	parse(String source)	Create a Facets object from the source string.
Facets	remove(String attribute)	Return a new Facets where the given attribute is removed.
Facets	toggle(String attribute, String value)	Toggle the given attribute and value.
String	toString()	Builds and returns a string on the facet argument format.

Methods inherited from class java.lang.Object

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

Constructor Detail

Facets

public Facets()

Create a new empty Facets.

Facets

public Facets(String attribute,
              String... values)

Create a new Facets with the given attribute and values.

Parameters:

attribute - the attribute for the facet.

values - the values for the attribute.

Throws:

IllegalArgumentException - if attribute is null or the empty string.

Facets

public Facets(String attribute,
              List<String> values)

Create a new Facets with the given attribute and values.

Parameters:

attribute - the attribute for the facet.

values - the values for the attribute.

Throws:

IllegalArgumentException - if attribute is null or the empty string.

Method Detail

add

public Facets add(String attribute,
                  String... values)

Return a new Facets with the given attribute and values added.

Parameters:

attribute - the attribute.

values - the values for the attribute.

Returns:

a new Facets object

Throws:

IllegalArgumentException - if attribute is null or the empty string.

add

public Facets add(String attribute,
                  List<String> values)

Return a new Facets with the given attribute and values added.

Parameters:

attribute - the attribute.

values - the values for the attribute.

Returns:

a new Facets object

Throws:

IllegalArgumentException - if attribute is null or the empty string.

toggle

public Facets toggle(String attribute,
                     String value)

Toggle the given attribute and value.

Parameters:

attribute - the attribute.

value - the value for the attribute to be toggled.

Returns:

a new Facets object

Throws:

IllegalArgumentException - if attribute is null or the empty string.

addRange

public Facets addRange(String attribute,
                       String min,
                       String max)

Return a new Facets with the given attribute range added. If a range of the current attribute already existed, it will replace the existing one. Note that facet ranges are inclusive.

Parameters:

attribute - the attribute.

min - min value, inclusive.

max - max value, inclusive.

Returns:

a new Facets object.

Throws:

IllegalArgumentException - if attribute is null or the empty string.

remove

public Facets remove(String attribute)

Return a new Facets where the given attribute is removed.

Parameters:

attribute - attribute to remove.

Returns:

a new Facets without the specified attribute.

Throws:

IllegalArgumentException - if attribute is null or the empty string.

parse

public static Facets parse(String source)

Create a Facets object from the source string.

Parameters:

source - the string to parse

Returns:

a Facets object from the source string

Throws:

IllegalArgumentException - if there are any parse errors

toString

public String toString()

Builds and returns a string on the facet argument format.

Overrides:

toString in class Object

Returns:

a string on the facet argument format

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object