com.gitlab.johnjvester.randomizer

Class RandomGenerator<T>

java.lang.Object

com.gitlab.johnjvester.randomizer.RandomGenerator<T>

public class RandomGenerator<T>
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_DELIMITER Default Delimiter is equal to three tilde (~~~) characters.
static java.lang.String	RATING If the List object includes an Integer field called "rating", this value can be used to provide additional weighting to the randomization.
static int	RATING_LEVEL_HIGH When using randomize() methods which include the int ratingLevel, the RATING_LEVEL_HIGH enables the most aggressive preference toward selecting higher rated items.
static int	RATING_LEVEL_LOW When using randomize() methods which include the int ratingLevel, the RATING_LEVEL_LOW enables the lowest form of weighting for the list items being randomized.
static int	RATING_LEVEL_MEDIUM When using randomize() methods which include the int ratingLevel, the RATING_LEVEL_MEDIUM enables a more aggressive preference toward selecting higher rated items.
static int	RATING_LEVEL_OFF When using randomize() methods which include the int ratingLevel, the RATING_LEVEL_OFF disables the rating functionality.

Constructor Summary

Constructors

Constructor and Description
RandomGenerator()

Method Summary

Modifier and Type	Method and Description
java.util.List<T>	randomize(java.util.List<T> tList) Randomizes the elements in a given tList and returns a new List object of the same type.
java.util.List<T>	randomize(java.util.List<T> tList, java.lang.Boolean useRating) Randomizes the elements in a given tList (which contains a field named "rating"), applies weighting based upon the rating (if enabled), and returns a new List object of the same type.
java.util.List<T>	randomize(java.util.List<T> tList, int ratingLevel) Randomizes the elements in a given tList (which contains a field named "rating"), applies weighting based upon the rating (if enabled), and returns a new List object of the same type.
java.util.List<T>	randomize(java.util.List<T> tList, java.lang.Integer maxResults) Randomizes the elements in a given tList and returns a new List object of the same type, limited to the number provided in the maxResults object.
java.util.List<T>	randomize(java.util.List<T> tList, java.lang.Integer maxResults, java.lang.Boolean useRating) Randomizes the elements in a given tList (which contains a field named "rating"), applies weighting based upon the rating (if enabled), and returns a new List object of the same type - limited to the number provided in the maxResults object.
java.util.List<T>	randomize(java.util.List<T> tList, java.lang.Integer maxResults, int ratingLevel) Randomizes the elements in a given tList (which contains a field named "rating"), applies weighting based upon the rating (if enabled), and returns a new List object of the same type.
java.lang.String	randomize(java.lang.String thisString, java.lang.String thisSeparator) For a given thisString object that contains multiple elements denoted by a thisString separator, a new String will be returned, randomizing the values from the source String object.
java.lang.String	randomize(java.lang.String thisString, java.lang.String thisSeparator, java.lang.Integer maxResults) For a given thisString object that contains multiple elements denoted by a thisString separator, a new String will be returned, randomizing the values from the source String object, limited to the number provided in the maxResults object.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DELIMITER

public static java.lang.String DEFAULT_DELIMITER

Default Delimiter is equal to three tilde (~~~) characters. This is the assumed default delimiter when a delimiter is not specified.

Since:

1.0

RATING

public static java.lang.String RATING

If the List object includes an Integer field called "rating", this value can be used to provide additional weighting to the randomization.

Consider the following two items in the list:

• name = Apple, rating = 1
• name = Orange, rating = 5

When using rating in the randomization in the example above, the Orange object will have a greater number of chances than the Apple object has to be selected. The feature allows certain value to have a greater chance to be selected.

A rating scale of 1 to 5 is recommended, but since version 1.3 this is no longer a requirement.

Since:

1.0

RATING_LEVEL_OFF

public static final int RATING_LEVEL_OFF

When using randomize() methods which include the int ratingLevel, the RATING_LEVEL_OFF disables the rating functionality. This is the same providing a false value to the legacy randomize() methods which included a useRating Boolean object in the signature.

Since:

1.4

RATING_LEVEL_LOW

public static final int RATING_LEVEL_LOW

When using randomize() methods which include the int ratingLevel, the RATING_LEVEL_LOW enables the lowest form of weighting for the list items being randomized.

Usage of the randomize() methods which include the useRating Boolean set to true will utilize this rating level during the randomization process.

This is similar to the original weighting that was provided with versions 1.2 and earlier of RandomGenerator and follows a 1 to 5 ratio from lowest to highest rated items.

Since:

1.4

RATING_LEVEL_MEDIUM

public static final int RATING_LEVEL_MEDIUM

When using randomize() methods which include the int ratingLevel, the RATING_LEVEL_MEDIUM enables a more aggressive preference toward selecting higher rated items.

When compared to RATING_LEVEL_LOW, there is a four times greater emphasis on higher weighted items over lower weighted items at the most extreme difference in rating scale.

Please note - when using randomize() methods which include the Boolean useRating object, the RATING_LEVEL_LOW level of weighting will be utilized, as this is the default rating level.

Since:

1.4

RATING_LEVEL_HIGH

public static final int RATING_LEVEL_HIGH

When using randomize() methods which include the int ratingLevel, the RATING_LEVEL_HIGH enables the most aggressive preference toward selecting higher rated items.

When compared to RATING_LEVEL_LOW, there is a forty times greater emphasis on higher weighted items over lower weighted items at the most extreme difference in rating scale.

Since:

1.4

Constructor Detail

RandomGenerator

public RandomGenerator()

Method Detail

randomize

public java.util.List<T> randomize(java.util.List<T> tList)

Randomizes the elements in a given tList and returns a new List object of the same type. All items in the original tList will be returned.

Parameters:

tList - List object to randomize

Returns:

new List object whose order has been randomized

Since:

1.0

randomize

public java.util.List<T> randomize(java.util.List<T> tList,
                                   java.lang.Boolean useRating)

Randomizes the elements in a given tList (which contains a field named "rating"), applies weighting based upon the rating (if enabled), and returns a new List object of the same type. All items in the original tList will be returned.

If the useRating Boolean is set to true, the randomization will be weighted to favor those with a higher rating field value using the level of weighting provided with the RATING_LEVEL_LOW value.

If other RATING_LEVEL_* levels are required, please use a randomize() method which includes the int ratingLevel object.

Parameters:

tList - List object to randomize

useRating - Boolean to indicate if rating field will be used

Returns:

new List object whose order has been randomized

Since:

1.0

randomize

public java.util.List<T> randomize(java.util.List<T> tList,
                                   int ratingLevel)

Randomizes the elements in a given tList (which contains a field named "rating"), applies weighting based upon the rating (if enabled), and returns a new List object of the same type. All items in the original tList will be returned.

If the ratingLevel is equal to RATING_LEVEL_OFF, the rating processing will be ignored. Otherwise, the RATING_LEVEL_* value will determine the weighting for higher ranked items.

For additional information for each RATING_LEVEL_* value, please review the documentation for each level.

Parameters:

tList - the List to randomize

ratingLevel - the ratingLevel to utilize

Returns:

List

Since:

1.4

randomize

public java.util.List<T> randomize(java.util.List<T> tList,
                                   java.lang.Integer maxResults)

Randomizes the elements in a given tList and returns a new List object of the same type, limited to the number provided in the maxResults object. Passing a maxResults value of zero will return a List object of the same size as the original tList object.

If the maxResults value is greater than the tList size, the return List object will match the size of the original tList.

Parameters:

tList - List object to randomize

maxResults - the size of the return List (specify 0 to return all results)

Returns:

new List object whose order has been randomized and limited to the size of the maxResults object

Since:

1.0

randomize

public java.util.List<T> randomize(java.util.List<T> tList,
                                   java.lang.Integer maxResults,
                                   java.lang.Boolean useRating)

Randomizes the elements in a given tList (which contains a field named "rating"), applies weighting based upon the rating (if enabled), and returns a new List object of the same type - limited to the number provided in the maxResults object. Passing a maxResults value of zero will return a List object of the same size as the original tList object.

If the maxResults value is greater than the tList size, the return List object will match the size of the original tList.

If the useRating Boolean is set to true, the randomization will be weighted to favor those with a higher rating field value using the level of weighting provided with the RATING_LEVEL_LOW value.

If other RATING_LEVEL_* levels are required, please use a randomize() method which includes the int ratingLevel object.

Parameters:

tList - List object to randomize

maxResults - the size of the return List (specify 0 to return all results)

useRating - Boolean to indicate if rating field will be used

Returns:

new List object whose order has been randomized and limited to the size of the maxResults object

Since:

1.0

randomize

public java.util.List<T> randomize(java.util.List<T> tList,
                                   java.lang.Integer maxResults,
                                   int ratingLevel)

Randomizes the elements in a given tList (which contains a field named "rating"), applies weighting based upon the rating (if enabled), and returns a new List object of the same type. All items in the original tList will be returned.

If the ratingLevel is equal to RATING_LEVEL_OFF, the rating processing will be ignored. Otherwise, the RATING_LEVEL_* value will determine the weighting for higher ranked items.

For additional information for each RATING_LEVEL_* value, please review the documentation for each level.

Parameters:

tList - List object to randomize

maxResults - the size of the return List (specify 0 to return all results)

ratingLevel - int to indicate the level of RATING_WEIGHT to apply

Returns:

new List object whose order has been randomized

Since:

1.4

randomize

public java.lang.String randomize(java.lang.String thisString,
                                  java.lang.String thisSeparator)

For a given thisString object that contains multiple elements denoted by a thisString separator, a new String will be returned, randomizing the values from the source String object.

Parameters:

thisString - String object to randomize

thisSeparator - String value of separator for thisString object

Returns:

new String object whose order has been randomized

Since:

1.0

randomize

public java.lang.String randomize(java.lang.String thisString,
                                  java.lang.String thisSeparator,
                                  java.lang.Integer maxResults)

For a given thisString object that contains multiple elements denoted by a thisString separator, a new String will be returned, randomizing the values from the source String object, limited to the number provided in the maxResults object. Passing a maxResults value of zero will return a String object of the same size as the original String object.

If the maxResults value is greater than the number of elements within the thisString object, the return String object will match the size of the original thisString.

Parameters:

thisString - String object to randomize

thisSeparator - String value of separator for thisString object

maxResults - the size of the return String (specify 0 to return all results)

Returns:

new String object whose order has been randomized and limited to the size of the maxResults object

Since:

1.0