fr.cnes.doi.utils

Class UniqueProjectName

java.lang.Object

fr.cnes.doi.utils.UniqueProjectName

@Requirement(reqId="DOI_INTER_030",
             reqName="Interface avec la base de donn\u00e9es de gestion des suffixes DOI")
public final class UniqueProjectName
extends Object

Utils class to generate a unique number from the project name

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	UniqueProjectName.UniqueProjectNameHolder Class to handle the instance

Field Summary

Fields

Modifier and Type	Field and Description
private static org.apache.logging.log4j.Logger	LOGGER logger.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	UniqueProjectName() Constructor

Method Summary

Modifier and Type	Method and Description
private int	convert(long input, String projectName, int maxNumber) Convert the project name into unique long
private int	generateId(int maxNumber) Creates an Id with an uniform distribution.
static UniqueProjectName	getInstance() Access to unique INSTANCE of Settings
List<DOIProject>	getProjects() Returns the projects from the database.
List<DOIProject>	getProjectsFromUser(String userName) Returns the projects associated to an user from the database.
int	getShortName(String project, int length) Build a unique String from the project name
private boolean	isIdUnique(int idToCheck, String projectName) Check if the generated suffixID is unique (does not already exists) or not.

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final org.apache.logging.log4j.Logger LOGGER

logger.

Constructor Detail

UniqueProjectName

private UniqueProjectName()

Constructor

Method Detail

getInstance

public static UniqueProjectName getInstance()

Access to unique INSTANCE of Settings

Returns:

the configuration instance.

getProjects

public List<DOIProject> getProjects()
                             throws DOIDbException

Returns the projects from the database.

Returns:

the projects

Throws:

DOIDbException - When a problem occurs

getProjectsFromUser

public List<DOIProject> getProjectsFromUser(String userName)
                                     throws DOIDbException

Returns the projects associated to an user from the database.

Parameters:

userName - user name

Returns:

the projects

Throws:

DOIDbException - When a problem occurs

generateId

private int generateId(int maxNumber)

Creates an Id with an uniform distribution.

Parameters:

maxNumber - Number max to generate

Returns:

the IdRequirement.DOI_AUTH_010

convert

private int convert(long input,
                    String projectName,
                    int maxNumber)

Convert the project name into unique long

Parameters:

input - Identifier to convert

projectName - the project name to convert

maxNumber - Number max to generate

Returns:

the input that is converted to the base

getShortName

public int getShortName(String project,
                        int length)
                 throws DOIDbException

Build a unique String from the project name

Parameters:

project - the project name

length - length of the short name to generate (the short name must be an int to the length cannot be up to 9)

Returns:

the unique string

Throws:

DOIDbException - When a problem occurs

isIdUnique

private boolean isIdUnique(int idToCheck,
                           String projectName)

Check if the generated suffixID is unique (does not already exists) or not. If not add it associated with the project

Parameters:

idToCheck - the identifier to check

projectName - Project associated to the suffixID

Returns:

true if the Id is OK, false otherwise