org.ametys.cms.content.external

Class ExternalizableMetadataHelper

java.lang.Object

org.ametys.cms.content.external.ExternalizableMetadataHelper

public final class ExternalizableMetadataHelper
extends Object

Helper to get and set externalizable metadata of a content. An externalizable metadata is a tri-state metadata with:

• the real value
• the alternative value
• the status, which represents the nature of real value : local or external

Field Summary

Fields

Modifier and Type	Field and Description
private static String	__TEMP_SUFFIX
static String	ALTERNATIVE_SUFFIX Suffix used for the alternative value
static String	STATUS_SUFFIX Suffix used for the status value

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ExternalizableMetadataHelper()

Method Summary

Modifier and Type	Method and Description
private static void	_copyBinaryMetadata(ModifiableBinaryMetadata srcBinaryMetadata, ModifiableBinaryMetadata destBinaryMetadata)
private static void	_copyBinaryMetadata(ModifiableCompositeMetadata metadataHolder, String srcMetadataName, String destMetadataName)
private static void	_copyCompositeMetadata(ModifiableCompositeMetadata metadataHolder, String srcMetadataName, String destMetadataName)
private static boolean	_copyMetadata(ModifiableCompositeMetadata srcMetadataHolder, String srcMetadataName, ModifiableCompositeMetadata destMetadataHolder, String destMetadatName)
private static boolean	_copyMetadata(ModifiableCompositeMetadata metadataHolder, String srcMetadataName, String destMetadatName)
private static void	_copyRichText(ModifiableRichText srcRichText, ModifiableRichText destRichText)
private static void	_copyRichTextMetadata(ModifiableCompositeMetadata metadataHolder, String srcMetadataName, String destMetadataName)
private static boolean	_removeAltAndStatusMetadata(ModifiableCompositeMetadata metadataHolder, String metadataName)
private static boolean	_removeMetadata(ModifiableCompositeMetadata metadataHolder, String metadataName)
private static boolean	_setMetadata(ModifiableCompositeMetadata metadataHolder, String metadataName, Boolean value)
private static boolean	_setMetadata(ModifiableCompositeMetadata metadataHolder, String metadataName, Boolean[] values)
private static boolean	_setMetadata(ModifiableCompositeMetadata metadataHolder, String metadataName, Content content)
private static boolean	_setMetadata(ModifiableCompositeMetadata metadataHolder, String metadataName, Content[] contents)
private static boolean	_setMetadata(ModifiableCompositeMetadata metadataHolder, String metadataName, Date value)
private static boolean	_setMetadata(ModifiableCompositeMetadata metadataHolder, String metadataName, Date[] values)
private static boolean	_setMetadata(ModifiableCompositeMetadata metadataHolder, String metadataName, Double value)
private static boolean	_setMetadata(ModifiableCompositeMetadata metadataHolder, String metadataName, Double[] values)
private static boolean	_setMetadata(ModifiableCompositeMetadata metadataHolder, String metadataName, Long value)
private static boolean	_setMetadata(ModifiableCompositeMetadata metadataHolder, String metadataName, Long[] values)
private static boolean	_setMetadata(ModifiableCompositeMetadata metadataHolder, String metadataName, MultilingualString value)
private static boolean	_setMetadata(ModifiableCompositeMetadata metadataHolder, String metadataName, Object value)
private static boolean	_setMetadata(ModifiableCompositeMetadata metadataHolder, String metadataName, String value)
private static boolean	_setMetadata(ModifiableCompositeMetadata metadataHolder, String metadataName, String[] values)
private static boolean	_setMetadata(ModifiableCompositeMetadata metadataHolder, String metadataName, UserIdentity value)
private static boolean	_setMetadata(ModifiableCompositeMetadata metadataHolder, String metadataName, UserIdentity[] values)
private static boolean	_setNonSimpleMetadata(ModifiableCompositeMetadata metadataHolder, String metadataName, Object value)
static void	copyExternalizableMetadata(ModifiableCompositeMetadata srCompositeMetadata, ModifiableCompositeMetadata destCompositeMetadata, String metadataName) Copy a externalizable metadata.
static BinaryMetadata	getBinaryMetadata(CompositeMetadata metadataHolder, String metadataName, ExternalizableMetadataProvider.ExternalizableMetadataStatus status) Returns the named metadata's value, local or external, as BinaryMetadata.
static ModifiableBinaryMetadata	getBinaryMetadata(ModifiableCompositeMetadata metadataHolder, String metadataName) Get and create if necessary a binary metadata, removing the alternative value and status if exists.
static ModifiableBinaryMetadata	getBinaryMetadata(ModifiableCompositeMetadata metadataHolder, String metadataName, ExternalizableMetadataProvider.ExternalizableMetadataStatus status, boolean createNew) Returns the named metadata's value, local or external, as BinaryMetadata.
static boolean	getBoolean(CompositeMetadata metadataHolder, String metadataName, ExternalizableMetadataProvider.ExternalizableMetadataStatus status) Returns the named metadata's value, local or external, as boolean.
static boolean[]	getBooleanArray(CompositeMetadata metadataHolder, String metadataName, ExternalizableMetadataProvider.ExternalizableMetadataStatus status) Returns the named metadata's value, local or external, as boolean array.
static CompositeMetadata	getCompositeMetadata(CompositeMetadata metadataHolder, String metadataName, ExternalizableMetadataProvider.ExternalizableMetadataStatus status) Returns the named metadata's value, local or external, as a TraversableAmetysObject.
static ModifiableCompositeMetadata	getCompositeMetadata(ModifiableCompositeMetadata metadataHolder, String metadataName) Get and create if necessary a composite metadata, removing the alternative value and status if exists.
static ModifiableCompositeMetadata	getCompositeMetadata(ModifiableCompositeMetadata metadataHolder, String metadataName, ExternalizableMetadataProvider.ExternalizableMetadataStatus status, boolean createNew) Returns the named metadata's value, local or external, as a CompositeMetadata.
static Date	getDate(CompositeMetadata metadataHolder, String metadataName, ExternalizableMetadataProvider.ExternalizableMetadataStatus status) Returns the named metadata's value, local or external, as Date.
static Date[]	getDateArray(CompositeMetadata metadataHolder, String metadataName, ExternalizableMetadataProvider.ExternalizableMetadataStatus status) Returns the named metadata's value, local or external, as Date array.
static double	getDouble(CompositeMetadata metadataHolder, String metadataName, ExternalizableMetadataProvider.ExternalizableMetadataStatus status) Returns the named metadata's value, local or external, as double.
static double[]	getDoubleArray(CompositeMetadata metadataHolder, String metadataName, ExternalizableMetadataProvider.ExternalizableMetadataStatus status) Returns the named metadata's value, local or external, as double array.
static long	getLong(CompositeMetadata metadataHolder, String metadataName, ExternalizableMetadataProvider.ExternalizableMetadataStatus status) Returns the named metadata's value, local or external, as long.
static long[]	getLongArray(CompositeMetadata metadataHolder, String metadataName, ExternalizableMetadataProvider.ExternalizableMetadataStatus status) Returns the named metadata's value, local or external, as long array.
static String	getMetadataName(CompositeMetadata metadataHolder, String metadataName, ExternalizableMetadataProvider.ExternalizableMetadataStatus status) Get the metadata name holding the value with the given status
static MultilingualString	getMultilingualString(CompositeMetadata metadataHolder, String metadataName, ExternalizableMetadataProvider.ExternalizableMetadataStatus status) Returns the metadata value, local or external, as MultilingualString. If the metadata is multi-valued, one of the value is returned. If the metadata does not exist, an UnknownMetadataException is thrown.
static TraversableAmetysObject	getObjectCollection(CompositeMetadata metadataHolder, String metadataName, ExternalizableMetadataProvider.ExternalizableMetadataStatus status) Returns the named metadata's value, local or external, as a TraversableAmetysObject.
static ModifiableTraversableAmetysObject	getObjectCollection(ModifiableCompositeMetadata metadataHolder, String metadataName) Get and create if necessary a object collection metadata, removing the alternative value and status if exists.
static RichText	getRichText(CompositeMetadata metadataHolder, String metadataName, ExternalizableMetadataProvider.ExternalizableMetadataStatus status) Returns the named metadata's value, local or external, as RichText.
static ModifiableRichText	getRichText(ModifiableCompositeMetadata metadataHolder, String metadataName, ExternalizableMetadataProvider.ExternalizableMetadataStatus status, boolean createNew) Returns the named metadata's value, local or external, as RichText.
static ModifiableRichText	getRichTextMetadata(ModifiableCompositeMetadata metadataHolder, String metadataName) Get and create if necessary a RichText metadata, removing the alternative value and status if exists.
static ExternalizableMetadataProvider.ExternalizableMetadataStatus	getStatus(CompositeMetadata metadataHolder, String metadataName) Get the current status of a externalizable metadata
static String	getString(CompositeMetadata metadataHolder, String metadataName, ExternalizableMetadataProvider.ExternalizableMetadataStatus status) Returns the metadata value, local or external, as String. If the metadata is multi-valued, one of the value is returned. If the metadata does not exist, an UnknownMetadataException is thrown.
static String[]	getStringArray(CompositeMetadata metadataHolder, String metadataName, ExternalizableMetadataProvider.ExternalizableMetadataStatus status) Returns the named metadata's value, local or external, as String array.
static CompositeMetadata.MetadataType	getType(CompositeMetadata metadataHolder, String metadataName, ExternalizableMetadataProvider.ExternalizableMetadataStatus status) Returns the type of metadata holding the value with the given status
static UserIdentity	getUser(CompositeMetadata metadataHolder, String metadataName, ExternalizableMetadataProvider.ExternalizableMetadataStatus status) Returns the named metadata's value, local or external, as UserIdentity.
static UserIdentity[]	getUserArray(CompositeMetadata metadataHolder, String metadataName, ExternalizableMetadataProvider.ExternalizableMetadataStatus status) Returns the named metadata's value, local or external, as array of UserIdentity .
static boolean	hasMetadata(CompositeMetadata metadataHolder, String metadataName, ExternalizableMetadataProvider.ExternalizableMetadataStatus status) Determine if the externalizable metadata exists.
static boolean	removeExternalMetadataIfExists(ModifiableCompositeMetadata metadataHolder, String metadataName) Remove the metadata holding the external value if exists
static boolean	removeLocalMetadataIfExists(ModifiableCompositeMetadata metadataHolder, String metadataName) Remove the metadata holding the local value if exists
static boolean	removeMetadataIfExists(ModifiableCompositeMetadata metadataHolder, String metadataName) Remove the metadata, alternative value and status if exist
static boolean	setExternalMetadata(ModifiableCompositeMetadata metadataHolder, String metadataName, Object extValue, boolean forceExternalStatus) Set the external value of a metadata
static ModifiableBinaryMetadata	setLocalBinaryMetadata(ModifiableCompositeMetadata metadataHolder, String metadataName, ExternalizableMetadataProvider.ExternalizableMetadataStatus status) Set a binary metadata as local value and the status of an externalizable metadata
static ModifiableCompositeMetadata	setLocalCompositeMetadata(ModifiableCompositeMetadata metadataHolder, String metadataName, ExternalizableMetadataProvider.ExternalizableMetadataStatus status) Set a composite metadata as local value and the status of an externalizable metadata
static void	setLocalMetadata(ModifiableCompositeMetadata metadataHolder, String metadataName, Object localValue, ExternalizableMetadataProvider.ExternalizableMetadataStatus status) Set the local value and the status of an externalizable metadata
static ModifiableRichText	setLocalRichTextMetadata(ModifiableCompositeMetadata metadataHolder, String metadataName, ExternalizableMetadataProvider.ExternalizableMetadataStatus status) Set a richtext metadata as local value and the status of an externalizable metadata
static boolean	setMetadata(ModifiableCompositeMetadata metadataHolder, String metadataName, Object value) Set the value of a metadata, removing the alternative value and status if exists.
static void	setStatus(ModifiableCompositeMetadata metadataHolder, String metadataName, ExternalizableMetadataProvider.ExternalizableMetadataStatus status) Set the status of an externalizable metadata
static void	updateBinaryMetadataStatus(ModifiableCompositeMetadata metadataHolder, String metadataName, ExternalizableMetadataProvider.ExternalizableMetadataStatus status) Set the status of a binary metadata.
static void	updateCompositeMetadataStatus(ModifiableCompositeMetadata metadataHolder, String metadataName, ExternalizableMetadataProvider.ExternalizableMetadataStatus status) Set the status of a composite metadata.
static void	updateRichTextMetadataStatus(ModifiableCompositeMetadata metadataHolder, String metadataName, ExternalizableMetadataProvider.ExternalizableMetadataStatus status) Set the status of a RichText metadata.
static boolean	updateStatus(ModifiableCompositeMetadata metadataHolder, String metadataName, ExternalizableMetadataProvider.ExternalizableMetadataStatus status) Set the status of an externalizable metadata

Methods inherited from class java.lang.Object

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

Field Detail

ALTERNATIVE_SUFFIX

public static final String ALTERNATIVE_SUFFIX

Suffix used for the alternative value

See Also:

Constant Field Values

STATUS_SUFFIX

public static final String STATUS_SUFFIX

Suffix used for the status value

See Also:

Constant Field Values

__TEMP_SUFFIX

private static final String __TEMP_SUFFIX

See Also:

Constant Field Values

Constructor Detail

ExternalizableMetadataHelper

private ExternalizableMetadataHelper()

Method Detail

setExternalMetadata

public static boolean setExternalMetadata(ModifiableCompositeMetadata metadataHolder,
                                          String metadataName,
                                          Object extValue,
                                          boolean forceExternalStatus)

Set the external value of a metadata

Parameters:

metadataHolder - The parent composite metadata

metadataName - The metadata name

extValue - The external value

forceExternalStatus - Set to true to force new status to external. Set the false to not update the current status.

Returns:

true if changes were made

removeExternalMetadataIfExists

public static boolean removeExternalMetadataIfExists(ModifiableCompositeMetadata metadataHolder,
                                                     String metadataName)

Remove the metadata holding the external value if exists

Parameters:

metadataHolder - The parent composite metadata

metadataName - The metadata name to delete

Returns:

true if a remove was done

setStatus

public static void setStatus(ModifiableCompositeMetadata metadataHolder,
                             String metadataName,
                             ExternalizableMetadataProvider.ExternalizableMetadataStatus status)

Set the status of an externalizable metadata

Parameters:

metadataHolder - The parent composite metadata

metadataName - The metadata name

status - The new status

updateStatus

public static boolean updateStatus(ModifiableCompositeMetadata metadataHolder,
                                   String metadataName,
                                   ExternalizableMetadataProvider.ExternalizableMetadataStatus status)

Set the status of an externalizable metadata

Parameters:

metadataHolder - The parent composite metadata

metadataName - The metadata name

status - The new status

Returns:

true if changes were made

removeLocalMetadataIfExists

public static boolean removeLocalMetadataIfExists(ModifiableCompositeMetadata metadataHolder,
                                                  String metadataName)

Remove the metadata holding the local value if exists

Parameters:

metadataHolder - The parent composite metadata

metadataName - The metadata name to delete

Returns:

true if a remove was done

setLocalMetadata

public static void setLocalMetadata(ModifiableCompositeMetadata metadataHolder,
                                    String metadataName,
                                    Object localValue,
                                    ExternalizableMetadataProvider.ExternalizableMetadataStatus status)

Set the local value and the status of an externalizable metadata

Parameters:

metadataHolder - The parent composite metadata

metadataName - The metadata name

localValue - The local value of metadata

status - The status of metadata

setLocalCompositeMetadata

public static ModifiableCompositeMetadata setLocalCompositeMetadata(ModifiableCompositeMetadata metadataHolder,
                                                                    String metadataName,
                                                                    ExternalizableMetadataProvider.ExternalizableMetadataStatus status)

Set a composite metadata as local value and the status of an externalizable metadata

Parameters:

metadataHolder - The parent composite metadata

metadataName - The metadata name

status - The status of metadata

Returns:

The local composite metadata

setLocalBinaryMetadata

public static ModifiableBinaryMetadata setLocalBinaryMetadata(ModifiableCompositeMetadata metadataHolder,
                                                              String metadataName,
                                                              ExternalizableMetadataProvider.ExternalizableMetadataStatus status)

Set a binary metadata as local value and the status of an externalizable metadata

Parameters:

metadataHolder - The parent composite metadata

metadataName - The metadata name

status - The status of metadata

Returns:

The local binary metadata

updateBinaryMetadataStatus

public static void updateBinaryMetadataStatus(ModifiableCompositeMetadata metadataHolder,
                                              String metadataName,
                                              ExternalizableMetadataProvider.ExternalizableMetadataStatus status)

Set the status of a binary metadata. If status has changed, the local and external values will be inverted.

Parameters:

metadataHolder - The parent composite metadata

metadataName - The metadata name

status - The new status of metadata

updateCompositeMetadataStatus

public static void updateCompositeMetadataStatus(ModifiableCompositeMetadata metadataHolder,
                                                 String metadataName,
                                                 ExternalizableMetadataProvider.ExternalizableMetadataStatus status)

Set the status of a composite metadata. If status has changed, the local and external values will be inverted.

Parameters:

metadataHolder - The parent composite metadata

metadataName - The metadata name

status - The new status of metadata

setLocalRichTextMetadata

public static ModifiableRichText setLocalRichTextMetadata(ModifiableCompositeMetadata metadataHolder,
                                                          String metadataName,
                                                          ExternalizableMetadataProvider.ExternalizableMetadataStatus status)

Set a richtext metadata as local value and the status of an externalizable metadata

Parameters:

metadataHolder - The parent composite metadata

metadataName - The metadata name

status - The status of metadata

Returns:

The local richtext metadata

updateRichTextMetadataStatus

public static void updateRichTextMetadataStatus(ModifiableCompositeMetadata metadataHolder,
                                                String metadataName,
                                                ExternalizableMetadataProvider.ExternalizableMetadataStatus status)

Set the status of a RichText metadata. If status has changed, the local and external values will be inverted.

Parameters:

metadataHolder - The parent composite metadata

metadataName - The metadata name

status - The new status of metadata

copyExternalizableMetadata

public static void copyExternalizableMetadata(ModifiableCompositeMetadata srCompositeMetadata,
                                              ModifiableCompositeMetadata destCompositeMetadata,
                                              String metadataName)

Copy a externalizable metadata. The status, the in-use and alternative values will be copied.

Parameters:

srCompositeMetadata - The source metadata holder

destCompositeMetadata - The metadata holder of destination

metadataName - The metadata name

removeMetadataIfExists

public static boolean removeMetadataIfExists(ModifiableCompositeMetadata metadataHolder,
                                             String metadataName)

Remove the metadata, alternative value and status if exist

Parameters:

metadataHolder - The parent composite metadata

metadataName - The metadata name to delete

Returns:

true if a remove was done

setMetadata

public static boolean setMetadata(ModifiableCompositeMetadata metadataHolder,
                                  String metadataName,
                                  Object value)

Set the value of a metadata, removing the alternative value and status if exists.

Parameters:

metadataHolder - The parent composite metadata

metadataName - The metadata name

value - The value

Returns:

true if changes were made

getRichTextMetadata

public static ModifiableRichText getRichTextMetadata(ModifiableCompositeMetadata metadataHolder,
                                                     String metadataName)

Get and create if necessary a RichText metadata, removing the alternative value and status if exists.

Parameters:

metadataHolder - The parent metadata holder

metadataName - The metadata name

Returns:

the rich text metadata

getBinaryMetadata

public static ModifiableBinaryMetadata getBinaryMetadata(ModifiableCompositeMetadata metadataHolder,
                                                         String metadataName)

Get and create if necessary a binary metadata, removing the alternative value and status if exists.

Parameters:

metadataHolder - The parent metadata holder

metadataName - The metadata name

Returns:

the binary metadata

getCompositeMetadata

public static ModifiableCompositeMetadata getCompositeMetadata(ModifiableCompositeMetadata metadataHolder,
                                                               String metadataName)

Get and create if necessary a composite metadata, removing the alternative value and status if exists.

Parameters:

metadataHolder - The parent metadata holder

metadataName - The metadata name

Returns:

the composite metadata

getObjectCollection

public static ModifiableTraversableAmetysObject getObjectCollection(ModifiableCompositeMetadata metadataHolder,
                                                                    String metadataName)

Get and create if necessary a object collection metadata, removing the alternative value and status if exists.

Parameters:

metadataHolder - The parent metadata holder

metadataName - The metadata name

Returns:

the object collection metadata

_removeAltAndStatusMetadata

private static boolean _removeAltAndStatusMetadata(ModifiableCompositeMetadata metadataHolder,
                                                   String metadataName)

_removeMetadata

private static boolean _removeMetadata(ModifiableCompositeMetadata metadataHolder,
                                       String metadataName)

_setMetadata

private static boolean _setMetadata(ModifiableCompositeMetadata metadataHolder,
                                    String metadataName,
                                    Object value)

_setNonSimpleMetadata

private static boolean _setNonSimpleMetadata(ModifiableCompositeMetadata metadataHolder,
                                             String metadataName,
                                             Object value)

_setMetadata

private static boolean _setMetadata(ModifiableCompositeMetadata metadataHolder,
                                    String metadataName,
                                    String value)

_setMetadata

private static boolean _setMetadata(ModifiableCompositeMetadata metadataHolder,
                                    String metadataName,
                                    String[] values)

_setMetadata

private static boolean _setMetadata(ModifiableCompositeMetadata metadataHolder,
                                    String metadataName,
                                    Date value)

_setMetadata

private static boolean _setMetadata(ModifiableCompositeMetadata metadataHolder,
                                    String metadataName,
                                    Date[] values)

_setMetadata

private static boolean _setMetadata(ModifiableCompositeMetadata metadataHolder,
                                    String metadataName,
                                    Boolean value)

_setMetadata

private static boolean _setMetadata(ModifiableCompositeMetadata metadataHolder,
                                    String metadataName,
                                    Boolean[] values)

_setMetadata

private static boolean _setMetadata(ModifiableCompositeMetadata metadataHolder,
                                    String metadataName,
                                    Long value)

_setMetadata

private static boolean _setMetadata(ModifiableCompositeMetadata metadataHolder,
                                    String metadataName,
                                    Long[] values)

_setMetadata

private static boolean _setMetadata(ModifiableCompositeMetadata metadataHolder,
                                    String metadataName,
                                    Double value)

_setMetadata

private static boolean _setMetadata(ModifiableCompositeMetadata metadataHolder,
                                    String metadataName,
                                    Double[] values)

_setMetadata

private static boolean _setMetadata(ModifiableCompositeMetadata metadataHolder,
                                    String metadataName,
                                    UserIdentity value)

_setMetadata

private static boolean _setMetadata(ModifiableCompositeMetadata metadataHolder,
                                    String metadataName,
                                    UserIdentity[] values)

_setMetadata

private static boolean _setMetadata(ModifiableCompositeMetadata metadataHolder,
                                    String metadataName,
                                    MultilingualString value)

_setMetadata

private static boolean _setMetadata(ModifiableCompositeMetadata metadataHolder,
                                    String metadataName,
                                    Content content)

_setMetadata

private static boolean _setMetadata(ModifiableCompositeMetadata metadataHolder,
                                    String metadataName,
                                    Content[] contents)

_copyCompositeMetadata

private static void _copyCompositeMetadata(ModifiableCompositeMetadata metadataHolder,
                                           String srcMetadataName,
                                           String destMetadataName)

_copyBinaryMetadata

private static void _copyBinaryMetadata(ModifiableCompositeMetadata metadataHolder,
                                        String srcMetadataName,
                                        String destMetadataName)

_copyRichTextMetadata

private static void _copyRichTextMetadata(ModifiableCompositeMetadata metadataHolder,
                                          String srcMetadataName,
                                          String destMetadataName)

_copyMetadata

private static boolean _copyMetadata(ModifiableCompositeMetadata metadataHolder,
                                     String srcMetadataName,
                                     String destMetadatName)

_copyMetadata

private static boolean _copyMetadata(ModifiableCompositeMetadata srcMetadataHolder,
                                     String srcMetadataName,
                                     ModifiableCompositeMetadata destMetadataHolder,
                                     String destMetadatName)

_copyBinaryMetadata

private static void _copyBinaryMetadata(ModifiableBinaryMetadata srcBinaryMetadata,
                                        ModifiableBinaryMetadata destBinaryMetadata)

_copyRichText

private static void _copyRichText(ModifiableRichText srcRichText,
                                  ModifiableRichText destRichText)

getStatus

public static ExternalizableMetadataProvider.ExternalizableMetadataStatus getStatus(CompositeMetadata metadataHolder,
                                                                                    String metadataName)

Get the current status of a externalizable metadata

Parameters:

metadataHolder - The parent composite metadata

metadataName - The metadata name

Returns:

The current status

hasMetadata

public static boolean hasMetadata(CompositeMetadata metadataHolder,
                                  String metadataName,
                                  ExternalizableMetadataProvider.ExternalizableMetadataStatus status)

Determine if the externalizable metadata exists.

Parameters:

metadataHolder - The parent composite metadata

metadataName - the metadataName to test.

status - The status of the metadata to test

Returns:

true if the given metadata exists, false otherwise.

Throws:

AmetysRepositoryException - if an error occurs.

getType

public static CompositeMetadata.MetadataType getType(CompositeMetadata metadataHolder,
                                                     String metadataName,
                                                     ExternalizableMetadataProvider.ExternalizableMetadataStatus status)

Returns the type of metadata holding the value with the given status

Parameters:

metadataHolder - The parent composite metadata

metadataName - metadata name.

status - The status of the metadata to test

Returns:

the type of the given metadata.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getMetadataName

public static String getMetadataName(CompositeMetadata metadataHolder,
                                     String metadataName,
                                     ExternalizableMetadataProvider.ExternalizableMetadataStatus status)

Get the metadata name holding the value with the given status

Parameters:

metadataHolder - The parent composite metadata

metadataName - metadata name.

status - The status of the metadata to test

Returns:

The metadata name

getString

public static String getString(CompositeMetadata metadataHolder,
                               String metadataName,
                               ExternalizableMetadataProvider.ExternalizableMetadataStatus status)

Returns the metadata value, local or external, as String.
If the metadata is multi-valued, one of the value is returned.
If the metadata does not exist, an UnknownMetadataException is thrown.

Parameters:

metadataHolder - The parent composite metadata

metadataName - the metadata name.

status - The status of the metadata to retrieve

Returns:

the metadata value as String.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getStringArray

public static String[] getStringArray(CompositeMetadata metadataHolder,
                                      String metadataName,
                                      ExternalizableMetadataProvider.ExternalizableMetadataStatus status)

Returns the named metadata's value, local or external, as String array.

Parameters:

metadataHolder - The parent composite metadata

metadataName - the metadata name.

status - The status of the metadata to retrieve

Returns:

metadata value as String array.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getMultilingualString

public static MultilingualString getMultilingualString(CompositeMetadata metadataHolder,
                                                       String metadataName,
                                                       ExternalizableMetadataProvider.ExternalizableMetadataStatus status)

Returns the metadata value, local or external, as MultilingualString.
If the metadata is multi-valued, one of the value is returned.
If the metadata does not exist, an UnknownMetadataException is thrown.

Parameters:

metadataHolder - The parent composite metadata

metadataName - the metadata name.

status - The status of the metadata to retrieve

Returns:

the metadata value as MultilingualString.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getDate

public static Date getDate(CompositeMetadata metadataHolder,
                           String metadataName,
                           ExternalizableMetadataProvider.ExternalizableMetadataStatus status)

Returns the named metadata's value, local or external, as Date.

Parameters:

metadataHolder - The parent composite metadata

metadataName - the metadata name.

status - The status of the metadata to retrieve

Returns:

metadata value as Date.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getDateArray

public static Date[] getDateArray(CompositeMetadata metadataHolder,
                                  String metadataName,
                                  ExternalizableMetadataProvider.ExternalizableMetadataStatus status)

Returns the named metadata's value, local or external, as Date array.

Parameters:

metadataHolder - The parent composite metadata

metadataName - the metadata name.

status - The status of the metadata to retrieve

Returns:

metadata value as Date array.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getLong

public static long getLong(CompositeMetadata metadataHolder,
                           String metadataName,
                           ExternalizableMetadataProvider.ExternalizableMetadataStatus status)

Returns the named metadata's value, local or external, as long.

Parameters:

metadataHolder - The parent composite metadata

metadataName - the metadata name.

status - The status of the metadata to retrieve

Returns:

metadata value as long.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getLongArray

public static long[] getLongArray(CompositeMetadata metadataHolder,
                                  String metadataName,
                                  ExternalizableMetadataProvider.ExternalizableMetadataStatus status)

Returns the named metadata's value, local or external, as long array.

Parameters:

metadataHolder - The parent composite metadata

metadataName - the metadata name.

status - The status of the metadata to retrieve

Returns:

metadata value as long array.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getDouble

public static double getDouble(CompositeMetadata metadataHolder,
                               String metadataName,
                               ExternalizableMetadataProvider.ExternalizableMetadataStatus status)

Returns the named metadata's value, local or external, as double.

Parameters:

metadataHolder - The parent composite metadata

metadataName - the metadata name.

status - The status of the metadata to retrieve

Returns:

metadata value as double.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getDoubleArray

public static double[] getDoubleArray(CompositeMetadata metadataHolder,
                                      String metadataName,
                                      ExternalizableMetadataProvider.ExternalizableMetadataStatus status)

Returns the named metadata's value, local or external, as double array.

Parameters:

metadataHolder - The parent composite metadata

metadataName - the metadata name.

status - The status of the metadata to retrieve

Returns:

metadata value as double array.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getBoolean

public static boolean getBoolean(CompositeMetadata metadataHolder,
                                 String metadataName,
                                 ExternalizableMetadataProvider.ExternalizableMetadataStatus status)

Returns the named metadata's value, local or external, as boolean.

Parameters:

metadataHolder - The parent composite metadata

metadataName - the metadata name.

status - The status of the metadata to retrieve

Returns:

metadata value as boolean.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getBooleanArray

public static boolean[] getBooleanArray(CompositeMetadata metadataHolder,
                                        String metadataName,
                                        ExternalizableMetadataProvider.ExternalizableMetadataStatus status)

Returns the named metadata's value, local or external, as boolean array.

Parameters:

metadataHolder - The parent composite metadata

metadataName - the metadata name.

status - The status of the metadata to retrieve

Returns:

metadata value as boolean array.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getUser

public static UserIdentity getUser(CompositeMetadata metadataHolder,
                                   String metadataName,
                                   ExternalizableMetadataProvider.ExternalizableMetadataStatus status)

Returns the named metadata's value, local or external, as UserIdentity.

Parameters:

metadataHolder - The parent composite metadata

metadataName - the metadata name.

status - The status of the metadata to retrieve

Returns:

metadata value as UserIdentity.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getUserArray

public static UserIdentity[] getUserArray(CompositeMetadata metadataHolder,
                                          String metadataName,
                                          ExternalizableMetadataProvider.ExternalizableMetadataStatus status)

Returns the named metadata's value, local or external, as array of UserIdentity .

Parameters:

metadataHolder - The parent composite metadata

metadataName - the metadata name.

status - The status of the metadata to retrieve

Returns:

metadata value as UserIdentity.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getBinaryMetadata

public static BinaryMetadata getBinaryMetadata(CompositeMetadata metadataHolder,
                                               String metadataName,
                                               ExternalizableMetadataProvider.ExternalizableMetadataStatus status)

Returns the named metadata's value, local or external, as BinaryMetadata.

Parameters:

metadataHolder - The parent composite metadata

metadataName - the metadata name.

status - The status of the metadata to retrieve

Returns:

metadata value as BinaryMetadata.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getBinaryMetadata

public static ModifiableBinaryMetadata getBinaryMetadata(ModifiableCompositeMetadata metadataHolder,
                                                         String metadataName,
                                                         ExternalizableMetadataProvider.ExternalizableMetadataStatus status,
                                                         boolean createNew)

Returns the named metadata's value, local or external, as BinaryMetadata.

Parameters:

metadataHolder - The parent composite metadata

metadataName - the metadata name.

status - The status of the metadata to retrieve

createNew - true to create automatically the BinaryMetadata when missing.

Returns:

metadata value as BinaryMetadata.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getRichText

public static RichText getRichText(CompositeMetadata metadataHolder,
                                   String metadataName,
                                   ExternalizableMetadataProvider.ExternalizableMetadataStatus status)

Returns the named metadata's value, local or external, as RichText.

Parameters:

metadataHolder - The parent composite metadata

metadataName - the metadata name.

status - The status of the metadata to retrieve

Returns:

metadata value as RichText.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getRichText

public static ModifiableRichText getRichText(ModifiableCompositeMetadata metadataHolder,
                                             String metadataName,
                                             ExternalizableMetadataProvider.ExternalizableMetadataStatus status,
                                             boolean createNew)

Returns the named metadata's value, local or external, as RichText.

Parameters:

metadataHolder - The parent composite metadata

metadataName - the metadata name.

status - The status of the metadata to retrieve

createNew - true to create automatically the RichText when missing.

Returns:

metadata value as RichText.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getObjectCollection

public static TraversableAmetysObject getObjectCollection(CompositeMetadata metadataHolder,
                                                          String metadataName,
                                                          ExternalizableMetadataProvider.ExternalizableMetadataStatus status)

Returns the named metadata's value, local or external, as a TraversableAmetysObject.

Parameters:

metadataHolder - The parent composite metadata

metadataName - the metadata name.

status - The status of the metadata to retrieve

Returns:

metadata value as a TraversableAmetysObject.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getCompositeMetadata

public static CompositeMetadata getCompositeMetadata(CompositeMetadata metadataHolder,
                                                     String metadataName,
                                                     ExternalizableMetadataProvider.ExternalizableMetadataStatus status)

Returns the named metadata's value, local or external, as a TraversableAmetysObject.

Parameters:

metadataHolder - The parent composite metadata

metadataName - the metadata name.

status - The status of the metadata to retrieve

Returns:

metadata value as a TraversableAmetysObject.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getCompositeMetadata

public static ModifiableCompositeMetadata getCompositeMetadata(ModifiableCompositeMetadata metadataHolder,
                                                               String metadataName,
                                                               ExternalizableMetadataProvider.ExternalizableMetadataStatus status,
                                                               boolean createNew)

Returns the named metadata's value, local or external, as a CompositeMetadata.

Parameters:

metadataHolder - The parent composite metadata

metadataName - the metadata name.

status - The status of the metadata to retrieve

createNew - true to create automatically the CompositeMetadata when missing.

Returns:

metadata value as a CompositeMetadata.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.