org.ametys.plugins.repository.metadata.jcr

Class JCRRichText

java.lang.Object

org.ametys.plugins.repository.metadata.jcr.JCRResource

org.ametys.plugins.repository.metadata.jcr.JCRRichText

All Implemented Interfaces:

ModifiableResource, ModifiableRichText, Resource, RichText

public class JCRRichText
extends JCRResource
implements ModifiableRichText

JCR implementation of a RichText, based on the ametys:richText nodetype.

Field Summary

Fields

Modifier and Type	Field and Description
private static String	_ANNOTATIONS_NODE_NAME The annotations node name.
private boolean	_lockAlreadyChecked
private AmetysObjectResolver	_resolver
private Node	_rootDataNode

Constructor Summary

Constructors

Constructor and Description
JCRRichText(Node node, AmetysObjectResolver resolver) Constructor

Method Summary

Modifier and Type	Method and Description
private void	_checkLock()
void	addAnnotation(String name, String value) Add a value to a semantic annotation
void	addAnnotation(String name, String[] values) Add values to a semantic annotation
ModifiableFolder	getAdditionalDataFolder() Returns the Folder holding additional data. Its internal organization is application dependant.
String[]	getAnnotationNames() Get the content annotation names.
protected ModifiableCompositeMetadata	getAnnotationsNode(boolean createNew) Get the annotations container node.
String[]	getAnnotationValues(String name) Get the values of a given annotation.
void	removeAnnotation(String name) Remove a given semantic annotation
void	removeAnnotations() Return all semantic annotations

Methods inherited from class org.ametys.plugins.repository.metadata.jcr.JCRResource

getEncoding, getInputStream, getLastModified, getLength, getMimeType, getNode, getOutputStream, rename, setEncoding, setInputStream, setLastModified, setMimeType

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.plugins.repository.metadata.ModifiableResource

getOutputStream, rename, setEncoding, setInputStream, setLastModified, setMimeType

Methods inherited from interface org.ametys.plugins.repository.metadata.Resource

getEncoding, getInputStream, getLastModified, getLength, getMimeType

Field Detail

_ANNOTATIONS_NODE_NAME

private static final String _ANNOTATIONS_NODE_NAME

The annotations node name.

See Also:

Constant Field Values

_rootDataNode

private Node _rootDataNode

_resolver

private AmetysObjectResolver _resolver

_lockAlreadyChecked

private boolean _lockAlreadyChecked

Constructor Detail

JCRRichText

public JCRRichText(Node node,
                   AmetysObjectResolver resolver)
            throws AmetysRepositoryException

Constructor

Parameters:

node - the JCR Node backing this JCRRichText

resolver - The resolver, used to resolve object collections.

Throws:

AmetysRepositoryException - if an error occurs

Method Detail

getAdditionalDataFolder

public ModifiableFolder getAdditionalDataFolder()

Description copied from interface: ModifiableRichText

Returns the Folder holding additional data.
Its internal organization is application dependant.

Specified by:

getAdditionalDataFolder in interface ModifiableRichText

Specified by:

getAdditionalDataFolder in interface RichText

Returns:

the Folder holding additional data

getAnnotationNames

public String[] getAnnotationNames()
                            throws AmetysRepositoryException

Description copied from interface: RichText

Get the content annotation names.

Specified by:

getAnnotationNames in interface RichText

Returns:

the annotation names.

Throws:

AmetysRepositoryException - if an error occurs.

getAnnotationValues

public String[] getAnnotationValues(String name)
                             throws AmetysRepositoryException

Description copied from interface: RichText

Get the values of a given annotation.

Specified by:

getAnnotationValues in interface RichText

Parameters:

name - The name of the annotation.

Returns:

The annotation values.

Throws:

AmetysRepositoryException - if an error occurs.

addAnnotation

public void addAnnotation(String name,
                          String value)
                   throws AmetysRepositoryException

Description copied from interface: ModifiableRichText

Add a value to a semantic annotation

Specified by:

addAnnotation in interface ModifiableRichText

Parameters:

name - The name of the annotation

value - The value to append

Throws:

AmetysRepositoryException - if an error occurs.

addAnnotation

public void addAnnotation(String name,
                          String[] values)
                   throws AmetysRepositoryException

Description copied from interface: ModifiableRichText

Add values to a semantic annotation

Specified by:

addAnnotation in interface ModifiableRichText

Parameters:

name - The name of the annotation

values - The values to append

Throws:

AmetysRepositoryException - if an error occurs.

removeAnnotations

public void removeAnnotations()
                       throws AmetysRepositoryException

Description copied from interface: ModifiableRichText

Return all semantic annotations

Specified by:

removeAnnotations in interface ModifiableRichText

Throws:

AmetysRepositoryException - if an error occurs.

removeAnnotation

public void removeAnnotation(String name)
                      throws AmetysRepositoryException

Description copied from interface: ModifiableRichText

Remove a given semantic annotation

Specified by:

removeAnnotation in interface ModifiableRichText

Parameters:

name - The name of the semantic association to remove

Throws:

AmetysRepositoryException - if an error occurs.

getAnnotationsNode

protected ModifiableCompositeMetadata getAnnotationsNode(boolean createNew)
                                                  throws UnknownMetadataException,
                                                         AmetysRepositoryException

Get the annotations container node.

Parameters:

createNew - true to create the node if it doesn't exist, false otherwise.

Returns:

The annotation container node.

Throws:

UnknownMetadataException - If the node doesn't exist and createNew is false.

AmetysRepositoryException - If a repository error occurs.

_checkLock

private void _checkLock()
                 throws RepositoryException

Throws:

RepositoryException