Package org.ametys.core.schedule.progression

Class AbstractProgressionTracker

java.lang.Object

org.ametys.core.schedule.progression.AbstractProgressionTracker

All Implemented Interfaces:

ProgressionTracker

Direct Known Subclasses:

ContainerProgressionTracker, SimpleProgressionTracker

public abstract sealed class AbstractProgressionTracker
extends Object
implements ProgressionTracker
permits SimpleProgressionTracker, ContainerProgressionTracker

The abstract implementation of a ProgressionTracker

Field Summary

Fields

Modifier and Type	Field	Description
protected ProgressionTrackerFactory	_factory	The factory
protected I18nizableText	_label	The label
protected ContainerProgressionTracker	_parent	The parent of the tracker

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractProgressionTracker(String id, I18nizableText label, ProgressionTrackerFactory factory, org.slf4j.Logger logger, ContainerProgressionTracker parent)	A constructor with a I18nizableText argument

Method Summary

Modifier and Type	Method	Description
protected String	_getHierarchicalLabel()	Get the hierarchical label
protected org.slf4j.Logger	_getLogger()	Get the logger
protected String	_getLogPrefix()	Get the log prefix
String	getId()	Get the id
I18nizableText	getLabel()	Get the label
ContainerProgressionTracker	getParent()	Get the parent progression tracker
Map<String,Object>	toJSON()	Get the progression tracker as a JSON

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.core.schedule.progression.ProgressionTracker

asPercentage, getIndex, getSize

Field Details

_factory

protected ProgressionTrackerFactory _factory

The factory

_label

protected I18nizableText _label

The label

_parent

protected ContainerProgressionTracker _parent

The parent of the tracker

Constructor Details

AbstractProgressionTracker

protected AbstractProgressionTracker(String id,
 I18nizableText label,
 ProgressionTrackerFactory factory,
 org.slf4j.Logger logger,
 ContainerProgressionTracker parent)

A constructor with a I18nizableText argument

Parameters:

id - The identifier

label - The label

factory - The factory

logger - The logger

parent - The parent of the tracker, null if it does not have one

Method Details

getParent

public ContainerProgressionTracker getParent()

Description copied from interface: ProgressionTracker

Get the parent progression tracker

Specified by:

getParent in interface ProgressionTracker

Returns:

the parent or null

getLabel

public I18nizableText getLabel()

Description copied from interface: ProgressionTracker

Get the label

Specified by:

getLabel in interface ProgressionTracker

Returns:

The label

toJSON

public Map<String,Object> toJSON()

Description copied from interface: ProgressionTracker

Get the progression tracker as a JSON

Specified by:

toJSON in interface ProgressionTracker

Returns:

The progression tracker's JSON

_getLogPrefix

protected String _getLogPrefix()

Get the log prefix

Returns:

The log prefix

_getHierarchicalLabel

protected String _getHierarchicalLabel()

Get the hierarchical label

Returns:

The hierarchical label, or just label if the parent is null

_getLogger

protected org.slf4j.Logger _getLogger()

Get the logger

Returns:

The logger

getId

public String getId()

Description copied from interface: ProgressionTracker

Get the id

Specified by:

getId in interface ProgressionTracker

Returns:

The id