Package org.ametys.plugins.repository.data.repositorydata.impl

Class JCRRepositoryData

java.lang.Object

org.ametys.plugins.repository.data.repositorydata.impl.JCRRepositoryData

All Implemented Interfaces:

ModifiableRepositoryData, RepositoryData

public class JCRRepositoryData
extends Object
implements ModifiableRepositoryData

Class for data values management in JCR repository

Field Summary

Fields

Modifier and Type	Field	Description
private static Map<Integer,String>	__DATA_TYPES
private String	_defaultPrefix
private boolean	_lockAlreadyChecked
private Node	_node

Fields inherited from interface org.ametys.plugins.repository.data.repositorydata.ModifiableRepositoryData

DATA_NAME_PATTERN

Fields inherited from interface org.ametys.plugins.repository.data.repositorydata.RepositoryData

BOOLEAN_REPOSITORY_DATA_TYPE, CALENDAR_REPOSITORY_DATA_TYPE, DOUBLE_REPOSITORY_DATA_TYPE, LONG_REPOSITORY_DATA_TYPE, STREAM_REPOSITORY_DATA_TYPE, STRING_REPOSITORY_DATA_TYPE

Constructor Summary

Constructors

Constructor	Description
JCRRepositoryData(Node node)	Creates a JCR repository data from the given node
JCRRepositoryData(Node node, String defaultPrefix)	Creates a JCR repository data from the given node

Method Summary

Modifier and Type	Method	Description
private void	_checkDataName(String name, String prefix)
private void	_checkLock()
private String	_getFullName(String name, String prefix)
private Value	_getValue(String name, String prefix)
private Value[]	_getValues(String name, String prefix)
ModifiableRepositoryData	addRepositoryData(String name, String dataTypeName, String prefix)	Creates a repository data and stores it in the repository with the given name
RepositoryData[]	getAllRepositoryData(String name, String prefix)	Retrieves the values of all the repository data stored in the repository with the given name
Boolean	getBoolean(String name, String prefix)	Retrieves the value of the boolean data stored in the repository with the given name
Boolean[]	getBooleans(String name, String prefix)	Retrieves the values of the multiple boolean data stored in the repository with the given name
Set<String>	getDataNames(String prefix)	Retrieves the names of data in this repository data with the given prefix
Calendar	getDate(String name, String prefix)	Retrieves the value of the date data stored as calendar in the repository with the given name
Calendar[]	getDates(String name, String prefix)	Retrieves the values of the multiple date data as calendar stored in the repository with the given name
String	getDefaultPrefix()	Retrieves the default prefix
Double	getDouble(String name, String prefix)	Retrieves the value of the double data stored in the repository with the given name
Double[]	getDoubles(String name, String prefix)	Retrieves the values of the multiple double data stored in the repository with the given name
Long	getLong(String name, String prefix)	Retrieves the value of the long data stored in the repository with the given name
Long[]	getLongs(String name, String prefix)	Retrieves the values of the multiple long data stored in the repository with the given name
String	getName()	Retrieves the name of the current repository data, excluding its prefix
protected String	getName(Node node)	Retrieves the name of the given node, excluding its prefix
Node	getNode()	Retrieves the underlying node.
ModifiableRepositoryData	getRepositoryData(String name, String prefix)	Retrieves the value of the repository data stored in the repository with the given name
Session	getSession()	Retrieves the current session
InputStream	getStream(String name, String prefix)	Retrieves the value of the stream data stored in the repository with the given name
Long	getStreamLength(String name, String prefix)	Retrieves the length of the value of the stream data stored in the repository with the given name
InputStream[]	getStreams(String name, String prefix)	Retrieves the values of the multiple stream data stored in the repository with the given name
String	getString(String name, String prefix)	Retrieves the value of the string data stored in the repository with the given name
String[]	getStrings(String name, String prefix)	Retrieves the values of the multiple string data stored in the repository with the given name
String	getType(String name, String prefix)	Retrieves the type of the value for the data stored in the repository with the given name
boolean	hasValue(String name, String prefix)	Checks if there is a value for the data stored in the repository with the given name
boolean	isMultiple(String name, String prefix)	Checks if the value for the data stored in the repository with the given name is multiple
void	removeValue(String name, String prefix)	Removes the value of the data stored in the repository with the given name
void	rename(String newName, String prefix)	Rename the current repository data
void	setValue(String name, InputStream value, String prefix)	Sets the value of the input stream data stored in the repository with the given name
void	setValue(String name, Boolean value, String prefix)	Sets the value of the boolean data stored in the repository with the given name
void	setValue(String name, Double value, String prefix)	Sets the value of the double data stored in the repository with the given name
void	setValue(String name, Long value, String prefix)	Sets the value of the long data stored in the repository with the given name
void	setValue(String name, String value, String prefix)	Sets the value of the string data stored in the repository with the given name
void	setValue(String name, Calendar value, String prefix)	Sets the value of the date data stored in the repository with the given name
void	setValues(String name, InputStream[] values, String prefix)	Sets the values of the multiple input stream data stored in the repository with the given name
void	setValues(String name, Boolean[] values, String prefix)	Sets the values of the multiple boolean data stored in the repository with the given name
void	setValues(String name, Double[] values, String prefix)	Sets the values of the multiple double data stored in the repository with the given name
void	setValues(String name, Long[] values, String prefix)	Sets the values of the multiple long data stored in the repository with the given name
void	setValues(String name, String[] values, String prefix)	Sets the values of the multiple string data stored in the repository with the given name
void	setValues(String name, Calendar[] values, String prefix)	Sets the values of the multiple date data stored in the repository with the given name
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.plugins.repository.data.repositorydata.ModifiableRepositoryData

addRepositoryData, getRepositoryData, removeValue, rename, setValue, setValue, setValue, setValue, setValue, setValue, setValues, setValues, setValues, setValues, setValues, setValues

Methods inherited from interface org.ametys.plugins.repository.data.repositorydata.RepositoryData

getAllDataNames, getAllRepositoryData, getBoolean, getBooleans, getDataNames, getDate, getDates, getDouble, getDoubles, getLong, getLongs, getStream, getStreamLength, getStreams, getString, getStrings, getType, hasValue, isMultiple

Field Detail

__DATA_TYPES

private static final Map<Integer,String> __DATA_TYPES

_node

private Node _node

_lockAlreadyChecked

private boolean _lockAlreadyChecked

_defaultPrefix

private String _defaultPrefix

Constructor Detail

JCRRepositoryData

public JCRRepositoryData(Node node)

Creates a JCR repository data from the given node

Parameters:

node - the Node supporting this repository data

JCRRepositoryData

public JCRRepositoryData(Node node,
                         String defaultPrefix)

Creates a JCR repository data from the given node

Parameters:

node - the Node supporting this repository data

defaultPrefix - prefix to use for properties and child nodes

Method Detail

getString

public String getString(String name,
                        String prefix)

Description copied from interface: RepositoryData

Retrieves the value of the string data stored in the repository with the given name

Specified by:

getString in interface RepositoryData

Parameters:

name - name of the data

prefix - prefix of the data name, to use instead of the default one.

Returns:

the value of the data

getStrings

public String[] getStrings(String name,
                           String prefix)

Description copied from interface: RepositoryData

Retrieves the values of the multiple string data stored in the repository with the given name

Specified by:

getStrings in interface RepositoryData

Parameters:

name - name of the data

prefix - prefix of the data name, to use instead of the default one.

Returns:

the values of the data as a string array

getDate

public Calendar getDate(String name,
                        String prefix)

Description copied from interface: RepositoryData

Retrieves the value of the date data stored as calendar in the repository with the given name

Specified by:

getDate in interface RepositoryData

Parameters:

name - name of the data

prefix - prefix of the data name, to use instead of the default one.

Returns:

the value of the data

getDates

public Calendar[] getDates(String name,
                           String prefix)

Description copied from interface: RepositoryData

Retrieves the values of the multiple date data as calendar stored in the repository with the given name

Specified by:

getDates in interface RepositoryData

Parameters:

name - name of the data

prefix - prefix of the data name, to use instead of the default one.

Returns:

the values of the data as a date array

getLong

public Long getLong(String name,
                    String prefix)

Description copied from interface: RepositoryData

Retrieves the value of the long data stored in the repository with the given name

Specified by:

getLong in interface RepositoryData

Parameters:

name - name of the data

prefix - prefix of the data name, to use instead of the default one.

Returns:

the value of the data

getLongs

public Long[] getLongs(String name,
                       String prefix)

Description copied from interface: RepositoryData

Retrieves the values of the multiple long data stored in the repository with the given name

Specified by:

getLongs in interface RepositoryData

Parameters:

name - name of the data

prefix - prefix of the data name, to use instead of the default one.

Returns:

the values of the data as a long array

getDouble

public Double getDouble(String name,
                        String prefix)

Description copied from interface: RepositoryData

Retrieves the value of the double data stored in the repository with the given name

Specified by:

getDouble in interface RepositoryData

Parameters:

name - name of the data

prefix - prefix of the data name, to use instead of the default one.

Returns:

the value of the data

getDoubles

public Double[] getDoubles(String name,
                           String prefix)

Description copied from interface: RepositoryData

Retrieves the values of the multiple double data stored in the repository with the given name

Specified by:

getDoubles in interface RepositoryData

Parameters:

name - name of the data

prefix - prefix of the data name, to use instead of the default one.

Returns:

the values of the data as a double array

getBoolean

public Boolean getBoolean(String name,
                          String prefix)

Description copied from interface: RepositoryData

Retrieves the value of the boolean data stored in the repository with the given name

Specified by:

getBoolean in interface RepositoryData

Parameters:

name - name of the data

prefix - prefix of the data name, to use instead of the default one.

Returns:

the value of the data

getBooleans

public Boolean[] getBooleans(String name,
                             String prefix)

Description copied from interface: RepositoryData

Retrieves the values of the multiple boolean data stored in the repository with the given name

Specified by:

getBooleans in interface RepositoryData

Parameters:

name - name of the data

prefix - prefix of the data name, to use instead of the default one.

Returns:

the values of the data as a boolean array

getStreams

public InputStream[] getStreams(String name,
                                String prefix)

Description copied from interface: RepositoryData

Retrieves the values of the multiple stream data stored in the repository with the given name

Specified by:

getStreams in interface RepositoryData

Parameters:

name - name of the data

prefix - prefix of the data name, to use instead of the default one.

Returns:

the values of the data as an input stream array

getStream

public InputStream getStream(String name,
                             String prefix)

Description copied from interface: RepositoryData

Retrieves the value of the stream data stored in the repository with the given name

Specified by:

getStream in interface RepositoryData

Parameters:

name - name of the data

prefix - prefix of the data name, to use instead of the default one.

Returns:

the value of the data

getStreamLength

public Long getStreamLength(String name,
                            String prefix)

Description copied from interface: RepositoryData

Retrieves the length of the value of the stream data stored in the repository with the given name

Specified by:

getStreamLength in interface RepositoryData

Parameters:

name - name of the data

prefix - prefix of the data name, to use instead of the default one.

Returns:

the length of the value of the data

_getValue

private Value _getValue(String name,
                        String prefix)

_getValues

private Value[] _getValues(String name,
                           String prefix)

getRepositoryData

public ModifiableRepositoryData getRepositoryData(String name,
                                                  String prefix)

Description copied from interface: RepositoryData

Retrieves the value of the repository data stored in the repository with the given name

Specified by:

getRepositoryData in interface ModifiableRepositoryData

Specified by:

getRepositoryData in interface RepositoryData

Parameters:

name - name of the data

prefix - prefix of the data name, to use instead of the default one.

Returns:

the value of the data

getAllRepositoryData

public RepositoryData[] getAllRepositoryData(String name,
                                             String prefix)

Description copied from interface: RepositoryData

Retrieves the values of all the repository data stored in the repository with the given name

Specified by:

getAllRepositoryData in interface RepositoryData

Parameters:

name - name of the data

prefix - prefix of the data name, to use instead of the default one.

Returns:

the values of the data

getDataNames

public Set<String> getDataNames(String prefix)
                         throws AmetysRepositoryException

Description copied from interface: RepositoryData

Retrieves the names of data in this repository data with the given prefix

Specified by:

getDataNames in interface RepositoryData

Parameters:

prefix - prefix of the data names to retrieve. If null, retrieves all the data names of this repository data

Returns:

the names of data by this repository data

Throws:

AmetysRepositoryException

getName

public String getName()

Description copied from interface: RepositoryData

Retrieves the name of the current repository data, excluding its prefix

Specified by:

getName in interface RepositoryData

Returns:

the name of the current repository data

getName

protected String getName(Node node)
                  throws RepositoryException

Retrieves the name of the given node, excluding its prefix

Parameters:

node - the node

Returns:

the name of the given node

Throws:

RepositoryException - if an error occurs

hasValue

public boolean hasValue(String name,
                        String prefix)

Description copied from interface: RepositoryData

Checks if there is a value for the data stored in the repository with the given name

Specified by:

hasValue in interface RepositoryData

Parameters:

name - name of the data

prefix - prefix of the data name, to use instead of the default one.

Returns:

true if there is value for the data, false otherwise

getType

public String getType(String name,
                      String prefix)
               throws UnknownDataException

Description copied from interface: RepositoryData

Retrieves the type of the value for the data stored in the repository with the given name

Specified by:

getType in interface RepositoryData

Parameters:

name - name of the data

prefix - prefix of the data name, to use instead of the default one.

Returns:

the value's type of the data

Throws:

UnknownDataException - if there is no data stored with the given name

isMultiple

public boolean isMultiple(String name,
                          String prefix)
                   throws UnknownDataException

Description copied from interface: RepositoryData

Checks if the value for the data stored in the repository with the given name is multiple

Specified by:

isMultiple in interface RepositoryData

Parameters:

name - name of the data

prefix - prefix of the data name, to use instead of the default one.

Returns:

true if the value for the data is multiple, false otherwise

Throws:

UnknownDataException - if there is no data stored with the given name

rename

public void rename(String newName,
                   String prefix)

Description copied from interface: ModifiableRepositoryData

Rename the current repository data

Specified by:

rename in interface ModifiableRepositoryData

Parameters:

newName - the new name

prefix - prefix of the data name, to use instead of the default one.

setValue

public void setValue(String name,
                     String value,
                     String prefix)

Description copied from interface: ModifiableRepositoryData

Sets the value of the string data stored in the repository with the given name

Specified by:

setValue in interface ModifiableRepositoryData

Parameters:

name - name of the data

value - the value to set

prefix - prefix of the data name, to use instead of the default one.

setValues

public void setValues(String name,
                      String[] values,
                      String prefix)

Description copied from interface: ModifiableRepositoryData

Sets the values of the multiple string data stored in the repository with the given name

Specified by:

setValues in interface ModifiableRepositoryData

Parameters:

name - name of the data

values - the value to set

prefix - prefix of the data name, to use instead of the default one.

setValue

public void setValue(String name,
                     Calendar value,
                     String prefix)

Description copied from interface: ModifiableRepositoryData

Sets the value of the date data stored in the repository with the given name

Specified by:

setValue in interface ModifiableRepositoryData

Parameters:

name - name of the data

value - the value to set

prefix - prefix of the data name, to use instead of the default one.

setValues

public void setValues(String name,
                      Calendar[] values,
                      String prefix)

Description copied from interface: ModifiableRepositoryData

Sets the values of the multiple date data stored in the repository with the given name

Specified by:

setValues in interface ModifiableRepositoryData

Parameters:

name - name of the data

values - the value to set

prefix - prefix of the data name, to use instead of the default one.

setValue

public void setValue(String name,
                     Long value,
                     String prefix)

Description copied from interface: ModifiableRepositoryData

Sets the value of the long data stored in the repository with the given name

Specified by:

setValue in interface ModifiableRepositoryData

Parameters:

name - name of the data

value - the value to set

prefix - prefix of the data name, to use instead of the default one.

setValues

public void setValues(String name,
                      Long[] values,
                      String prefix)

Description copied from interface: ModifiableRepositoryData

Sets the values of the multiple long data stored in the repository with the given name

Specified by:

setValues in interface ModifiableRepositoryData

Parameters:

name - name of the data

values - the value to set

prefix - prefix of the data name, to use instead of the default one.

setValue

public void setValue(String name,
                     Double value,
                     String prefix)

Description copied from interface: ModifiableRepositoryData

Sets the value of the double data stored in the repository with the given name

Specified by:

setValue in interface ModifiableRepositoryData

Parameters:

name - name of the data

value - the value to set

prefix - prefix of the data name, to use instead of the default one.

setValues

public void setValues(String name,
                      Double[] values,
                      String prefix)

Description copied from interface: ModifiableRepositoryData

Sets the values of the multiple double data stored in the repository with the given name

Specified by:

setValues in interface ModifiableRepositoryData

Parameters:

name - name of the data

values - the value to set

prefix - prefix of the data name, to use instead of the default one.

setValue

public void setValue(String name,
                     Boolean value,
                     String prefix)

Description copied from interface: ModifiableRepositoryData

Sets the value of the boolean data stored in the repository with the given name

Specified by:

setValue in interface ModifiableRepositoryData

Parameters:

name - name of the data

value - the value to set

prefix - prefix of the data name, to use instead of the default one.

setValues

public void setValues(String name,
                      Boolean[] values,
                      String prefix)

Description copied from interface: ModifiableRepositoryData

Sets the values of the multiple boolean data stored in the repository with the given name

Specified by:

setValues in interface ModifiableRepositoryData

Parameters:

name - name of the data

values - the value to set

prefix - prefix of the data name, to use instead of the default one.

setValue

public void setValue(String name,
                     InputStream value,
                     String prefix)

Description copied from interface: ModifiableRepositoryData

Sets the value of the input stream data stored in the repository with the given name

Specified by:

setValue in interface ModifiableRepositoryData

Parameters:

name - name of the data

value - the value to set

prefix - prefix of the data name, to use instead of the default one.

setValues

public void setValues(String name,
                      InputStream[] values,
                      String prefix)

Description copied from interface: ModifiableRepositoryData

Sets the values of the multiple input stream data stored in the repository with the given name

Specified by:

setValues in interface ModifiableRepositoryData

Parameters:

name - name of the data

values - the value to set

prefix - prefix of the data name, to use instead of the default one.

addRepositoryData

public ModifiableRepositoryData addRepositoryData(String name,
                                                  String dataTypeName,
                                                  String prefix)

Description copied from interface: ModifiableRepositoryData

Creates a repository data and stores it in the repository with the given name

Specified by:

addRepositoryData in interface ModifiableRepositoryData

Parameters:

name - name of the data

dataTypeName - data type name to use on creation

prefix - prefix of the data name, to use instead of the default one.

Returns:

the value of the data

_checkDataName

private void _checkDataName(String name,
                            String prefix)

removeValue

public void removeValue(String name,
                        String prefix)
                 throws UnknownDataException

Description copied from interface: ModifiableRepositoryData

Removes the value of the data stored in the repository with the given name

Specified by:

removeValue in interface ModifiableRepositoryData

Parameters:

name - name of the data

prefix - prefix of the data name, to use instead of the default one.

Throws:

UnknownDataException - if there is no data stored with the given name

_getFullName

private String _getFullName(String name,
                            String prefix)

_checkLock

private void _checkLock()
                 throws RepositoryException

Throws:

RepositoryException

getNode

public Node getNode()

Retrieves the underlying node.

Returns:

the underlying node.

getSession

public Session getSession()
                   throws AmetysRepositoryException

Retrieves the current session

Returns:

he session

Throws:

AmetysRepositoryException - if an error occurs

getDefaultPrefix

public String getDefaultPrefix()

Description copied from interface: RepositoryData

Retrieves the default prefix

Specified by:

getDefaultPrefix in interface RepositoryData

Returns:

the default prefix

toString

public String toString()

Overrides:

toString in class Object