org.ametys.plugins.repository.metadata.jcr

Class JCRCompositeMetadata

java.lang.Object

org.ametys.plugins.repository.metadata.jcr.JCRCompositeMetadata

All Implemented Interfaces:

CommentableCompositeMetadata, CompositeMetadata, ModifiableCompositeMetadata

public class JCRCompositeMetadata
extends Object
implements ModifiableCompositeMetadata, CommentableCompositeMetadata

JCR implementation of a CompositeMetadata.
This implementation is based on a child node of the Node supporting the actual content.

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 static Pattern	__metadataNamePattern
private boolean	_lockAlreadyChecked
private Node	_node
private AmetysObjectResolver	_resolver
static String	METADATA_COMMENTS_SUFFIX Comments metadata suffix
static String	METADATA_PREFIX Prefix for jcr properties and nodes names
static String	OBJECT_COLLECTION_METADATA_NODETYPE The JCR nodetype of object collection metadatas.

Constructor Summary

Constructors

Constructor and Description
JCRCompositeMetadata(Node metadataNode, AmetysObjectResolver resolver) Constructor

Method Summary

Modifier and Type	Method and Description
private void	_checkLock()
protected void	_checkMetadataName(String metadataName) Check if the metadata name is valid.
private void	_copyDataFolder(ModifiableFolder srcDataFolder, ModifiableFolder targetDataFolder)
private void	_copyFile(ModifiableFile srcFile, ModifiableFolder targetDataFolder)
private boolean	_getBoolean(String metadataName, Boolean defaultValue, boolean failIfNotExist)
private boolean[]	_getBooleanArray(String metadataName, boolean[] defaultValues, boolean failIfNotExist)
private Date	_getDate(String metadataName, Date defaultValue, boolean failIfNotExist)
private Date[]	_getDateArray(String metadataName, Date[] defaultValues, boolean failIfNotExist)
private double	_getDouble(String metadataName, Double defaultValue, boolean failIfNotExist)
private double[]	_getDoubleArray(String metadataName, double[] defaultValues, boolean failIfNotExist)
private long	_getLong(String metadataName, Long defaultValue, boolean failIfNotExist)
private long[]	_getLongArray(String metadataName, long[] defaultValues, boolean failIfNotExist)
protected static Pattern	_getMetadataNamePattern() Get the metadata name pattern to test validity.
private String	_getString(String metadataName, String defaultValue, boolean failIfNotExist)
private String[]	_getStringArray(String metadataName, String[] defaultValues, boolean failIfNotExist)
private UserIdentity	_getUser(String metadataName, UserIdentity defaultValue, boolean failIfNotExist)
private UserIdentity[]	_getUserArray(String metadataName, UserIdentity[] defaultValues, boolean failIfNotExist)
void	addComment(String metadataName, String text, String author, Date date) Add a metadata comment.
void	copyTo(ModifiableCompositeMetadata metadata) Copy the current CompositeMetadata to the given composite metadata.
void	deleteComment(String metadataName, int index) Delete a metadata comment.
void	editComment(String metadataName, int index, String text, String author, Date date) Edit the text of a metadata comment.
ModifiableBinaryMetadata	getBinaryMetadata(String metadataName) Returns the named metadata's value as BinaryMetadata. If the metadata does not exist, an UnknownMetadataException is thrown.
ModifiableBinaryMetadata	getBinaryMetadata(String metadataName, boolean createNew) Returns the named metadata's value as BinaryMetadata. If the metadata does not exist and createNew is false, 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.
List<MetadataComment>	getComments(String metadataName) Retrieves the comments of a metadata
ModifiableCompositeMetadata	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.
ModifiableCompositeMetadata	getCompositeMetadata(String metadataName, boolean createNew) 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 and createNew is false, 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.
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.
Node	getNode() Retrieves the underlying node.
ModifiableTraversableAmetysObject	getObjectCollection(String metadataName) Returns an object collection metadata as a TraversableAmetysObject .
ModifiableTraversableAmetysObject	getObjectCollection(String metadataName, boolean createNew) Returns an object collection metadata as a TraversableAmetysObject .
ModifiableRichText	getRichText(String metadataName) Returns the named metadata's value as RichText. If the metadata does not exist, an UnknownMetadataException is thrown.
ModifiableRichText	getRichText(String metadataName, boolean createNew) Returns the named metadata's value as RichText. If the metadata does not exist and createNew is false, 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	hasComment(String metadataName, int index) Indicates if a metadata has a comment
boolean	hasComments(String metadataName) Indicates if a metadata has any comments
boolean	hasMetadata(String metadataName) Tests if a metadata with a given name exists.
boolean	isMultiple(String metadataName) Test if the given metadata is multiple.
void	removeMetadata(String metadataName) Removes the given metadata.
void	rename(String newName) Rename the current metadata
void	setMetadata(String metadataName, boolean value) Set a boolean metadata.
void	setMetadata(String metadataName, boolean[] values) Set a multi-valued boolean metadata.
void	setMetadata(String metadataName, Date value) Set a date metadata.
void	setMetadata(String metadataName, Date[] values) Set a multi-valued date metadata.
void	setMetadata(String metadataName, double value) Set a double metadata.
void	setMetadata(String metadataName, double[] values) Set a multi-valued double metadata.
void	setMetadata(String metadataName, long value) Set a long metadata.
void	setMetadata(String metadataName, long[] values) Set a multi-valued long metadata.
void	setMetadata(String metadataName, String value) Set a string metadata.
void	setMetadata(String metadataName, String[] value) Set a multi-valued string metadata.
void	setMetadata(String metadataName, UserIdentity value) Set a UserIdentity metadata.
void	setMetadata(String metadataName, UserIdentity[] values) Set a multi-valued UserIdentity metadata.

Methods inherited from class java.lang.Object

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

Field Detail

METADATA_PREFIX

public static final String METADATA_PREFIX

Prefix for jcr properties and nodes names

See Also:

Constant Field Values

METADATA_COMMENTS_SUFFIX

public static final String METADATA_COMMENTS_SUFFIX

Comments metadata suffix

See Also:

Constant Field Values

OBJECT_COLLECTION_METADATA_NODETYPE

public static final String OBJECT_COLLECTION_METADATA_NODETYPE

The JCR nodetype of object collection metadatas.

See Also:

Constant Field Values

__metadataNamePattern

private static Pattern __metadataNamePattern

_node

private Node _node

_lockAlreadyChecked

private boolean _lockAlreadyChecked

_resolver

private AmetysObjectResolver _resolver

Constructor Detail

JCRCompositeMetadata

public JCRCompositeMetadata(Node metadataNode,
                            AmetysObjectResolver resolver)

Constructor

Parameters:

metadataNode - the Node supporting this composite metadata

resolver - The resolver, used to resolve object collections.

Method Detail

getNode

public Node getNode()

Retrieves the underlying node.

Returns:

the underlying node.

hasMetadata

public boolean hasMetadata(String metadataName)
                    throws AmetysRepositoryException

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.

Throws:

AmetysRepositoryException - if an error occurs.

rename

public void rename(String newName)
            throws AmetysRepositoryException

Description copied from interface: ModifiableCompositeMetadata

Rename the current metadata

Specified by:

rename in interface ModifiableCompositeMetadata

Parameters:

newName - the new name

Throws:

AmetysRepositoryException - if an error occurs.

removeMetadata

public void removeMetadata(String metadataName)
                    throws AmetysRepositoryException

Description copied from interface: ModifiableCompositeMetadata

Removes the given metadata.

Specified by:

removeMetadata in interface ModifiableCompositeMetadata

Parameters:

metadataName - metadata name.

Throws:

UnknownMetadataException - if the 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.

_copyDataFolder

private void _copyDataFolder(ModifiableFolder srcDataFolder,
                             ModifiableFolder targetDataFolder)

_copyFile

private void _copyFile(ModifiableFile srcFile,
                       ModifiableFolder targetDataFolder)

getType

public CompositeMetadata.MetadataType getType(String metadataName)
                                       throws 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.

getString

public String getString(String metadataName)

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.

getString

public String getString(String metadataName,
                        String defaultValue)

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.

_getString

private String _getString(String metadataName,
                          String defaultValue,
                          boolean failIfNotExist)

getStringArray

public String[] getStringArray(String metadataName)
                        throws 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)

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.

_getStringArray

private String[] _getStringArray(String metadataName,
                                 String[] defaultValues,
                                 boolean failIfNotExist)

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.

_getBoolean

private boolean _getBoolean(String metadataName,
                            Boolean defaultValue,
                            boolean failIfNotExist)

getBooleanArray

public boolean[] getBooleanArray(String metadataName)
                          throws 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)

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.

_getBooleanArray

private boolean[] _getBooleanArray(String metadataName,
                                   boolean[] defaultValues,
                                   boolean failIfNotExist)

getDate

public Date getDate(String metadataName)
             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, 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.

_getDate

private Date _getDate(String metadataName,
                      Date defaultValue,
                      boolean failIfNotExist)

getDateArray

public Date[] getDateArray(String metadataName)
                    throws 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)

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.

_getDateArray

private Date[] _getDateArray(String metadataName,
                             Date[] defaultValues,
                             boolean failIfNotExist)

getLong

public long getLong(String metadataName)
             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, 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.

_getLong

private long _getLong(String metadataName,
                      Long defaultValue,
                      boolean failIfNotExist)

getLongArray

public long[] getLongArray(String metadataName)
                    throws 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)

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.

_getLongArray

private long[] _getLongArray(String metadataName,
                             long[] defaultValues,
                             boolean failIfNotExist)

getDouble

public double getDouble(String metadataName)
                 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, 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.

_getDouble

private double _getDouble(String metadataName,
                          Double defaultValue,
                          boolean failIfNotExist)

getDoubleArray

public double[] getDoubleArray(String metadataName)
                        throws 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)

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.

_getDoubleArray

private double[] _getDoubleArray(String metadataName,
                                 double[] defaultValues,
                                 boolean failIfNotExist)

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.

_getUser

private UserIdentity _getUser(String metadataName,
                              UserIdentity defaultValue,
                              boolean failIfNotExist)
                       throws AmetysRepositoryException

Throws:

AmetysRepositoryException

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.

_getUserArray

private UserIdentity[] _getUserArray(String metadataName,
                                     UserIdentity[] defaultValues,
                                     boolean failIfNotExist)
                              throws AmetysRepositoryException

Throws:

AmetysRepositoryException

setMetadata

public void setMetadata(String metadataName,
                        String value)
                 throws AmetysRepositoryException

Description copied from interface: ModifiableCompositeMetadata

Set a string metadata.

Specified by:

setMetadata in interface ModifiableCompositeMetadata

Parameters:

metadataName - the metadata name.

value - the String value of this metadata.

Throws:

AmetysRepositoryException - if the metadata cannot be set.

setMetadata

public void setMetadata(String metadataName,
                        String[] value)
                 throws AmetysRepositoryException

Description copied from interface: ModifiableCompositeMetadata

Set a multi-valued string metadata.

Specified by:

setMetadata in interface ModifiableCompositeMetadata

Parameters:

metadataName - the metadata name.

value - the String array containing values of this metadata.

Throws:

AmetysRepositoryException - if the metadata cannot be set.

setMetadata

public void setMetadata(String metadataName,
                        Date value)
                 throws AmetysRepositoryException

Description copied from interface: ModifiableCompositeMetadata

Set a date metadata.

Specified by:

setMetadata in interface ModifiableCompositeMetadata

Parameters:

metadataName - the metadata name.

value - the Date value of this metadata.

Throws:

AmetysRepositoryException - if the metadata cannot be set.

setMetadata

public void setMetadata(String metadataName,
                        Date[] values)
                 throws AmetysRepositoryException

Description copied from interface: ModifiableCompositeMetadata

Set a multi-valued date metadata.

Specified by:

setMetadata in interface ModifiableCompositeMetadata

Parameters:

metadataName - the metadata name.

values - the Date array containing values of this metadata.

Throws:

AmetysRepositoryException - if the metadata cannot be set.

setMetadata

public void setMetadata(String metadataName,
                        long value)
                 throws AmetysRepositoryException

Description copied from interface: ModifiableCompositeMetadata

Set a long metadata.

Specified by:

setMetadata in interface ModifiableCompositeMetadata

Parameters:

metadataName - the metadata name.

value - the integer value of this metadata.

Throws:

AmetysRepositoryException - if the metadata cannot be set.

setMetadata

public void setMetadata(String metadataName,
                        double value)
                 throws AmetysRepositoryException

Description copied from interface: ModifiableCompositeMetadata

Set a double metadata.

Specified by:

setMetadata in interface ModifiableCompositeMetadata

Parameters:

metadataName - the metadata name.

value - the integer value of this metadata.

Throws:

AmetysRepositoryException - if the metadata cannot be set.

setMetadata

public void setMetadata(String metadataName,
                        long[] values)
                 throws AmetysRepositoryException

Description copied from interface: ModifiableCompositeMetadata

Set a multi-valued long metadata.

Specified by:

setMetadata in interface ModifiableCompositeMetadata

Parameters:

metadataName - the metadata name.

values - the integer array containing values of this metadata.

Throws:

AmetysRepositoryException - if the metadata cannot be set.

setMetadata

public void setMetadata(String metadataName,
                        double[] values)
                 throws AmetysRepositoryException

Description copied from interface: ModifiableCompositeMetadata

Set a multi-valued double metadata.

Specified by:

setMetadata in interface ModifiableCompositeMetadata

Parameters:

metadataName - the metadata name.

values - the integer array containing values of this metadata.

Throws:

AmetysRepositoryException - if the metadata cannot be set.

setMetadata

public void setMetadata(String metadataName,
                        boolean value)
                 throws AmetysRepositoryException

Description copied from interface: ModifiableCompositeMetadata

Set a boolean metadata.

Specified by:

setMetadata in interface ModifiableCompositeMetadata

Parameters:

metadataName - the metadata name.

value - the boolean value of this metadata.

Throws:

AmetysRepositoryException - if the metadata cannot be set.

setMetadata

public void setMetadata(String metadataName,
                        boolean[] values)
                 throws AmetysRepositoryException

Description copied from interface: ModifiableCompositeMetadata

Set a multi-valued boolean metadata.

Specified by:

setMetadata in interface ModifiableCompositeMetadata

Parameters:

metadataName - the metadata name.

values - the boolean array containing values of this metadata.

Throws:

AmetysRepositoryException - if the metadata cannot be set.

setMetadata

public void setMetadata(String metadataName,
                        UserIdentity value)
                 throws AmetysRepositoryException

Description copied from interface: ModifiableCompositeMetadata

Set a UserIdentity metadata.

Specified by:

setMetadata in interface ModifiableCompositeMetadata

Parameters:

metadataName - the metadata name.

value - the UserIdentity value of this metadata.

Throws:

AmetysRepositoryException - if the metadata cannot be set.

setMetadata

public void setMetadata(String metadataName,
                        UserIdentity[] values)
                 throws AmetysRepositoryException

Description copied from interface: ModifiableCompositeMetadata

Set a multi-valued UserIdentity metadata.

Specified by:

setMetadata in interface ModifiableCompositeMetadata

Parameters:

metadataName - the metadata name.

values - the UserIdentity array containing values of this metadata.

Throws:

AmetysRepositoryException - if the metadata cannot be set.

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.

isMultiple

public boolean isMultiple(String metadataName)
                   throws 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.

_checkMetadataName

protected void _checkMetadataName(String metadataName)
                           throws AmetysRepositoryException

Check if the metadata name is valid.

Parameters:

metadataName - The metadata name to check.

Throws:

AmetysRepositoryException - If the metadata name is invalid.

_getMetadataNamePattern

protected static Pattern _getMetadataNamePattern()

Get the metadata name pattern to test validity.

Returns:

The metadata name pattern.

getBinaryMetadata

public ModifiableBinaryMetadata getBinaryMetadata(String metadataName)
                                           throws 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

Specified by:

getBinaryMetadata in interface ModifiableCompositeMetadata

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.

getBinaryMetadata

public ModifiableBinaryMetadata getBinaryMetadata(String metadataName,
                                                  boolean createNew)
                                           throws AmetysRepositoryException

Description copied from interface: ModifiableCompositeMetadata

Returns the named metadata's value as BinaryMetadata.
If the metadata does not exist and createNew is false, an UnknownMetadataException is thrown. Otherwise, the metadata is automatically created.

Specified by:

getBinaryMetadata in interface ModifiableCompositeMetadata

Parameters:

metadataName - the metadata name.

createNew - true to create automatically the BinaryMetadata when missing.

Returns:

the metadata value as BinaryMetadata.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getCompositeMetadata

public ModifiableCompositeMetadata getCompositeMetadata(String metadataName)
                                                 throws 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

Specified by:

getCompositeMetadata in interface ModifiableCompositeMetadata

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.

getCompositeMetadata

public ModifiableCompositeMetadata getCompositeMetadata(String metadataName,
                                                        boolean createNew)
                                                 throws AmetysRepositoryException

Description copied from interface: ModifiableCompositeMetadata

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 and createNew is false, an UnknownMetadataException is thrown. Otherwise, the metadata is automatically created.

Specified by:

getCompositeMetadata in interface ModifiableCompositeMetadata

Parameters:

metadataName - the metadata name.

createNew - true to create automatically the CompositeMetadata when missing.

Returns:

the metadata value as CompositeMetadata.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getRichText

public ModifiableRichText 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

Specified by:

getRichText in interface ModifiableCompositeMetadata

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.

getRichText

public ModifiableRichText getRichText(String metadataName,
                                      boolean createNew)
                               throws UnknownMetadataException,
                                      AmetysRepositoryException

Description copied from interface: ModifiableCompositeMetadata

Returns the named metadata's value as RichText.
If the metadata does not exist and createNew is false, an UnknownMetadataException is thrown. Otherwise, the metadata is automatically created.

Specified by:

getRichText in interface ModifiableCompositeMetadata

Parameters:

metadataName - the metadata name.

createNew - true to create automatically the BinaryMetadata when missing.

Returns:

the metadata value as RichText.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getObjectCollection

public ModifiableTraversableAmetysObject getObjectCollection(String metadataName)
                                                      throws AmetysRepositoryException

Description copied from interface: CompositeMetadata

Returns an object collection metadata as a TraversableAmetysObject
.

Specified by:

getObjectCollection in interface CompositeMetadata

Specified by:

getObjectCollection in interface ModifiableCompositeMetadata

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.

getObjectCollection

public ModifiableTraversableAmetysObject getObjectCollection(String metadataName,
                                                             boolean createNew)
                                                      throws AmetysRepositoryException

Description copied from interface: ModifiableCompositeMetadata

Returns an object collection metadata as a TraversableAmetysObject
. If the metadata does not exist and createNew is false, an UnknownMetadataException is thrown. Otherwise, the metadata is automatically created.

Specified by:

getObjectCollection in interface ModifiableCompositeMetadata

Parameters:

metadataName - the metadata name.

createNew - true to create automatically the CompositeMetadata when missing.

Returns:

the metadata as a TraversableAmetysObject.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getComments

public List<MetadataComment> getComments(String metadataName)

Description copied from interface: CommentableCompositeMetadata

Retrieves the comments of a metadata

Specified by:

getComments in interface CommentableCompositeMetadata

Parameters:

metadataName - The metadata name

Returns:

the list of MetadataComment

hasComments

public boolean hasComments(String metadataName)

Description copied from interface: CommentableCompositeMetadata

Indicates if a metadata has any comments

Specified by:

hasComments in interface CommentableCompositeMetadata

Parameters:

metadataName - The metadata name

Returns:

true if at least one comment exists for this metadata

hasComment

public boolean hasComment(String metadataName,
                          int index)

Description copied from interface: CommentableCompositeMetadata

Indicates if a metadata has a comment

Specified by:

hasComment in interface CommentableCompositeMetadata

Parameters:

metadataName - The metadata name

index - The comment index

Returns:

true if a comment at this index exists for this metadata

addComment

public void addComment(String metadataName,
                       String text,
                       String author,
                       Date date)

Description copied from interface: CommentableCompositeMetadata

Add a metadata comment.

Specified by:

addComment in interface CommentableCompositeMetadata

Parameters:

metadataName - The metadata name

text - The text of the comment

author - The comment author

date - The date of the comment (null to use the current date)

editComment

public void editComment(String metadataName,
                        int index,
                        String text,
                        String author,
                        Date date)

Description copied from interface: CommentableCompositeMetadata

Edit the text of a metadata comment.

Specified by:

editComment in interface CommentableCompositeMetadata

Parameters:

metadataName - The metadata name

index - The comment index

text - The new text for the comment

author - The comment author

date - The date of the comment (null to use the current date)

deleteComment

public void deleteComment(String metadataName,
                          int index)

Description copied from interface: CommentableCompositeMetadata

Delete a metadata comment.

Specified by:

deleteComment in interface CommentableCompositeMetadata

Parameters:

metadataName - The metadata name

index - The comment index

_checkLock

private void _checkLock()
                 throws RepositoryException

Throws:

RepositoryException