com.groupbyinc.api.model.Navigation Maven / Gradle / Ivy
package com.groupbyinc.api.model;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonSetter;
import java.util.ArrayList;
import java.util.List;
/**
*
* The Navigation object represents dynamic navigation sent back from the search engine
* or sent to the engine to override Command Center settings.
*
* Each navigation item has the following properties:
*
* - `id`: an MD5 hash of the name.
* - `name`: the name of the metadata used to create this dynamic navigation option.
* - `displayName`: the human digestible version of this name.
* - `range`: true if the navigation option is a range.
* - `or`: true if the navigation option supports or-queries.
* - `refinements`: A list of the refinement values for this dynamic navigation
* - `pinnedRefinements`: A list of the refinement values to pin to the top of this dynamic navigation
* - `sort`: If specified, an object detailing the sort field and sort order
*
*
*/
public class Navigation {
public enum Sort {
Count_Ascending,
Count_Descending,
Value_Ascending,
Value_Descending // NOSONAR
}
public enum Type {
Value,
Range,
Dynamic_Range
}
@JsonProperty("_id") private String id;
private String name;
private String displayName;
private boolean range = false;
private boolean or = false;
private Boolean ignored;
private Sort sort;
private Type type;
@JsonInclude(value = JsonInclude.Include.NON_DEFAULT) private Boolean moreRefinements = Boolean.FALSE;
private List refinements = new ArrayList();
@JsonInclude(value = JsonInclude.Include.NON_DEFAULT) private List pinnedRefinements = new ArrayList();
private List metadata = new ArrayList();
/**
* @return The name of the dynamic navigation attribute. This is the name of
* the metadata that was uploaded as part of the feed
*/
public String getName() {
return name;
}
/**
* @param name The name of the navigation
*/
public com.groupbyinc.api.model.Navigation setName(String name) {
this.name = name;
return this;
}
/**
* @return The human readable label for this navigation.
*/
public String getDisplayName() {
return displayName;
}
/**
* @param displayName Set the display name
*/
public com.groupbyinc.api.model.Navigation setDisplayName(String displayName) {
this.displayName = displayName;
return this;
}
/**
* @return A list of refinement values that represent the ways in which you
* can filter data.
*/
public List getRefinements() {
return refinements;
}
/**
* @param refinements The refinement values
*/
public com.groupbyinc.api.model.Navigation setRefinements(List refinements) {
this.refinements = refinements;
return this;
}
/**
* @return A MD5 of the name, which means that this navigation ID is unique.
*/
public String getId() {
return id;
}
/**
* @param id Set the ID
*/
public com.groupbyinc.api.model.Navigation setId(String id) {
this.id = id;
return this;
}
/**
* @return True if this navigation is a of type range.
*/
@JsonProperty("range")
public boolean isRange() {
return range;
}
/**
* @param range Set range
*/
public com.groupbyinc.api.model.Navigation setRange(boolean range) {
this.range = range;
return this;
}
/**
*
* If you are using the this object within a JSP you will not be able to reference it directly as
* `navigation.or` is a reserved field in JSTL. Instead reference it within quotes:
*
*
* ${navigation['or'] ? 'Or Query' : 'And Query'}
*
*
*
* @return Is this dynamic navigation going to be treated as an OR field by the search service.
*/
@JsonProperty("or")
public boolean isOr() {
return or;
}
/**
* @param or Set whether this is an OR field
*/
public com.groupbyinc.api.model.Navigation setOr(boolean or) {
this.or = or;
return this;
}
/**
*
* Will return one of the following sort types:
*
* Count_Ascending, Count_Descending
* Value_Ascending, Value_Descending
*
*
*
* @return The sort option for this navigation.
*/
public Sort getSort() {
return sort;
}
/**
* @param sort Set the sort type
*/
@JsonIgnore
public com.groupbyinc.api.model.Navigation setSort(Sort sort) {
this.sort = sort;
return this;
}
/**
*
* Helper method
*
*
* @param sort Set the sort by string.
*/
@JsonSetter
public com.groupbyinc.api.model.Navigation setSort(String sort) {
this.sort = Sort.valueOf(sort);
return this;
}
/**
*
* A list of metadata key-value pairs for a specified navigation item. Each value
* contains the following properties:
*
* - key: a string containing the attribute name
* - value: a string containing the attribute value
*
*
*
* @return A list of metadata elements
*/
public List getMetadata() {
return metadata;
}
/**
* @param metadata Set the metadata
*/
public com.groupbyinc.api.model.Navigation setMetadata(List metadata) {
this.metadata = metadata;
return this;
}
/**
*
* True if this navigation has more refinement values than the ones returned.
*
*
* @return True if this navigation has more refinement values than the ones returned, false otherwise.
*/
public Boolean isMoreRefinements() {
return moreRefinements;
}
/**
* @param moreRefinements True if this navigation has more refinement values than the ones returned.
*/
public com.groupbyinc.api.model.Navigation setMoreRefinements(Boolean moreRefinements) {
this.moreRefinements = moreRefinements;
return this;
}
/**
*
* True if this navigation has been ignored.
*
*
* @return True if this navigation was ignored, false otherwise.
*/
public Boolean isIgnored() {
return ignored;
}
/**
* @param ignored True if this navigation has been ignored.
*/
public com.groupbyinc.api.model.Navigation setIgnored(Boolean ignored) {
this.ignored = ignored;
return this;
}
/**
*
* The navigation type:
*
* - Value
* - Range
* - Dynamic_Range
*
*
*
* @return The navigation type
*/
public com.groupbyinc.api.model.Navigation.Type getType() {
return type;
}
/**
* @param type Value/Range/Dynamic_Range.
*/
public com.groupbyinc.api.model.Navigation setType(com.groupbyinc.api.model.Navigation.Type type) {
this.type = type;
return this;
}
/**
* @return A list of refinement values that you want to pin to the top of the navigation.
*/
public List getPinnedRefinements() {
return pinnedRefinements;
}
/**
* @param pinnedRefinements The refinement values to pin
*/
public com.groupbyinc.api.model.Navigation setPinnedRefinements(List pinnedRefinements) {
this.pinnedRefinements = pinnedRefinements;
return this;
}
}