be.ac.umons.jsonschematools.generator.exploration

Class ChoicesSequence

java.lang.Object

be.ac.umons.jsonschematools.generator.exploration.ChoicesSequence

All Implemented Interfaces:

Iterable<Choice>

public class ChoicesSequence
extends Object
implements Iterable<Choice>

A finite sequence of choices. When exploring the possibilities described by a schema, multiple choices must be done in a row. This class stores these choices in a sequential order. It is possible to iterate over the choices starting from the first choice, to add new choices, and to remove choices.

Author:

Gaëtan Staquet

Constructor Summary

Constructors

Constructor and Description
ChoicesSequence()

Method Summary

Modifier and Type	Method and Description
boolean	containsChoiceWithNextValue() Checks whether the sequence contains a choice that has a value not yet explored.
Choice	createNewChoice(int nPossibilities, boolean exclusive)
BitSet	getBitSetNextInclusiveSelectionInList(int listSize, int lengthSelection) Gets the next possible BitSet that represents a selection of lengthSelection elements in a list.
Choice	getChoiceForSelectionInList(int listSize, boolean exclusiveChoice, boolean skipFirst) Gets the next possible Choice for selecting one or multiple elements in a list.
Integer	getIndexNextExclusiveSelectionInList(int listSize) Gets the next possible index of a list, i.e., a number between 0 and listSize - 1.
Boolean	getNextBooleanValue() Gets the next Boolean value.
Choice	getNextChoiceInExploration() Gets the next choice for the current exploration and moves forward in the sequence.
Integer	getNextValueBetween(int minValue, int maxValue) Using a Choice, gets the next possible value between minValue and maxValue (both bounds are included).
boolean	hasNextChoiceInExploration() Checks whether there is a choice already in the sequence for the current exploration of the schema.
boolean	hasUnseenValueFurtherInExploration() Checks whether there is a choice with a next value below the current choice in the exploration.
Iterator<Choice>	iterator()
void	popLastChoice() Remove the last choice in the sequence.
void	removeAllChoicesAfterCurrentChoiceInExploration() Removes all the choices that are strictly after the current choice in the exploration.
void	removeAllChoicesComingAfter(Choice choice) Remove all the choices that are after the given choice.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ChoicesSequence

public ChoicesSequence()

Method Detail

createNewChoice

public Choice createNewChoice(int nPossibilities,
                              boolean exclusive)

removeAllChoicesComingAfter

public void removeAllChoicesComingAfter(Choice choice)

Remove all the choices that are after the given choice. That is, the given choice become the last choice in the sequence. If the given choice is not present in the sequence, the function throws an IndexOutOfBoundsException.

Parameters:

choice - The choice that must be the last in the sequence.

popLastChoice

public void popLastChoice()

Remove the last choice in the sequence. If the sequence is empty, throws an IndexOutOfBoundsException.

containsChoiceWithNextValue

public boolean containsChoiceWithNextValue()

Checks whether the sequence contains a choice that has a value not yet explored.

Returns:

True if there is a choice that can take a new value in the sequence.

hasNextChoiceInExploration

public boolean hasNextChoiceInExploration()

Checks whether there is a choice already in the sequence for the current exploration of the schema. See getNextChoiceInExploration to move forward in the exploration.

Returns:

True if the current choice is not the last.

hasUnseenValueFurtherInExploration

public boolean hasUnseenValueFurtherInExploration()

Checks whether there is a choice with a next value below the current choice in the exploration. See getNextChoiceInExploration to move forward in the exploration.

Returns:

True if there is a choice further in the sequence with a next value.

removeAllChoicesAfterCurrentChoiceInExploration

public void removeAllChoicesAfterCurrentChoiceInExploration()

Removes all the choices that are strictly after the current choice in the exploration. See getNextChoiceInExploration to move forward in the exploration.

getNextChoiceInExploration

public Choice getNextChoiceInExploration()

Gets the next choice for the current exploration and moves forward in the sequence. If the exploration has reached the last choice, the function throws an IndexOutOfBoundsException.

Returns:

The next choice.

iterator

public Iterator<Choice> iterator()

Specified by:

iterator in interface Iterable<Choice>

toString

public String toString()

Overrides:

toString in class Object

getNextValueBetween

public Integer getNextValueBetween(int minValue,
                                   int maxValue)

Using a Choice, gets the next possible value between minValue and maxValue (both bounds are included). If there are no other possibilities, throws a RuntimeException.

Parameters:

minValue - The minimal value

maxValue - The maximal value

Returns:

The next possible value

getIndexNextExclusiveSelectionInList

public Integer getIndexNextExclusiveSelectionInList(int listSize)

Gets the next possible index of a list, i.e., a number between 0 and listSize - 1.

Parameters:

listSize - The size of the list

Returns:

The next possible index

getBitSetNextInclusiveSelectionInList

public BitSet getBitSetNextInclusiveSelectionInList(int listSize,
                                                    int lengthSelection)

Gets the next possible BitSet that represents a selection of lengthSelection elements in a list.

Parameters:

listSize - The size of the whole list

lengthSelection - The number of elements to select

Returns:

A BitSet representing the selection

getChoiceForSelectionInList

public Choice getChoiceForSelectionInList(int listSize,
                                          boolean exclusiveChoice,
                                          boolean skipFirst)

Gets the next possible Choice for selecting one or multiple elements in a list.

Parameters:

listSize - The size of the list

exclusiveChoice - Whether one element or multiple elements can be selected at any time

skipFirst - If true, skips the first possible value (i.e., zero)

Returns:

The Choice

getNextBooleanValue

public Boolean getNextBooleanValue()

Gets the next Boolean value.

Returns:

The next Boolean