de.slothsoft.random.types

Class WordsRandomField

java.lang.Object

de.slothsoft.random.types.WordsRandomField

All Implemented Interfaces:

RandomField

public class WordsRandomField
extends Object
implements RandomField

Generates words in sentences and paragraphs after a defined config stored in WordGeneratorConfig.

Since:

2.1.0

Author:

Stef Schulz

Field Summary

Fields inherited from interface de.slothsoft.random.RandomField

RND

Constructor Summary

Constructors

Constructor and Description
WordsRandomField()

Method Summary

Modifier and Type	Method and Description
WordsRandomField	config(WordGeneratorConfig newConfig) Sets the used config.
WordGeneratorConfig	getConfig() Returns the used config.
double	getNullProbability() Returns the probability for this field returning null.
int	getParagraphCount() Returns the number of paragraphs.
String	nextValue() Generates a brand new word.
WordsRandomField	nullProbability(double newNullProbability) Sets the probability for this field returning null.
WordsRandomField	paragraphCount(int newParagraphCount) Sets the standard number of paragraphs.
void	setConfig(WordGeneratorConfig config) Sets the used config.
void	setNullProbability(double nullProbability) Sets the probability for this field returning null.
void	setParagraphCount(int paragraphCount) Sets the standard number of paragraphs.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.slothsoft.random.RandomField

init

Constructor Detail

WordsRandomField

public WordsRandomField()

Method Detail

nextValue

public String nextValue()

Generates a brand new word.

Specified by:

nextValue in interface RandomField

Returns:

a word

getConfig

public WordGeneratorConfig getConfig()

Returns the used config.

Returns:

a config

config

public WordsRandomField config(WordGeneratorConfig newConfig)

Sets the used config.

Parameters:

newConfig - a config

Returns:

this instance

setConfig

public void setConfig(WordGeneratorConfig config)

Sets the used config.

Parameters:

config - a config

getParagraphCount

public int getParagraphCount()

Returns the number of paragraphs. A Gaussian function is used to scatter the actual paragraph length around this value.

Returns:

paragraph count

paragraphCount

public WordsRandomField paragraphCount(int newParagraphCount)

Sets the standard number of paragraphs. A Gaussian function is used to scatter the actual paragraph length around this value.

Parameters:

newParagraphCount - paragraph count

Returns:

this instance

setParagraphCount

public void setParagraphCount(int paragraphCount)

Sets the standard number of paragraphs. A Gaussian function is used to scatter the actual paragraph length around this value.

Parameters:

paragraphCount - paragraph count

getNullProbability

public double getNullProbability()

Returns the probability for this field returning null. If the value is 0 then no nextValue() is null, if it is 1 then every nextValue() is null.

Returns:

the probability between 0 and 1

nullProbability

public WordsRandomField nullProbability(double newNullProbability)

Sets the probability for this field returning null. If the value is 0 then no nextValue() is null, if it is 1 then every nextValue() is null.

Parameters:

newNullProbability - the probability between 0 and 1

Returns:

this instance

setNullProbability

public void setNullProbability(double nullProbability)

Sets the probability for this field returning null. If the value is 0 then no nextValue() is null, if it is 1 then every nextValue() is null.

Parameters:

nullProbability - the probability between 0 and 1