org.ametys.cms.tag

Class CMSTag

java.lang.Object

org.ametys.cms.tag.CMSTag

All Implemented Interfaces:

Tag

public class CMSTag
extends Object
implements Tag

This class represent a CMS Tag

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CMSTag.TagVisibility Tag visibility

Field Summary

Fields

Modifier and Type	Field and Description
private I18nizableText	_description
private String	_id
private String	_name
private CMSTag	_parent
private Map<String,CMSTag>	_tags
private TagTargetType	_targetType
private I18nizableText	_title
private CMSTag.TagVisibility	_visibility

Fields inherited from interface org.ametys.cms.tag.Tag

NAME_PATTERN

Constructor Summary

Constructors

Constructor and Description
CMSTag(String id, String name, CMSTag parent, I18nizableText title, I18nizableText description, CMSTag.TagVisibility visibility, TagTargetType target) Constructor
CMSTag(String id, String name, CMSTag parent, I18nizableText title, I18nizableText description, TagTargetType target) Constructor

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.
CMSTag	getParent() Get the parent tag
String	getParentName() Get the parent name.
CMSTag	getTag(String tagId) Try to get a child tag by its id
Map<String,CMSTag>	getTags() Retrieves the Set of child tags
TagTargetType	getTarget() Retrieves the target type.
I18nizableText	getTitle() Retrieves the title.
CMSTag.TagVisibility	getVisibility() Retrieves the visibility type.
boolean	hasTag(String tagId) Determines if a tag exists
void	setTags(Map<String,? extends Tag> tags) Set the child tags
void	setTarget(TagTargetType target) Set the target type.
void	setVisibility(CMSTag.TagVisibility visibility) Set the visibility type.

Methods inherited from class java.lang.Object

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

Field Detail

_id

private String _id

_name

private String _name

_title

private I18nizableText _title

_description

private I18nizableText _description

_visibility

private CMSTag.TagVisibility _visibility

_targetType

private TagTargetType _targetType

_tags

private Map<String,CMSTag> _tags

_parent

private CMSTag _parent

Constructor Detail

CMSTag

public CMSTag(String id,
              String name,
              CMSTag parent,
              I18nizableText title,
              I18nizableText description,
              TagTargetType target)

Constructor

Parameters:

id - The id of the tag. The id must be unique.

name - The name of the tag. The name must be unique. The name is the same as the id except for JCR tag.

parent - The parent tag (can be null if the tag has no parent)

title - the tag title

description - the tag description

target - the type of target

CMSTag

public CMSTag(String id,
              String name,
              CMSTag parent,
              I18nizableText title,
              I18nizableText description,
              CMSTag.TagVisibility visibility,
              TagTargetType target)

Constructor

Parameters:

id - The id of the tag. The id must be unique.

name - The name of the tag. The name must be unique. The name is the same as the id except for JCR tag.

parent - The parent tag (can be null if the tag has no parent)

title - the tag title

description - the tag description

visibility - the tag visibility.

target - The type of target

Method Detail

getId

public String getId()

Description copied from interface: Tag

Get the tag unique id.

Specified by:

getId in interface Tag

Returns:

The unique id

getName

public String getName()

Description copied from interface: Tag

Get the tag name.

Specified by:

getName in interface Tag

Returns:

The tag name

getTitle

public I18nizableText getTitle()

Description copied from interface: Tag

Retrieves the title.

Specified by:

getTitle in interface Tag

Returns:

the title.

getDescription

public I18nizableText getDescription()

Description copied from interface: Tag

Retrieves the description.

Specified by:

getDescription in interface Tag

Returns:

the description.

getParentName

public String getParentName()

Description copied from interface: Tag

Get the parent name.

Specified by:

getParentName in interface Tag

Returns:

The parent name.

getParent

public CMSTag getParent()

Description copied from interface: Tag

Get the parent tag

Specified by:

getParent in interface Tag

Returns:

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

addTag

public void addTag(Tag tag)

Description copied from interface: Tag

Add a new child tag.

Specified by:

addTag in interface Tag

Parameters:

tag - The tag to add

getTags

public Map<String,CMSTag> getTags()

Description copied from interface: Tag

Retrieves the Set of child tags

Specified by:

getTags in interface Tag

Returns:

The child tags in a Map

getTag

public CMSTag getTag(String tagId)

Description copied from interface: Tag

Try to get a child tag by its id

Specified by:

getTag in interface Tag

Parameters:

tagId - The id of the child tag

Returns:

The child tag or null if not existing

hasTag

public boolean hasTag(String tagId)

Description copied from interface: Tag

Determines if a tag exists

Specified by:

hasTag in interface Tag

Parameters:

tagId - The tag id

Returns:

true if the tag exists

getVisibility

public CMSTag.TagVisibility getVisibility()

Retrieves the visibility type.

Returns:

the visibility type.

setVisibility

public void setVisibility(CMSTag.TagVisibility visibility)

Set the visibility type.

Parameters:

visibility - the visibility to set.

getTarget

public TagTargetType getTarget()

Retrieves the target type.

Returns:

the target type.

setTarget

public void setTarget(TagTargetType target)

Set the target type.

Parameters:

target - the target to set.

setTags

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

Description copied from interface: Tag

Set the child tags

Specified by:

setTags in interface Tag

Parameters:

tags - The Map of Tag to set