Package org.ametys.core.schedule.progression

Class ContainerProgressionTracker

java.lang.Object

org.ametys.core.schedule.progression.AbstractProgressionTracker

org.ametys.core.schedule.progression.ContainerProgressionTracker

All Implemented Interfaces:

ProgressionTracker

public final class ContainerProgressionTracker
extends AbstractProgressionTracker

Container implementation that tracks a progression with steps

Field Summary

Fields inherited from class org.ametys.core.schedule.progression.AbstractProgressionTracker

_factory, _label, _parent

Method Summary

Modifier and Type	Method	Description
ContainerProgressionTracker	addContainerStep(String id, I18nizableText label)	Add a step
ContainerProgressionTracker	addContainerStep(String id, I18nizableText label, double weight)	Add a step
SimpleProgressionTracker	addSimpleStep(String id, I18nizableText label)	Add a step
SimpleProgressionTracker	addSimpleStep(String id, I18nizableText label, double weight)	Add a step
double	asPercentage()	Get the progression percentage, that can be simply ProgressionTracker.getIndex() / ProgressionTracker.getSize() or a more complex algorithm when handling children progressions
<T extends ProgressionTracker> T	findStep(String id)	Get a step by its id, it searches for the step in all the tree of progression tracker
<T extends ProgressionTracker> T	getCurrentStep()	Get the current step
long	getIndex()	Get the index of the current step
long	getSize()	Get the size
ProgressionTracker	getStep(int index)	Get a step by its index
<T extends ProgressionTracker> T	getStep(String id)	Get a step by its id in the direct children of this container
void	increment()	Increment the unique-step of the ProgressionTracker of 1 increment
void	increment(long increment)	Increment the unique-step of the ProgressionTracker
void	increment(String id)	Increment the ProgressionTracker of id wanted of 1 increment
void	increment(String id, long increment)	Increment the ProgressionTracker of id wanted of the requested increment
void	setSize(long size)	Initialize the progression with a unique sub step and set its size Use only when steps are not initialized yet
void	setSize(long size, String label)	Initialize the progression with a unique sub step and set its size Use only when steps are not initialized yet
void	setSize(long size, I18nizableText label)	Initialize the progression with a unique sub step and set its size Use only when steps are not initialized yet
void	setSize(String id, long size)	Set the size of a ProgressionTracker by its id
void	setSteps(List<Map<String,Object>> steps)	Set the steps from a JSON
Map<String,Object>	toJSON()	Get the progression tracker as a JSON

Methods inherited from class org.ametys.core.schedule.progression.AbstractProgressionTracker

_getHierarchicalLabel, _getLogger, _getLogPrefix, getId, getLabel, getParent

Methods inherited from class java.lang.Object

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

Method Details

getIndex

public long getIndex()

Description copied from interface: ProgressionTracker

Get the index of the current step

Returns:

The index between [1 and size]

getSize

public long getSize()

Description copied from interface: ProgressionTracker

Get the size

Returns:

The size

asPercentage

public double asPercentage()

Description copied from interface: ProgressionTracker

Get the progression percentage, that can be simply ProgressionTracker.getIndex() / ProgressionTracker.getSize() or a more complex algorithm when handling children progressions

Returns:

The progression (between 0 and 100)

getStep

public ProgressionTracker getStep(int index)
                           throws IllegalArgumentException

Get a step by its index

Parameters:

index - The index between 0 and size-1

Returns:

The ProgressionTracker found

Throws:

IllegalArgumentException - If no progression tracker was found for id

getCurrentStep

public <T extends ProgressionTracker> T getCurrentStep()
                                                throws IllegalArgumentException

Get the current step

Type Parameters:

T - The type of tracker

Returns:

The ProgressionTracker found or null if no step exists

Throws:

IllegalArgumentException - If no step exists

addSimpleStep

public SimpleProgressionTracker addSimpleStep(String id,
 I18nizableText label)

Add a step

Parameters:

label - The label of the step

id - The unique id of the step

Returns:

A new SimpleProgressionTracker of weight 1

addSimpleStep

public SimpleProgressionTracker addSimpleStep(String id,
 I18nizableText label,
 double weight)

Add a step

Parameters:

id - The unique id of the step

label - The label of the step

weight - The weight wanted

Returns:

A new SimpleProgressionTracker

addContainerStep

public ContainerProgressionTracker addContainerStep(String id,
 I18nizableText label)

Add a step

Parameters:

id - The unique id of the step

label - The label of the step

Returns:

A new ContainerProgressionTracker of weight 1

addContainerStep

public ContainerProgressionTracker addContainerStep(String id,
 I18nizableText label,
 double weight)

Add a step

Parameters:

id - The unique id of the step

label - The label of the step

weight - The weight wanted

Returns:

A new ContainerProgressionTracker

toJSON

public Map<String,Object> toJSON()

Description copied from interface: ProgressionTracker

Get the progression tracker as a JSON

Specified by:

toJSON in interface ProgressionTracker

Overrides:

toJSON in class AbstractProgressionTracker

Returns:

The progression tracker's JSON

getStep

public <T extends ProgressionTracker> T getStep(String id)
                                         throws IllegalArgumentException

Get a step by its id in the direct children of this container

Type Parameters:

T - The return type

Parameters:

id - The id

Returns:

The progression tracker found

Throws:

IllegalArgumentException - If no progression tracker was found for the id wanted

findStep

public <T extends ProgressionTracker> T findStep(String id)
                                          throws IllegalArgumentException

Get a step by its id, it searches for the step in all the tree of progression tracker

Type Parameters:

T - The return type

Parameters:

id - The id

Returns:

The progression tracker found

Throws:

IllegalArgumentException - If no progression tracker was found for the id wanted

setSteps

public void setSteps(List<Map<String,Object>> steps)

Set the steps from a JSON

Parameters:

steps - The steps as JSON

setSize

public void setSize(long size)
             throws IllegalArgumentException

Initialize the progression with a unique sub step and set its size Use only when steps are not initialized yet

Parameters:

size - The size to set

Throws:

IllegalArgumentException - If no progression tracker was found for id or if the ProgressionTracker of id wanted is not of type SimpleProgressionTracker

setSize

public void setSize(long size,
 String label)
             throws IllegalArgumentException

Initialize the progression with a unique sub step and set its size Use only when steps are not initialized yet

Parameters:

size - The size to set

label - The unique step label

Throws:

IllegalArgumentException - If no progression tracker was found for id or if the ProgressionTracker of id wanted is not of type SimpleProgressionTracker

setSize

public void setSize(long size,
 I18nizableText label)
             throws IllegalArgumentException

Initialize the progression with a unique sub step and set its size Use only when steps are not initialized yet

Parameters:

size - The size to set

label - The unique step label

Throws:

IllegalArgumentException - If no progression tracker was found for id or if the ProgressionTracker of id wanted is not of type SimpleProgressionTracker

setSize

public void setSize(String id,
 long size)
             throws IllegalArgumentException

Set the size of a ProgressionTracker by its id

Parameters:

id - The id of the ProgressionTracker wanted

size - The size to set

Throws:

IllegalArgumentException - If no progression tracker was found for id or if the ProgressionTracker of id wanted is not of type SimpleProgressionTracker

increment

public void increment()
               throws IllegalArgumentException

Increment the unique-step of the ProgressionTracker of 1 increment

Throws:

IllegalArgumentException - If the ProgressionTracker of id wanted is not of type SimpleProgressionTracker or if no progression tracker was found for id

increment

public void increment(long increment)
               throws IllegalArgumentException

Increment the unique-step of the ProgressionTracker

Parameters:

increment - The increment wanted

Throws:

IllegalArgumentException - If the ProgressionTracker of id wanted is not of type SimpleProgressionTracker or if no progression tracker was found for id

increment

public void increment(String id)
               throws IllegalArgumentException

Increment the ProgressionTracker of id wanted of 1 increment

Parameters:

id - The id

Throws:

IllegalArgumentException - If the ProgressionTracker of id wanted is not of type SimpleProgressionTracker or if no progression tracker was found for id

increment

public void increment(String id,
 long increment)
               throws IllegalArgumentException

Increment the ProgressionTracker of id wanted of the requested increment

Parameters:

id - The id

increment - The increment wanted

Throws:

IllegalArgumentException - If the ProgressionTracker of id wanted is not of type SimpleProgressionTracker or if no progression tracker was found for id