Package org.ametys.plugins.repository.tag

Class TaggableAmetysObjectHelper

java.lang.Object

org.ametys.plugins.repository.tag.TaggableAmetysObjectHelper

public final class TaggableAmetysObjectHelper
extends Object

Helper class which provides methods to manage tags on JCRAmetysObjects.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_METADATA_TAGS	Constant for tags metadata.

Method Summary

Modifier and Type	Method	Description
protected static javax.jcr.Node	getNode(JCRAmetysObject object)	Get an object's base node.
static Set<String>	getTags(JCRAmetysObject object)	Retrieve the tags of a JCRAmetysObject.
static Set<String>	getTags(JCRAmetysObject object, String metadataName)	Retrieve the tags of a JCRAmetysObject.
static void	tag(JCRAmetysObject object, String tag)	Tag a JCRAmetysObject.
static void	tag(JCRAmetysObject object, String tag, String metadataName)	Tag a JCRAmetysObject.
static void	untag(JCRAmetysObject object, String tag)	Remove a tag on a JCRAmetysObject.
static void	untag(JCRAmetysObject object, String tag, String metadataName)	Remove a tag on a JCRAmetysObject.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_METADATA_TAGS

public static final String DEFAULT_METADATA_TAGS

Constant for tags metadata.

See Also:

• Constant Field Values

Method Details

getTags

public static Set<String> getTags(JCRAmetysObject object)
                           throws AmetysRepositoryException

Retrieve the tags of a JCRAmetysObject.

Parameters:

object - the JCRAmetysObject to tag.

Returns:

the object tags.

Throws:

AmetysRepositoryException - if failed to tag Ametys object

getTags

public static Set<String> getTags(JCRAmetysObject object,
 String metadataName)
                           throws AmetysRepositoryException

Retrieve the tags of a JCRAmetysObject.

Parameters:

object - the JCRAmetysObject to tag.

metadataName - The name of the metadata holding the tags

Returns:

the object tags.

Throws:

AmetysRepositoryException - if failed to tag Ametys object

tag

public static void tag(JCRAmetysObject object,
 String tag)
                throws AmetysRepositoryException

Tag a JCRAmetysObject.

Parameters:

object - the JCRAmetysObject to tag.

tag - the tag to put on the object.

Throws:

AmetysRepositoryException - if an error occurs.

tag

public static void tag(JCRAmetysObject object,
 String tag,
 String metadataName)
                throws AmetysRepositoryException

Tag a JCRAmetysObject.

Parameters:

object - the JCRAmetysObject to tag.

tag - the tag to put on the object.

metadataName - The name of the metadata holding the tags

Throws:

AmetysRepositoryException - if an error occurs.

untag

public static void untag(JCRAmetysObject object,
 String tag)
                  throws AmetysRepositoryException

Remove a tag on a JCRAmetysObject.

Parameters:

object - the JCRAmetysObject to tag.

tag - the tag to remove on the object.

Throws:

AmetysRepositoryException - if an error occurs.

untag

public static void untag(JCRAmetysObject object,
 String tag,
 String metadataName)
                  throws AmetysRepositoryException

Remove a tag on a JCRAmetysObject.

Parameters:

object - the JCRAmetysObject to tag.

tag - the tag to remove on the object.

metadataName - The name of the metadata holding the tags

Throws:

AmetysRepositoryException - if an error occurs.

getNode

protected static javax.jcr.Node getNode(JCRAmetysObject object)

Get an object's base node.

Parameters:

object - the object which node to get.

Returns:

the object's base node.