Package com.intuit.datum_ipsum.model

Class Block

java.lang.Object

com.intuit.datum_ipsum.model.Block

All Implemented Interfaces:

java.io.Serializable

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

Bottom level object in the string representation. Each wheel contains a set of blocks. A block is comprised of a distribution for the string length (number of characters) and a distribution for the characters themselves (counts of each character). A block can be created from a block definition to initialize the set of characters considered.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Block()	Create an empty block.
Block(BlockDefinition definition)	Create a block from a block definition.
Block(java.util.Collection<java.lang.Character> characterCollection)	Create a block from a set of characters.

Method Summary

Modifier and Type	Method	Description
void	addBlockCount(java.lang.Integer count)
void	addCharacter(java.lang.Character character, java.lang.Integer count)	Add a character, incrementing the count for that character.
void	addLength(java.lang.Integer length, java.lang.Integer count)	Add a length, incrementing the count for that length.
java.lang.Double	calculateLikelihood(java.lang.String input)	Calculate the probability a given string being generated by this block.
boolean	equals(java.lang.Object obj)
static Block	fromJSONString(java.lang.String jsonString)	Deserialize a block from a JSON string
java.lang.String	generate(java.util.Random randomGenerator)	Generate a random string based on this block.
java.lang.Integer	getBlockCount()
java.util.Map<java.lang.Character,java.lang.Integer>	getCharacterCounts()
java.util.Set<java.lang.Character>	getCharacters()
BlockDefinition	getDefinition()
java.lang.Integer	getGatherCount(java.lang.String input)	Count consecutive characters in a string that could possibly be generated by this block.
java.util.Map<java.lang.Integer,java.lang.Integer>	getLengthCounts()
java.lang.Integer	getMaxLength()
java.lang.Integer	getTotalCharacterCounts()
java.lang.Integer	getTotalLengthCounts()
int	hashCode()
java.lang.Boolean	isDefaultBlock()
void	reduce(Block other)	Combine another block into this one by aggregating character and length counts.
void	setDefaultBlock(java.lang.Boolean defaultSetting)	Set this block to be a default block or not.
java.lang.String	toJSONString()	Serialize this block 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

Block

public Block()

Create an empty block.

Block

public Block(java.util.Collection<java.lang.Character> characterCollection)

Create a block from a set of characters. The character distribution is initialized with these characters, each with zero count.

Parameters:

characterCollection - the set of characters to use

Block

public Block(BlockDefinition definition)

Create a block from a block definition.

Parameters:

definition - the block definition to use

Method Detail

getCharacterCounts

public java.util.Map<java.lang.Character,java.lang.Integer> getCharacterCounts()

Returns:

distribution of character occurrences

addCharacter

public void addCharacter(java.lang.Character character,
                         java.lang.Integer count)

Add a character, incrementing the count for that character.

Parameters:

character - character to add

count - number to increment by

getTotalCharacterCounts

public java.lang.Integer getTotalCharacterCounts()

Returns:

sum of counts for all characters

getDefinition

public BlockDefinition getDefinition()

Returns:

a block definition generated from the set of characters in this block

getCharacters

public java.util.Set<java.lang.Character> getCharacters()

Returns:

the set of characters in this block

getLengthCounts

public java.util.Map<java.lang.Integer,java.lang.Integer> getLengthCounts()

Returns:

distribution of string length occurrences

addLength

public void addLength(java.lang.Integer length,
                      java.lang.Integer count)

Add a length, incrementing the count for that length.

Parameters:

length - the string length to add

count - number to incrment by

getTotalLengthCounts

public java.lang.Integer getTotalLengthCounts()

Returns:

sum of counts for all string lenghts

getMaxLength

public java.lang.Integer getMaxLength()

Returns:

maximum length with nonzero count

getBlockCount

public java.lang.Integer getBlockCount()

Returns:

total number of strings characterized by this block

addBlockCount

public void addBlockCount(java.lang.Integer count)

Parameters:

count - number of additional string to add

isDefaultBlock

public java.lang.Boolean isDefaultBlock()

Returns:

if this block matches all characters

setDefaultBlock

public void setDefaultBlock(java.lang.Boolean defaultSetting)

Set this block to be a default block or not. A default block will match all characters, even those not previously tracked in the character distribution of the block.

Parameters:

defaultSetting - the setting to use

reduce

public void reduce(Block other)

Combine another block into this one by aggregating character and length counts.

Parameters:

other - the other block to combine

generate

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

Generate a random string based on this block.

Parameters:

randomGenerator - random number generator to use

Returns:

the random string

getGatherCount

public java.lang.Integer getGatherCount(java.lang.String input)

Count consecutive characters in a string that could possibly be generated by this block.

Parameters:

input - the string to consider

Returns:

number of consecutive characters that could be generated

calculateLikelihood

public java.lang.Double calculateLikelihood(java.lang.String input)

Calculate the probability a given string being generated by this block.

Parameters:

input - string to consider

Returns:

probability of generating this exact string

toJSONString

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

Serialize this block to a JSON string.

Returns:

the JSON string

Throws:

org.codehaus.jettison.json.JSONException

fromJSONString

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

Deserialize a block from a JSON string

Parameters:

jsonString - the JSON string

Returns:

a block 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