Package com.rometools.modules.sle.types

Class Group

java.lang.Object

com.rometools.modules.sle.types.Group

All Implemented Interfaces:

Serializable, Cloneable

public class Group
extends Object
implements Serializable, Cloneable

The cf:group element is intended to inform the client that the property to which it refers is one that is “groupable” – that is, that the client should provide a user interface that allows the user to group or filter on the values of that property. Groupable properties should contain a small set of discrete values (e.g. book genres are perfect for groups).

The cf:group element contains the following attributes:

• ns - this attribute is the full namespace used in the property element. If the attribute value is an empty string, it is assumed that the property does not live in a namespace. If the ns attribute is omitted, the default value is the empty string. In the example above, the ns attribute would contain "http://www.example.com/book". It would not contain the namespace prefix.
• element - this attribute is the name of the property (without any namespace). In the example above, the element attribute would contain "firstedition" If this attribute is omitted, it is assumed that the label attribute is included and that this cf:group element refers to the default sort order.
• label - this attribute contains a human-readable name for the property to which this cf:group element refers. If it is omitted, the client should use the value of the "element" attribute as the human-readable name. The "label" attribute is required if the "element" attribute is omitted.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Group(org.jdom2.Namespace namespace, String element, String label)

Method Summary

Modifier and Type	Method	Description
Object	clone()
boolean	equals(Object o)
String	getElement()	Returns the name of the element.
String	getLabel()	Returns the label of the element.
org.jdom2.Namespace	getNamespace()	Returns the namespace of the element.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Group

public Group(org.jdom2.Namespace namespace,
             String element,
             String label)

Parameters:

namespace - Namespace of the element

element - Name of the element

label - Label for the grouping.

Method Detail

getElement

public String getElement()

Returns the name of the element.

Returns:

Returns the name of the element.

getLabel

public String getLabel()

Returns the label of the element.

Returns:

Returns the label of the element.

getNamespace

public org.jdom2.Namespace getNamespace()

Returns the namespace of the element.

Returns:

Returns the namespace of the element.

clone

public Object clone()

Overrides:

clone in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object