Package com.intuit.datum_ipsum.model

Class Sequence

java.lang.Object

com.intuit.datum_ipsum.model.Sequence

All Implemented Interfaces:

java.io.Serializable

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

Top level object used to represent a set of strings. A sequence is comprised of an ordered list of wheels and also tracks various counts of the strings. A sequence also contains a random number generator, used for generating new strings from the sequence.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Sequence()	Create an empty sequence.
Sequence(java.lang.String input)	Create a sequence from a single string and no block definitions.
Sequence(java.lang.String input, java.util.List<BlockDefinition> definitions)	Create a sequence from a single string.

Method Summary

Modifier and Type	Method	Description
void	addNullCount(java.lang.Integer count)
void	addTotalCount(java.lang.Integer count)
void	addWheel(Wheel nextWheel)
java.lang.Double	calculateLikelihood(java.lang.String input)	Calculate the probability of a given string being generated by this sequence.
static Sequence	deserialize(byte[] byteArray)	Deserialize a sequence from a byte array.
boolean	equals(java.lang.Object obj)
static Sequence	fromJSONString(java.lang.String jsonString)	Deserialize a sequence from a JSON string
java.lang.String	generate()	Generate a random string based on this sequence, using the current random generator.
java.lang.String	generate(java.lang.String input)	Generate a random string based on this sequence, using a new random generator created with the specified seed.
java.lang.String	generate(java.lang.String input, java.lang.String salt)	Generate a random string based on this sequence, using a new random generator created with the specified seed.
java.lang.String	generate(java.util.Random randomGenerator)	Generate a random string based on this sequence, using the specified random generator.
java.lang.Integer	getNullCount()
java.lang.Integer	getTotalCount()
java.util.List<Wheel>	getWheels()
int	hashCode()
void	reduce(Sequence other)	Combine another sequence into this one by aggregating counts at each level (sequence, wheel, block).
void	resetGenerator()	Resets the random number generator used by this sequence with a random seed.
void	resetGenerator(java.lang.Integer seed)	Resets the random number generator used by this sequence.
void	resetGenerator(java.lang.String input)	Resets the random number generator used by this sequence.
byte[]	serialize()	Serialize this sequence to a byte array.
java.lang.String	toJSONString()	Serialize this sequence 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

Sequence

public Sequence()

Create an empty sequence.

Sequence

public Sequence(java.lang.String input,
                java.util.List<BlockDefinition> definitions)

Create a sequence from a single string.

Parameters:

input - string to characterize

definitions - block definitions used to segment string into blocks

Sequence

public Sequence(java.lang.String input)

Create a sequence from a single string and no block definitions. Will group all characters into a single catchall default block.

Parameters:

input - string to characterize

Method Detail

getTotalCount

public java.lang.Integer getTotalCount()

Returns:

total number of strings characterized by this sequence

addTotalCount

public void addTotalCount(java.lang.Integer count)

Parameters:

count - number of additional strings to add

getNullCount

public java.lang.Integer getNullCount()

Returns:

number of null strings characterized by this sequence

addNullCount

public void addNullCount(java.lang.Integer count)

Parameters:

count - number of additional null strings to add

getWheels

public java.util.List<Wheel> getWheels()

Returns:

wheels comprising the sequence

addWheel

public void addWheel(Wheel nextWheel)

Parameters:

nextWheel - wheel to append

resetGenerator

public void resetGenerator(java.lang.Integer seed)

Resets the random number generator used by this sequence.

Parameters:

seed - seed for the generator

resetGenerator

public void resetGenerator(java.lang.String input)

Resets the random number generator used by this sequence.

Parameters:

input - seed for the generator

resetGenerator

public void resetGenerator()

Resets the random number generator used by this sequence with a random seed.

reduce

public void reduce(Sequence other)

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

Parameters:

other - the other sequence to combine

generate

public java.lang.String generate()

Generate a random string based on this sequence, using the current random generator.

Returns:

the random string

generate

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

Generate a random string based on this sequence, using the specified random generator.

Parameters:

randomGenerator - random number generator to use

Returns:

the random string

generate

public java.lang.String generate(java.lang.String input)

Generate a random string based on this sequence, using a new random generator created with the specified seed.

Parameters:

input - seed for the random generator

Returns:

the random string

generate

public java.lang.String generate(java.lang.String input,
                                 java.lang.String salt)

Generate a random string based on this sequence, using a new random generator created with the specified seed. As a convenience, a salt may also be specified to modify (append to) the seed.

Parameters:

input - base seed for the random generator

salt - salt to append to the seed

Returns:

the random string

calculateLikelihood

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

Calculate the probability of a given string being generated by this sequence.

Parameters:

input - the string to consider

Returns:

probability of generating this exact string

toJSONString

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

Serialize this sequence to a JSON string.

Returns:

the JSON string

Throws:

org.codehaus.jettison.json.JSONException

fromJSONString

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

Deserialize a sequence from a JSON string

Parameters:

jsonString - the JSON string

Returns:

a sequence object represented by the string

Throws:

org.codehaus.jettison.json.JSONException

serialize

public byte[] serialize()
                 throws java.io.IOException

Serialize this sequence to a byte array.

Returns:

the byte array

Throws:

java.io.IOException

deserialize

public static Sequence deserialize(byte[] byteArray)
                            throws java.io.IOException,
                                   java.lang.ClassNotFoundException

Deserialize a sequence from a byte array.

Parameters:

byteArray - the byte array

Returns:

a sequence object represented by the byte array

Throws:

java.io.IOException

java.lang.ClassNotFoundException

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