com.groupbyinc.api.model

Class Refinement<T extends Refinement<T>>

java.lang.Object

com.groupbyinc.api.model.Refinement<T>

Direct Known Subclasses:

RefinementRange, RefinementValue

public abstract class Refinement<T extends Refinement<T>>
extends java.lang.Object

Abstract Refinement class holding common methods for RefinementRange and RefinementValue.

Author:

will

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Refinement.Type

Constructor Summary

Constructors

Constructor and Description
Refinement()

Method Summary

Modifier and Type	Method and Description
int	getCount()
java.lang.Boolean	getExclude()
java.lang.String	getId()
abstract Refinement.Type	getType() Types are either `Range` or `Value` They represent the objects RefinementRange and RefinementValue
boolean	isRange()
T	setCount(int count)
T	setExclude(java.lang.Boolean exclude)
T	setId(java.lang.String id)
abstract java.lang.String	toTildeString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Refinement

public Refinement()

Method Detail

getId

public java.lang.String getId()

Returns:

The ID is a MD5 of the name and value of the refinement.

setId

public T setId(java.lang.String id)

Parameters:

id - Set the ID

Returns:

getCount

public int getCount()

Returns:

The number of records that will be left if this refinement is selected.

setCount

public T setCount(int count)

Parameters:

count - Set the number of matches if this refinement is selected

Returns:

isRange

public boolean isRange()

Returns:

True if this is a range refinement.

getType

public abstract Refinement.Type getType()

Types are either `Range` or `Value` They represent the objects RefinementRange and RefinementValue

Returns:

The type of this refinement

getExclude

public java.lang.Boolean getExclude()

Returns:

True if the results should exclude this refinement and false to including it. Defaults to false.

setExclude

public T setExclude(java.lang.Boolean exclude)

Parameters:

exclude - Set to true to get results that exclude this refinement, false to include this refinement.

Returns:

toTildeString

public abstract java.lang.String toTildeString()

Returns: