com.tridion.util

Class BinaryVariantUtils

java.lang.Object

com.tridion.util.BinaryVariantUtils

public class BinaryVariantUtils
extends Object

Utils methods for normalizing/denormalizing and VariantIds.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_VARIANT_ID_VALUE The following value represents the variant_id for binaries not specifying a variant id.

Method Summary

Modifier and Type	Method and Description
static String	denormalizeVariantId(String variantId) Helper for obtaining the denormalized variant id.
static boolean	isEmptyVariantId(String variantId) Helper for determining if the variant id is empty.
static String	normalizeVariantId(String variantId) Helper for obtaining the variant id.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_VARIANT_ID_VALUE

public static final String DEFAULT_VARIANT_ID_VALUE

The following value represents the variant_id for binaries not specifying a variant id. (e.g. null or empty) This is required due to oracle not supporting a distinction between empty strings and null values AND at the same time not allowing a primary key constraint on NULLable columns. So a NON-NULL varchar2 column on oracle cannot hold an empty string. Instead of combining null, empty string and a mysterious single-space ' ' string, all databases must translate to/from this default value when variantid is empty or null. The identifier uses characters not normally legal for a variantId so it does not cause conflicts with user-specified variant ids.

See Also:

Constant Field Values

Method Detail

normalizeVariantId

public static String normalizeVariantId(String variantId)

Helper for obtaining the variant id. For database storage variant ids are stored in lowercase and when null or empty they get a specific value DEFAULT_VARIANT_ID_VALUE to overcome database specific problems (no constraints on nullable columns and null being the same as empty on oracle)

Parameters:

variantId - to get the variant id from

Returns:

the variantId representation for database storage/retrieval

denormalizeVariantId

public static String denormalizeVariantId(String variantId)

Helper for obtaining the denormalized variant id. For database storage variant ids are stored in lowercase and when null or empty they get a specific value DEFAULT_VARIANT_ID_VALUE to overcome database specific problems (no constraints on nullable columns and null being the same as empty on oracle). This method maps back variants empty or equal to DEFAULT_VARIANT_ID_VALUE to null and lets untouched all other variants.

Method is defined public, but are not intended as public API. Just for re-use from different package

Parameters:

variantId - The database representation of the variant id.

Returns:

the denormalized variantId representation of the database variantId.

isEmptyVariantId

public static boolean isEmptyVariantId(String variantId)

Helper for determining if the variant id is empty. For database storage variant ids are stored in lowercase and when null or empty they get a specific value DEFAULT_VARIANT_ID_VALUE to overcome database specific problems (no constraints on nullable columns and null being the same as empty on oracle) Method is defined public, but are not intended as public API. Just for re-use from different package

Parameters:

variantId - variant id to check for 'emptiness'

Returns:

true when the variantId is considered empty