org.ametys.cms.tag

Interface Tag

All Known Implementing Classes:

CMSTag, DefaultTag

public interface Tag

This class represent a Tag

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	NAME_PATTERN The pattern a tag name has to respect.

Method Summary

Modifier and Type	Method and Description
void	addTag(Tag tag) Add a new child tag.
I18nizableText	getDescription() Retrieves the description.
String	getId() Get the tag unique id.
String	getName() Get the tag name.
<T extends Tag> T	getParent() Get the parent tag
String	getParentName() Get the parent name.
<T extends Tag> T	getTag(String tagId) Try to get a child tag by its id
Map<String,? extends Tag>	getTags() Retrieves the Set of child tags
I18nizableText	getTitle() Retrieves the title.
boolean	hasTag(String tagId) Determines if a tag exists
void	setTags(Map<String,? extends Tag> tags) Set the child tags

Field Detail

NAME_PATTERN

static final Pattern NAME_PATTERN

The pattern a tag name has to respect.

Method Detail

getId

String getId()

Get the tag unique id.

Returns:

The unique id

getName

String getName()

Get the tag name.

Returns:

The tag name

getParentName

String getParentName()

Get the parent name.

Returns:

The parent name.

getParent

<T extends Tag> T getParent()

Get the parent tag

Type Parameters:

T - the tag class

Returns:

The parent tag or null if the tag has no parent.

getTitle

I18nizableText getTitle()

Retrieves the title.

Returns:

the title.

Throws:

AmetysRepositoryException - if an error occurs.

getDescription

I18nizableText getDescription()

Retrieves the description.

Returns:

the description.

addTag

void addTag(Tag tag)

Add a new child tag.

Parameters:

tag - The tag to add

setTags

void setTags(Map<String,? extends Tag> tags)

Set the child tags

Parameters:

tags - The Map of Tag to set

getTags

Map<String,? extends Tag> getTags()

Retrieves the Set of child tags

Returns:

The child tags in a Map

getTag

<T extends Tag> T getTag(String tagId)

Try to get a child tag by its id

Type Parameters:

T - the tag class

Parameters:

tagId - The id of the child tag

Returns:

The child tag or null if not existing

hasTag

boolean hasTag(String tagId)

Determines if a tag exists

Parameters:

tagId - The tag id

Returns:

true if the tag exists