com.basistech.rosette.apimodel

Class CategoriesOptions

java.lang.Object

com.basistech.rosette.apimodel.CategoriesOptions

public final class CategoriesOptions
extends Object

Categorization options

Constructor Summary

Constructors

Constructor and Description
CategoriesOptions() Create a set of categorization options with default values.
CategoriesOptions(Boolean explain, Integer numCategories) constructor for CategoriesOptions

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) if the param is a CategoriesOptions, compare contents for equality
Boolean	getExplain() get whether to return explanation strings for each category returned
Integer	getNumCategories() get max number of categories
int	hashCode()
void	setExplain(Boolean explain) set whether to return explanation strings for each category returned
void	setNumCategories(Integer numCategories) set max number of categories

Methods inherited from class java.lang.Object

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

Constructor Detail

CategoriesOptions

public CategoriesOptions()

Create a set of categorization options with default values. Note that null is used to represent defaults.

CategoriesOptions

public CategoriesOptions(Boolean explain,
                         Integer numCategories)

constructor for CategoriesOptions

Parameters:

explain - whether to return explanation strings for each category returned

numCategories - max number of categories

Method Detail

getExplain

public Boolean getExplain()

get whether to return explanation strings for each category returned

Returns:

whether to return explanation strings

getNumCategories

public Integer getNumCategories()

get max number of categories

Returns:

number of categories

setExplain

public void setExplain(Boolean explain)

set whether to return explanation strings for each category returned

Parameters:

explain - whether to return explanation strings

setNumCategories

public void setNumCategories(Integer numCategories)

set max number of categories

Parameters:

numCategories - number of categories

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

if the param is a CategoriesOptions, compare contents for equality

Overrides:

equals in class Object

Parameters:

o - the object

Returns:

whether or not the param object is equal to this object