Package com.apptus.esales.connector

Class Result.Values

java.lang.Object

com.apptus.esales.connector.Result.Values

All Implemented Interfaces:

Result, Result.Facet, Iterable<Result.Value>

Enclosing interface:

Result

public static class Result.Values
extends Object
implements Result, Result.Facet, Iterable<Result.Value>

Represents a result having the values format.

Nested Class Summary

Nested classes/interfaces inherited from interface com.apptus.esales.connector.Result

Result.Ad, Result.Ads, Result.Attribute, Result.Category, Result.CategoryData, Result.CategoryList, Result.CategoryNode, Result.Completion, Result.Completions, Result.Correction, Result.Corrections, Result.Count, Result.Facet, Result.FacetList, Result.FacetRange, Result.Phrase, Result.Phrases, Result.Product, Result.Products, Result.ResultType, Result.Value, Result.Values, Result.Variant

Constructor Summary

Constructors

Constructor	Description
Values(String attribute)

Method Summary

Modifier and Type	Method	Description
String	getAttribute()	The attribute associated with the facet.
Result.ResultType	getType()	Get the result type of this result.
List<Result.Value>	getValues()	Get a list of the values.
boolean	isEmpty()	Check if this result is empty.
boolean	isRange()	Check if this facet is a range facet or a multi value facet.
Iterator<Result.Value>	iterator()
static Result.Values	mock(List<Result.Value> values)	Creates a new Values object for test purposes.
static Result.Values	mock(List<Result.Value> values, String attribute)	Creates a new Values object for test purposes.
int	size()	Get the number of values.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Values

public Values(String attribute)

Method Detail

mock

public static Result.Values mock(List<Result.Value> values)

Creates a new Values object for test purposes.

Parameters:

values - the values to include in the values result

Returns:

a values result

mock

public static Result.Values mock(List<Result.Value> values,
                                 String attribute)

Creates a new Values object for test purposes.

Parameters:

values - the values to include in the values result

attribute - the attribute associated with the values

Returns:

a values result

iterator

public Iterator<Result.Value> iterator()

Specified by:

iterator in interface Iterable<Result.Value>

size

public final int size()

Get the number of values.

Returns:

the number of values found

isEmpty

public boolean isEmpty()

Check if this result is empty.

Returns:

true if there are no values, otherwise false

getValues

public List<Result.Value> getValues()

Get a list of the values.

Returns:

the list of values

toString

public String toString()

Specified by:

toString in interface Result

Overrides:

toString in class Object

getType

public Result.ResultType getType()

Description copied from interface: Result

Get the result type of this result.

Specified by:

getType in interface Result

Returns:

the result type

isRange

public boolean isRange()

Description copied from interface: Result.Facet

Check if this facet is a range facet or a multi value facet.

Specified by:

isRange in interface Result.Facet

Returns:

true if the facet is a range

getAttribute

public String getAttribute()

Description copied from interface: Result.Facet

The attribute associated with the facet.

Specified by:

getAttribute in interface Result.Facet

Returns:

the attribute associated with the facet