Package com.intuit.datum_ipsum.model

Class Wheel

java.lang.Object

com.intuit.datum_ipsum.model.Wheel

All Implemented Interfaces:

java.io.Serializable

public class Wheel
extends java.lang.Object
implements java.io.Serializable

Mid level object in the string representation. A sequence is comprised of an ordered list of wheels. Each wheel contains a set of blocks. Think of wheels like the spinners on the slot machine, randomizing which block appears in each slot.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Wheel()	Create an empty wheel.
Wheel(Block block)	Create a wheel from a single block.

Method Summary

Modifier and Type	Method	Description
void	addBlock(Block block)	Add a block to this wheel.
java.lang.Double	calculateLikelihood(java.util.List<java.lang.Character> inputCharacters)	Calculate the probability of a portion of the given string being generated by this wheel.
boolean	equals(java.lang.Object obj)
static Wheel	fromJSONString(java.lang.String jsonString)	Deserialize a wheel from a JSON string
java.lang.String	generate(java.util.Random randomGenerator)	Generate a random string based on this wheel.
java.lang.String	generate(java.util.Random randomGenerator, java.lang.Integer totalCount)	Generate a random string based on this wheel and a total string count (i.e.
java.util.Map<BlockDefinition,Block>	getBlocks()
java.lang.Integer	getTotalBlockCounts()
int	hashCode()
void	reduce(Wheel other)	Combine another wheel into this one by aggregating counts at each level (wheel, block).
java.lang.String	toJSONString()	Serialize this wheel to a JSON string.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Wheel

public Wheel()

Create an empty wheel.

Wheel

public Wheel(Block block)

Create a wheel from a single block.

Parameters:

block - the initial block

Method Detail

getBlocks

public java.util.Map<BlockDefinition,Block> getBlocks()

Returns:

blocks contained in this wheel

addBlock

public void addBlock(Block block)

Add a block to this wheel. If the block definition is new, the block is inserted. If the block definition is already represented in this wheel, the two similar blocks are merged, with the appropriate values aggregated.

Parameters:

block - new block to include in this wheel

getTotalBlockCounts

public java.lang.Integer getTotalBlockCounts()

Returns:

total number of strings characterized by this wheel

reduce

public void reduce(Wheel other)

Combine another wheel into this one by aggregating counts at each level (wheel, block).

Parameters:

other - the other wheel to combine

generate

public java.lang.String generate(java.util.Random randomGenerator,
                                 java.lang.Integer totalCount)

Generate a random string based on this wheel and a total string count (i.e. from a sequence).

Parameters:

randomGenerator - random number generator to use

totalCount - total number of non-null strings (from the sequence); used to determine if the result should be an empty string

Returns:

the random string

generate

public java.lang.String generate(java.util.Random randomGenerator)

Generate a random string based on this wheel.

Parameters:

randomGenerator - random number generator to use

Returns:

the random string

calculateLikelihood

public java.lang.Double calculateLikelihood(java.util.List<java.lang.Character> inputCharacters)

Calculate the probability of a portion of the given string being generated by this wheel. Attempts to greedily match characters starting at the beginning of the string. Removes matched characters from inputCharacters so the process can be repeated with the next wheel.

Parameters:

inputCharacters - characters to match

Returns:

the probability of generating the matching portion of the string

toJSONString

public java.lang.String toJSONString()
                              throws org.codehaus.jettison.json.JSONException

Serialize this wheel to a JSON string.

Returns:

the JSON string

Throws:

org.codehaus.jettison.json.JSONException

fromJSONString

public static Wheel fromJSONString(java.lang.String jsonString)
                            throws org.codehaus.jettison.json.JSONException

Deserialize a wheel from a JSON string

Parameters:

jsonString - the JSON string

Returns:

a wheel object represented by the string

Throws:

org.codehaus.jettison.json.JSONException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object