fr.paris.lutece.plugins.formengine.service.output

Class IdGenerator

java.lang.Object

fr.paris.lutece.plugins.formengine.service.output.IdGenerator

Direct Known Subclasses:

DatabaseIdGenerator, FileIdGenerator

public abstract class IdGenerator
extends Object

This interface defines an id generator

Constructor Summary

Constructors

Constructor and Description
IdGenerator() Constructor

Method Summary

Methods

Modifier and Type	Method and Description
String	getNewId(Form form) Provides a new id value to the calling form i.e. : - initialises the generator - loads the current id stored - generates a new id value depending on the current value - stores the new id value - return the new id value
protected abstract void	init(Form form) This method is called by getNewId to initialise the settings needed by loadId and storeId
protected abstract String	loadId() Returns the current stored id
protected abstract void	storeId(String strId) Stores a new id
protected abstract String	updateId(Form form, String strCurrentId) This method is the one responsible of generating a new id dependind on the previous id's value

Methods inherited from class java.lang.Object

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

Constructor Detail

IdGenerator

public IdGenerator()

Constructor

Method Detail

init

protected abstract void init(Form form)

This method is called by getNewId to initialise the settings needed by loadId and storeId

Parameters:

form - the form calling the generator

loadId

protected abstract String loadId()

Returns the current stored id

Returns:

the current id

storeId

protected abstract void storeId(String strId)

Stores a new id

Parameters:

strId - the id to store

updateId

protected abstract String updateId(Form form,
              String strCurrentId)

This method is the one responsible of generating a new id dependind on the previous id's value

Parameters:

form - the form calling the idgenerator

strCurrentId - the current value of the id

Returns:

the new value of the id

getNewId

public String getNewId(Form form)

Provides a new id value to the calling form i.e. : - initialises the generator
- loads the current id stored
- generates a new id value depending on the current value
- stores the new id value
- return the new id value

Parameters:

form - the calling form

Returns:

the generated id