Package org.ametys.plugins.workspaces.categories

Class Category

java.lang.Object

org.ametys.plugins.workspaces.categories.Category

All Implemented Interfaces:

Tag

public class Category
extends Object
implements Tag

Class representing a category.

Field Summary

Fields

Modifier and Type	Field	Description
private String	_color
private I18nizableText	_description
private String	_id
private String	_name
private Category	_parent
private Map<String,Category>	_tags
private I18nizableText	_title

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

NAME_PATTERN

Constructor Summary

Constructors

Constructor	Description
Category(String id)	Constructor
Category(String id, String name, String color, Category parent, I18nizableText title, I18nizableText description)	Constructor
Category(String id, String name, Category parent, I18nizableText title, I18nizableText description)	Constructor

Method Summary

Modifier and Type	Method	Description
void	addTag(Tag tag)	Add a new child tag.
String	getColor()	Get the color category
I18nizableText	getDescription()	Retrieves the description.
String	getId()	Get the tag unique id.
String	getName()	Get the tag name.
Category	getParent()	Get the parent tag
String	getParentName()	Get the parent name.
Category	getTag(String tagId)	Try to get a child tag by its id
Map<String,Category>	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

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

_color

private String _color

_tags

private Map<String,Category> _tags

_parent

private Category _parent

Constructor Detail

Category

public Category(String id)

Constructor

Parameters:

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

Category

public Category(String id,
                String name,
                Category parent,
                I18nizableText title,
                I18nizableText description)

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

Category

public Category(String id,
                String name,
                String color,
                Category parent,
                I18nizableText title,
                I18nizableText description)

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.

color - the color

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

title - the tag title

description - the tag description

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.

getColor

public String getColor()

Get the color category

Returns:

the color

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 Category 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,Category> 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 Category 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

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