org.ametys.web.repository.content.jcr

Class TaggableAmetysObjectHelper

java.lang.Object

org.ametys.web.repository.content.jcr.TaggableAmetysObjectHelper

public final class TaggableAmetysObjectHelper
extends Object

Helper class which provides methods to manage tags on JCRAmetysObjects.

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
private	TaggableAmetysObjectHelper()

Method Summary

Modifier and Type	Method and Description
protected static Node	getNode(JCRAmetysObject object) Get an object's base node.
static Set<String>	getTags(JCRAmetysObject object) Tag a JCRAmetysObject.
static void	tag(JCRAmetysObject object, String tag) Tag a JCRAmetysObject.
static void	untag(JCRAmetysObject object, String tag) Tag a JCRAmetysObject.

Methods inherited from class java.lang.Object

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

Field Detail

METADATA_TAGS

public static final String METADATA_TAGS

Constant for tags metadata.

See Also:

Constant Field Values

Constructor Detail

TaggableAmetysObjectHelper

private TaggableAmetysObjectHelper()

Method Detail

getTags

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

Tag a JCRAmetysObject.

Parameters:

object - the JCRAmetysObject to tag.

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.

untag

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

Tag a JCRAmetysObject.

Parameters:

object - the JCRAmetysObject to tag.

tag - the tag to remove on the object.

Throws:

AmetysRepositoryException - if an error occurs.

getNode

protected static Node getNode(JCRAmetysObject object)

Get an object's base node.

Parameters:

object - the object which node to get.

Returns:

the object's base node.