com.haulmont.cuba.core.app

Class UniqueNumbers

java.lang.Object

com.haulmont.cuba.core.app.UniqueNumbers

All Implemented Interfaces:

UniqueNumbersAPI

@Component(value="cuba_UniqueNumbers")
public class UniqueNumbers
extends java.lang.Object
implements UniqueNumbersAPI

Provides unique numbers based on database sequences.

Field Summary

Fields

Modifier and Type	Field and Description
protected io.jmix.data.Sequences	sequences

Fields inherited from interface com.haulmont.cuba.core.app.UniqueNumbersAPI

NAME

Constructor Summary

Constructors

Constructor and Description
UniqueNumbers()

Method Summary

Modifier and Type	Method and Description
void	deleteSequence(java.lang.String domain) Removes sequence with specified identifier
long	getCurrentNumber(java.lang.String domain) Returns the current value of the sequence.
protected java.lang.String	getDataStore(java.lang.String domain) Override this method if you want to control in what datastore a sequence is created for a particular domain
long	getNextNumber(java.lang.String domain) Returns the next sequence value.
protected java.lang.String	getSequenceName(java.lang.String domain)
void	setCurrentNumber(java.lang.String domain, long value) Set current value for the sequence.

Methods inherited from class java.lang.Object

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

Field Detail

sequences

@Autowired
protected io.jmix.data.Sequences sequences

Constructor Detail

UniqueNumbers

public UniqueNumbers()

Method Detail

getNextNumber

public long getNextNumber(java.lang.String domain)

Description copied from interface: UniqueNumbersAPI

Returns the next sequence value.

Specified by:

getNextNumber in interface UniqueNumbersAPI

Parameters:

domain - sequence identifier

Returns:

next value

getCurrentNumber

public long getCurrentNumber(java.lang.String domain)

Description copied from interface: UniqueNumbersAPI

Returns the current value of the sequence. For some implementations UniqueNumbersAPI.getNextNumber(String) must be called at least once beforehand.

Specified by:

getCurrentNumber in interface UniqueNumbersAPI

Parameters:

domain - sequence identifier

Returns:

current value

setCurrentNumber

public void setCurrentNumber(java.lang.String domain,
                             long value)

Description copied from interface: UniqueNumbersAPI

Set current value for the sequence. Next UniqueNumbersAPI.getCurrentNumber(String) invocation will return value Next UniqueNumbersAPI.getNextNumber(String) invocation will return value + increment

Specified by:

setCurrentNumber in interface UniqueNumbersAPI

Parameters:

domain - sequence identifier

value - value

deleteSequence

public void deleteSequence(java.lang.String domain)

Description copied from interface: UniqueNumbersAPI

Removes sequence with specified identifier

Specified by:

deleteSequence in interface UniqueNumbersAPI

Parameters:

domain - sequence identifier

getDataStore

protected java.lang.String getDataStore(java.lang.String domain)

Override this method if you want to control in what datastore a sequence is created for a particular domain

Parameters:

domain - sequence identifier passed to the interface methods

Returns:

datastore id (by default, the main datastore)

getSequenceName

protected java.lang.String getSequenceName(java.lang.String domain)