sirius.biz.jdbc.codelists

Class CodeLists

java.lang.Object

sirius.biz.jdbc.codelists.CodeLists

public class CodeLists
extends Object

Provides a framework to map string values (codes) to values defined by the user.

A code list is referenced by its unique name (code) and can be used to map codes to user defined texts. Additionally a second values (additionalValue) can be stored per code.

The required data is stored via CodeList and CodeListEntry. The CodeListController is used to provide an administration GUI for the user.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FRAMEWORK_CODE_LISTS Names the framework which must be enabled to activate the code lists feature.

Constructor Summary

Constructors

Constructor and Description
CodeLists()

Method Summary

Modifier and Type	Method and Description
List<CodeListEntry>	getEntries(String codeList) Returns all entries of a code list.
String	getRequiredValue(String codeList, String code) Returns the value from the given code list associated with the given code or throws an exception if no matching entry exists.
String	getValue(String codeList, String code) Returns the value from the given code list associated with the given code.
sirius.kernel.commons.Tuple<String,String>	getValues(String codeList, String code) Returns the value and the additionalValue associated with the given code.
boolean	hasValue(String codeList, String code) Determines if the code list contains the given code.

Methods inherited from class java.lang.Object

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

Field Detail

FRAMEWORK_CODE_LISTS

public static final String FRAMEWORK_CODE_LISTS

Names the framework which must be enabled to activate the code lists feature.

See Also:

Constant Field Values

Constructor Detail

CodeLists

public CodeLists()

Method Detail

getValue

@Nullable
public String getValue(@Nonnull
                                 String codeList,
                                 @Nullable
                                 String code)

Returns the value from the given code list associated with the given code.

If no matching entry exists, the code itself will be returned.

Parameters:

codeList - the code list to search in

code - the code to lookup

Returns:

the value associated with the code or the code itself if no value exists

hasValue

public boolean hasValue(@Nonnull
                        String codeList,
                        @Nullable
                        String code)

Determines if the code list contains the given code.

Parameters:

codeList - the code list to search in

code - the code to check

Returns:

true if the code exists, false otherwise

getRequiredValue

public String getRequiredValue(@Nonnull
                               String codeList,
                               @Nonnull
                               String code)

Returns the value from the given code list associated with the given code or throws an exception if no matching entry exists.

Parameters:

codeList - the code list to search in

code - the code to lookup

Returns:

the value associated with the code

Throws:

sirius.kernel.health.HandledException - if no entry exists for the given code

getValues

public sirius.kernel.commons.Tuple<String,String> getValues(@Nonnull
                                                            String codeList,
                                                            @Nonnull
                                                            String code)

Returns the value and the additionalValue associated with the given code.

If no matching entry exists, the code itself will be returned as value and the additional value (the second of the tuple) will be null.

Parameters:

codeList - the code list to search in

code - the code to lookup

Returns:

the value and the additional value associated with the given code, wrapped as tuple

getEntries

public List<CodeListEntry> getEntries(@Nonnull
                                      String codeList)

Returns all entries of a code list.

Parameters:

codeList - the code list to fetch entries from

Returns:

a list of all avilable entries in the given code list, sorted by priority