com.groupbyinc.api.model

Class Navigation

java.lang.Object

com.groupbyinc.api.model.Navigation

public class Navigation
extends java.lang.Object

The Navigation object represents dynamic navigation sent back from the search engine. 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 - `sort`: If specified, an object detailing the sort field and sort order

Author:

will

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Navigation.Sort

Constructor Summary

Constructors

Constructor and Description
Navigation() Default constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDisplayName()
java.lang.String	getId()
java.util.List<Metadata>	getMetadata() A list of metadata key-value pairs for a specified navigation item.
java.lang.String	getName()
java.util.List<Refinement>	getRefinements()
Navigation.Sort	getSort() Will return one of the following sort types: Count_Ascending, Count_Descending Value_Ascending, Value_Descending
java.lang.Boolean	isMoreRefinements() True if this navigation has more refinement values than the ones returned.
boolean	isOr() 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.
boolean	isRange()
Navigation	setDisplayName(java.lang.String displayName)
Navigation	setId(java.lang.String id)
Navigation	setMetadata(java.util.List<Metadata> metadata)
Navigation	setMoreRefinements(java.lang.Boolean moreRefinements)
Navigation	setName(java.lang.String name)
Navigation	setOr(boolean or)
Navigation	setRange(boolean range)
Navigation	setRefinements(java.util.List<Refinement> refinements)
Navigation	setSort(Navigation.Sort sort)
Navigation	setSort(java.lang.String sort) Helper method

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Navigation

public Navigation()

Default constructor

Method Detail

getName

public java.lang.String getName()

Returns:

The name of the dynamic navigation attribute. This is the name of the metadata that was uploaded as part of the feed

setName

public Navigation setName(java.lang.String name)

Parameters:

name - The name of the navigation

Returns:

getDisplayName

public java.lang.String getDisplayName()

Returns:

The human readable label for this navigation.

setDisplayName

public Navigation setDisplayName(java.lang.String displayName)

Parameters:

displayName - Set the display name

Returns:

getRefinements

public java.util.List<Refinement> getRefinements()

Returns:

A list of refinement values that represent the ways in which you can filter data.

setRefinements

public Navigation setRefinements(java.util.List<Refinement> refinements)

Parameters:

refinements - The refinement values

Returns:

getId

public java.lang.String getId()

Returns:

A MD5 of the name, which means that this navigation ID is unique.

setId

public Navigation setId(java.lang.String id)

Parameters:

id - Set the ID

Returns:

isRange

public boolean isRange()

Returns:

True if this navigation is a of type range.

setRange

public Navigation setRange(boolean range)

Parameters:

range - Set range

Returns:

isOr

public boolean isOr()

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'}

Returns:

Is this dynamic navigation going to be treated as an OR field by the search service.

setOr

public Navigation setOr(boolean or)

Parameters:

or - Set whether this is an OR field

Returns:

getSort

public Navigation.Sort getSort()

Will return one of the following sort types: Count_Ascending, Count_Descending Value_Ascending, Value_Descending

Returns:

The sort option for this navigation.

setSort

public Navigation setSort(java.lang.String sort)

Helper method

Parameters:

sort - Set the sort by string.

setSort

public Navigation setSort(Navigation.Sort sort)

Parameters:

sort - Set the sort type

getMetadata

public java.util.List<Metadata> getMetadata()

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

Returns:

A list of metadata elements

setMetadata

public Navigation setMetadata(java.util.List<Metadata> metadata)

Parameters:

metadata - Set the metadata

Returns:

isMoreRefinements

public java.lang.Boolean isMoreRefinements()

True if this navigation has more refinement values than the ones returned.

Returns:

True if this navigation has more refinement values than the ones returned, false otherwise.

setMoreRefinements

public Navigation setMoreRefinements(java.lang.Boolean moreRefinements)

Parameters:

moreRefinements - True if this navigation has more refinement values than the ones returned.

Returns: