org.ametys.plugins.userdirectory.page

Class StaticCompositeMetadata

java.lang.Object

org.ametys.plugins.userdirectory.page.StaticCompositeMetadata

All Implemented Interfaces:

CompositeMetadata

public class StaticCompositeMetadata
extends Object
implements CompositeMetadata

Implementation of CompositeMetadata containing no metadata.

• getMetadataNames returns an empty array
• getXXX(name) and getXXXArray(name) return null (or 0)
• getXXX(name, defaultValue) and getXXXArray(name, defaultValues) return default values.

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.plugins.repository.metadata.CompositeMetadata

CompositeMetadata.MetadataType

Field Summary

Fields

Modifier and Type	Field and Description
private Map<String,Object>	_metadata

Constructor Summary

Constructors

Constructor and Description
StaticCompositeMetadata() Constructor
StaticCompositeMetadata(Map<String,Object> metadata) Constructor

Method Summary

Modifier and Type	Method and Description
void	copyTo(ModifiableCompositeMetadata metadata) Copy the current CompositeMetadata to the given composite metadata.
BinaryMetadata	getBinaryMetadata(String metadataName) Returns the named metadata's value as BinaryMetadata. If the metadata does not exist, an UnknownMetadataException is thrown.
boolean	getBoolean(String metadataName) Returns the named metadata's value as boolean. If the metadata is multi-valued, one of the value is returned. If the metadata does not exist, an UnknownMetadataException is thrown.
boolean	getBoolean(String metadataName, boolean defaultValue) Returns the named metadata's value as boolean. If the metadata is multi-valued, one of the value is returned. If the metadata does not exist, the default value is returned.
boolean[]	getBooleanArray(String metadataName) Returns the named metadata's value as boolean array.
boolean[]	getBooleanArray(String metadataName, boolean[] defaultValues) Returns the named metadata's value as boolean array. If the metadata does not exist, the default values are returned.
CompositeMetadata	getCompositeMetadata(String metadataName) Returns the named metadata's value as CompositeMetadata. If the metadata is multi-valued, one of the value is returned. If the metadata does not exist an UnknownMetadataException is thrown.
Date	getDate(String metadataName) Returns the named metadata's value as Date. If the metadata is multi-valued, one of the value is returned. If the metadata does not exist, an UnknownMetadataException is thrown.
Date	getDate(String metadataName, Date defaultValue) Returns the named metadata's value as Date. If the metadata is multi-valued, one of the value is returned. If the metadata does not exist, the default value is returned.
Date[]	getDateArray(String metadataName) Returns the named metadata's value as Date array.
Date[]	getDateArray(String metadataName, Date[] defaultValues) Returns the named metadata's value as Date array. If the metadata does not exist, the default values are returned.
double	getDouble(String metadataName) Returns the named metadata's value as double. If the metadata is multi-valued, one of the value is returned. If the metadata does not exist, an UnknownMetadataException is thrown.
double	getDouble(String metadataName, double defaultValue) Returns the named metadata's value as double. If the metadata is multi-valued, one of the value is returned. If the metadata does not exist, the default value is returned.
double[]	getDoubleArray(String metadataName) Returns the named metadata's value as double array.
double[]	getDoubleArray(String metadataName, double[] defaultValues) Returns the named metadata's value as double array. If the metadata does not exist, the default values are returned.
String	getLocalizedString(String metadataName, Locale locale) Returns the named metadata's value of a multilingual metadata as String.
String	getLocalizedString(String metadataName, Locale locale, String defaultValue) Returns the named metadata's value of a multilingual metadata as String. If the metadata does not exist, the default value is returned.
long	getLong(String metadataName) Returns the named metadata's value as long. If the metadata is multi-valued, one of the value is returned. If the metadata does not exist, an UnknownMetadataException is thrown.
long	getLong(String metadataName, long defaultValue) Returns the named metadata's value as long. If the metadata is multi-valued, one of the value is returned. If the metadata does not exist, the default value is returned.
long[]	getLongArray(String metadataName) Returns the named metadata's value as long array.
long[]	getLongArray(String metadataName, long[] defaultValues) Returns the named metadata's value as long array. If the metadata does not exist, the default values are returned.
String[]	getMetadataNames() Returns an array containing metadata names.
MultilingualString	getMultilingualString(String metadataName) Returns the named metadata's values of a multilingual metadata.
TraversableAmetysObject	getObjectCollection(String metadataName) Returns an object collection metadata as a TraversableAmetysObject .
RichText	getRichText(String metadataName) Returns the named metadata's value as RichText. If the metadata does not exist, an UnknownMetadataException is thrown.
String	getString(String metadataName) Returns the named metadata's value as String. If the metadata is multi-valued, one of the value is returned. If the metadata does not exist, an UnknownMetadataException is thrown.
String	getString(String metadataName, String defaultValue) Returns the named metadata's value as String. If the metadata is multi-valued, one of the value is returned. If the metadata does not exist, the default value is returned.
String[]	getStringArray(String metadataName) Returns the named metadata's value as String array.
String[]	getStringArray(String metadataName, String[] defaultValues) Returns the named metadata's value as String array. If the metadata does not exist, the default values are returned.
CompositeMetadata.MetadataType	getType(String metadataName) Returns the type of the given metadata.
UserIdentity	getUser(String metadataName) Returns the named metadata's value as UserIdentity. If the metadata does not exist, an UnknownMetadataException is thrown.
UserIdentity	getUser(String metadataName, UserIdentity defaultValue) Returns the named metadata's value as UserIdentity. If the metadata does not exist, the default value is returned.
UserIdentity[]	getUserArray(String metadataName) Returns the named metadata's value as UserIdentity array.
UserIdentity[]	getUserArray(String metadataName, UserIdentity[] defaultValues) Returns the named metadata's value as UserIdentity array. If the metadata does not exist, the default values are returned.
boolean	hasMetadata(String metadataName) Tests if a metadata with a given name exists.
boolean	isMultiple(String metadataName) Test if the given metadata is multiple.

Methods inherited from class java.lang.Object

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

Field Detail

_metadata

private Map<String,Object> _metadata

Constructor Detail

StaticCompositeMetadata

public StaticCompositeMetadata()

Constructor

StaticCompositeMetadata

public StaticCompositeMetadata(Map<String,Object> metadata)

Constructor

Parameters:

metadata - the composite metadata

Method Detail

getBinaryMetadata

public BinaryMetadata getBinaryMetadata(String metadataName)
                                 throws UnknownMetadataException,
                                        AmetysRepositoryException

Description copied from interface: CompositeMetadata

Returns the named metadata's value as BinaryMetadata.
If the metadata does not exist, an UnknownMetadataException is thrown.

Specified by:

getBinaryMetadata in interface CompositeMetadata

Parameters:

metadataName - the metadata name.

Returns:

the metadata value as BinaryMetadata.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getBoolean

public boolean getBoolean(String metadataName)
                   throws UnknownMetadataException,
                          AmetysRepositoryException

Description copied from interface: CompositeMetadata

Returns the named metadata's value as boolean.
If the metadata is multi-valued, one of the value is returned.
If the metadata does not exist, an UnknownMetadataException is thrown.

Specified by:

getBoolean in interface CompositeMetadata

Parameters:

metadataName - the metadata name.

Returns:

the metadata value as boolean.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getBoolean

public boolean getBoolean(String metadataName,
                          boolean defaultValue)
                   throws AmetysRepositoryException

Description copied from interface: CompositeMetadata

Returns the named metadata's value as boolean.
If the metadata is multi-valued, one of the value is returned.
If the metadata does not exist, the default value is returned.

Specified by:

getBoolean in interface CompositeMetadata

Parameters:

metadataName - the metadata name.

defaultValue - the default value.

Returns:

the metadata value as boolean or the default value if metadata is not set.

Throws:

AmetysRepositoryException - if an error occurs.

getBooleanArray

public boolean[] getBooleanArray(String metadataName)
                          throws UnknownMetadataException,
                                 AmetysRepositoryException

Description copied from interface: CompositeMetadata

Returns the named metadata's value as boolean array.

Specified by:

getBooleanArray in interface CompositeMetadata

Parameters:

metadataName - metadata name.

Returns:

metadata value as boolean array.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getBooleanArray

public boolean[] getBooleanArray(String metadataName,
                                 boolean[] defaultValues)
                          throws AmetysRepositoryException

Description copied from interface: CompositeMetadata

Returns the named metadata's value as boolean array.
If the metadata does not exist, the default values are returned.

Specified by:

getBooleanArray in interface CompositeMetadata

Parameters:

metadataName - metadata name.

defaultValues - the default values.

Returns:

metadata value as boolean array or the default values if metadata is not set.

Throws:

AmetysRepositoryException - if an error occurs.

getCompositeMetadata

public CompositeMetadata getCompositeMetadata(String metadataName)
                                       throws UnknownMetadataException,
                                              AmetysRepositoryException

Description copied from interface: CompositeMetadata

Returns the named metadata's value as CompositeMetadata.
If the metadata is multi-valued, one of the value is returned.
If the metadata does not exist an UnknownMetadataException is thrown.

Specified by:

getCompositeMetadata in interface CompositeMetadata

Parameters:

metadataName - the metadata name.

Returns:

the metadata value as CompositeMetadata.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getDate

public Date getDate(String metadataName)
             throws UnknownMetadataException,
                    AmetysRepositoryException

Description copied from interface: CompositeMetadata

Returns the named metadata's value as Date.
If the metadata is multi-valued, one of the value is returned.
If the metadata does not exist, an UnknownMetadataException is thrown.

Specified by:

getDate in interface CompositeMetadata

Parameters:

metadataName - the metadata name.

Returns:

the metadata value as Date.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getDate

public Date getDate(String metadataName,
                    Date defaultValue)
             throws AmetysRepositoryException

Description copied from interface: CompositeMetadata

Returns the named metadata's value as Date.
If the metadata is multi-valued, one of the value is returned.
If the metadata does not exist, the default value is returned.

Specified by:

getDate in interface CompositeMetadata

Parameters:

metadataName - the metadata name.

defaultValue - the default value.

Returns:

the metadata value as Date or the default value if metadata is not set.

Throws:

AmetysRepositoryException - if an error occurs.

getDateArray

public Date[] getDateArray(String metadataName)
                    throws UnknownMetadataException,
                           AmetysRepositoryException

Description copied from interface: CompositeMetadata

Returns the named metadata's value as Date array.

Specified by:

getDateArray in interface CompositeMetadata

Parameters:

metadataName - metadata name.

Returns:

metadata value as Date array.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getDateArray

public Date[] getDateArray(String metadataName,
                           Date[] defaultValues)
                    throws AmetysRepositoryException

Description copied from interface: CompositeMetadata

Returns the named metadata's value as Date array.
If the metadata does not exist, the default values are returned.

Specified by:

getDateArray in interface CompositeMetadata

Parameters:

metadataName - metadata name.

defaultValues - the default values.

Returns:

metadata value as Date array or the default values if metadata is not set.

Throws:

AmetysRepositoryException - if an error occurs.

getDouble

public double getDouble(String metadataName)
                 throws UnknownMetadataException,
                        AmetysRepositoryException

Description copied from interface: CompositeMetadata

Returns the named metadata's value as double.
If the metadata is multi-valued, one of the value is returned.
If the metadata does not exist, an UnknownMetadataException is thrown.

Specified by:

getDouble in interface CompositeMetadata

Parameters:

metadataName - the metadata name.

Returns:

the metadata value as double.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getDouble

public double getDouble(String metadataName,
                        double defaultValue)
                 throws AmetysRepositoryException

Description copied from interface: CompositeMetadata

Returns the named metadata's value as double.
If the metadata is multi-valued, one of the value is returned.
If the metadata does not exist, the default value is returned.

Specified by:

getDouble in interface CompositeMetadata

Parameters:

metadataName - the metadata name.

defaultValue - the default value.

Returns:

the metadata value as double or the default value if metadata is not set.

Throws:

AmetysRepositoryException - if an error occurs.

getDoubleArray

public double[] getDoubleArray(String metadataName)
                        throws UnknownMetadataException,
                               AmetysRepositoryException

Description copied from interface: CompositeMetadata

Returns the named metadata's value as double array.

Specified by:

getDoubleArray in interface CompositeMetadata

Parameters:

metadataName - metadata name.

Returns:

metadata value as double array.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getDoubleArray

public double[] getDoubleArray(String metadataName,
                               double[] defaultValues)
                        throws AmetysRepositoryException

Description copied from interface: CompositeMetadata

Returns the named metadata's value as double array.
If the metadata does not exist, the default values are returned.

Specified by:

getDoubleArray in interface CompositeMetadata

Parameters:

metadataName - metadata name.

defaultValues - the default values.

Returns:

metadata value as double array or the default values if metadata is not set.

Throws:

AmetysRepositoryException - if an error occurs.

getLong

public long getLong(String metadataName)
             throws UnknownMetadataException,
                    AmetysRepositoryException

Description copied from interface: CompositeMetadata

Returns the named metadata's value as long.
If the metadata is multi-valued, one of the value is returned.
If the metadata does not exist, an UnknownMetadataException is thrown.

Specified by:

getLong in interface CompositeMetadata

Parameters:

metadataName - the metadata name.

Returns:

the metadata value as long.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getLong

public long getLong(String metadataName,
                    long defaultValue)
             throws AmetysRepositoryException

Description copied from interface: CompositeMetadata

Returns the named metadata's value as long.
If the metadata is multi-valued, one of the value is returned.
If the metadata does not exist, the default value is returned.

Specified by:

getLong in interface CompositeMetadata

Parameters:

metadataName - the metadata name.

defaultValue - the default value.

Returns:

the metadata value as long or the default value if metadata is not set.

Throws:

AmetysRepositoryException - if an error occurs.

getLongArray

public long[] getLongArray(String metadataName)
                    throws UnknownMetadataException,
                           AmetysRepositoryException

Description copied from interface: CompositeMetadata

Returns the named metadata's value as long array.

Specified by:

getLongArray in interface CompositeMetadata

Parameters:

metadataName - metadata name.

Returns:

metadata value as long array.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getLongArray

public long[] getLongArray(String metadataName,
                           long[] defaultValues)
                    throws AmetysRepositoryException

Description copied from interface: CompositeMetadata

Returns the named metadata's value as long array.
If the metadata does not exist, the default values are returned.

Specified by:

getLongArray in interface CompositeMetadata

Parameters:

metadataName - metadata name.

defaultValues - the default values.

Returns:

metadata value as long array or the default values if metadata is not set.

Throws:

AmetysRepositoryException - if an error occurs.

getMetadataNames

public String[] getMetadataNames()
                          throws AmetysRepositoryException

Description copied from interface: CompositeMetadata

Returns an array containing metadata names.

Specified by:

getMetadataNames in interface CompositeMetadata

Returns:

an array containing metadata names.

Throws:

AmetysRepositoryException - if an error occurs.

getRichText

public RichText getRichText(String metadataName)
                     throws UnknownMetadataException,
                            AmetysRepositoryException

Description copied from interface: CompositeMetadata

Returns the named metadata's value as RichText.
If the metadata does not exist, an UnknownMetadataException is thrown.

Specified by:

getRichText in interface CompositeMetadata

Parameters:

metadataName - the metadata name.

Returns:

the metadata value as RichText.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getString

public String getString(String metadataName)
                 throws UnknownMetadataException,
                        AmetysRepositoryException

Description copied from interface: CompositeMetadata

Returns the named metadata's value as String.
If the metadata is multi-valued, one of the value is returned.
If the metadata does not exist, an UnknownMetadataException is thrown.

Specified by:

getString in interface CompositeMetadata

Parameters:

metadataName - the metadata name.

Returns:

the metadata value as String.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getString

public String getString(String metadataName,
                        String defaultValue)
                 throws AmetysRepositoryException

Description copied from interface: CompositeMetadata

Returns the named metadata's value as String.
If the metadata is multi-valued, one of the value is returned.
If the metadata does not exist, the default value is returned.

Specified by:

getString in interface CompositeMetadata

Parameters:

metadataName - the metadata name.

defaultValue - the default value.

Returns:

the metadata value as String or the default value if metadata is not set.

Throws:

AmetysRepositoryException - if an error occurs.

getStringArray

public String[] getStringArray(String metadataName)
                        throws UnknownMetadataException,
                               AmetysRepositoryException

Description copied from interface: CompositeMetadata

Returns the named metadata's value as String array.

Specified by:

getStringArray in interface CompositeMetadata

Parameters:

metadataName - metadata name.

Returns:

metadata value as String array.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getStringArray

public String[] getStringArray(String metadataName,
                               String[] defaultValues)
                        throws AmetysRepositoryException

Description copied from interface: CompositeMetadata

Returns the named metadata's value as String array.
If the metadata does not exist, the default values are returned.

Specified by:

getStringArray in interface CompositeMetadata

Parameters:

metadataName - metadata name.

defaultValues - the default values.

Returns:

metadata value as String array or the default values if metadata is not set.

Throws:

AmetysRepositoryException - if an error occurs.

getLocalizedString

public String getLocalizedString(String metadataName,
                                 Locale locale)
                          throws UnknownMetadataException,
                                 AmetysRepositoryException

Description copied from interface: CompositeMetadata

Returns the named metadata's value of a multilingual metadata as String.

Specified by:

getLocalizedString in interface CompositeMetadata

Parameters:

metadataName - the metadata name.

locale - the locale of value to retrieve

Returns:

the metadata value as String

Throws:

UnknownMetadataException - if the named metadata does not exist for the given locale.

AmetysRepositoryException - if an error occurs.

getLocalizedString

public String getLocalizedString(String metadataName,
                                 Locale locale,
                                 String defaultValue)
                          throws AmetysRepositoryException

Description copied from interface: CompositeMetadata

Returns the named metadata's value of a multilingual metadata as String.
If the metadata does not exist, the default value is returned.

Specified by:

getLocalizedString in interface CompositeMetadata

Parameters:

metadataName - the metadata name.

locale - the locale of value to retrieve

defaultValue - the default value.

Returns:

the metadata value as String or the default value if metadata is not set.

Throws:

AmetysRepositoryException - if an error occurs.

getMultilingualString

public MultilingualString getMultilingualString(String metadataName)
                                         throws AmetysRepositoryException

Description copied from interface: CompositeMetadata

Returns the named metadata's values of a multilingual metadata.

Specified by:

getMultilingualString in interface CompositeMetadata

Parameters:

metadataName - the metadata name.

Returns:

the metadata values for all existing locales

Throws:

AmetysRepositoryException - if an error occurs.

getType

public CompositeMetadata.MetadataType getType(String metadataName)
                                       throws UnknownMetadataException,
                                              AmetysRepositoryException

Description copied from interface: CompositeMetadata

Returns the type of the given metadata.

Specified by:

getType in interface CompositeMetadata

Parameters:

metadataName - metadata name.

Returns:

the type of the given metadata.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

hasMetadata

public boolean hasMetadata(String metadataName)

Description copied from interface: CompositeMetadata

Tests if a metadata with a given name exists.

Specified by:

hasMetadata in interface CompositeMetadata

Parameters:

metadataName - the metadataName to test.

Returns:

true if the given metadata exists, false otherwise.

isMultiple

public boolean isMultiple(String metadataName)
                   throws UnknownMetadataException,
                          AmetysRepositoryException

Description copied from interface: CompositeMetadata

Test if the given metadata is multiple.

Specified by:

isMultiple in interface CompositeMetadata

Parameters:

metadataName - the metadata name.

Returns:

true if the given metadata is multiple, false otherwise.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

copyTo

public void copyTo(ModifiableCompositeMetadata metadata)
            throws AmetysRepositoryException

Description copied from interface: CompositeMetadata

Copy the current CompositeMetadata to the given composite metadata.

Specified by:

copyTo in interface CompositeMetadata

Parameters:

metadata - The parent composite metadata. Can not be null.

Throws:

AmetysRepositoryException - if an error occurs.

getUser

public UserIdentity getUser(String metadataName)
                     throws AmetysRepositoryException

Description copied from interface: CompositeMetadata

Returns the named metadata's value as UserIdentity.
If the metadata does not exist, an UnknownMetadataException is thrown.

Specified by:

getUser in interface CompositeMetadata

Parameters:

metadataName - the metadata name.

Returns:

the metadata value as user identity.

Throws:

AmetysRepositoryException - if an error occurs.

getUser

public UserIdentity getUser(String metadataName,
                            UserIdentity defaultValue)
                     throws AmetysRepositoryException

Description copied from interface: CompositeMetadata

Returns the named metadata's value as UserIdentity.
If the metadata does not exist, the default value is returned.

Specified by:

getUser in interface CompositeMetadata

Parameters:

metadataName - the metadata name.

defaultValue - the default value.

Returns:

the metadata value as user identity or the default value if metadata is not set.

Throws:

AmetysRepositoryException - if an error occurs.

getUserArray

public UserIdentity[] getUserArray(String metadataName)
                            throws AmetysRepositoryException

Description copied from interface: CompositeMetadata

Returns the named metadata's value as UserIdentity array.

Specified by:

getUserArray in interface CompositeMetadata

Parameters:

metadataName - the metadata name.

Returns:

metadata value as user identity array.

Throws:

AmetysRepositoryException - if an error occurs.

getUserArray

public UserIdentity[] getUserArray(String metadataName,
                                   UserIdentity[] defaultValues)
                            throws AmetysRepositoryException

Description copied from interface: CompositeMetadata

Returns the named metadata's value as UserIdentity array.
If the metadata does not exist, the default values are returned.

Specified by:

getUserArray in interface CompositeMetadata

Parameters:

metadataName - the metadata name.

defaultValues - the default values.

Returns:

metadata value as user identity array or the default values if metadata is not set.

Throws:

AmetysRepositoryException - if an error occurs.

getObjectCollection

public TraversableAmetysObject getObjectCollection(String metadataName)
                                            throws AmetysRepositoryException

Description copied from interface: CompositeMetadata

Returns an object collection metadata as a TraversableAmetysObject
.

Specified by:

getObjectCollection in interface CompositeMetadata

Parameters:

metadataName - the metadata name.

Returns:

the metadata as a TraversableAmetysObject.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.