org.rvpf.metadata.entity

Class GroupEntity

Object

AbstractEntity

MetadataEntity

GroupEntity

All Implemented Interfaces:

Comparable<Entity>, Entity

public final class GroupEntity
extends MetadataEntity

Group entity.

Groups entities. Allows groups hierachy.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GroupEntity.Builder Builder.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ELEMENT_NAME Group element name.
static String	ENTITY_PREFIX Group entity prefix.
static String	ENTITY_REFERENCE_NAME Group entity reference name.

Fields inherited from interface Entity

UUID_COMPARATOR

Method Summary

Modifier and Type	Method and Description
boolean	addMember(Entity member) Adds a member to this group.
boolean	cleanUp() Cleans up unreferenced entities.
int	compareTo(Entity other) Implements Comparable.
boolean	contains(Entity member, boolean recursive) Asks if this group contains a specified member.
GroupEntity	copy() Creates a copy of this entity.
boolean	equals(Object other) For two Entity to be equal, they must at least be instances of the same class, have the same UUID and name.
String	getElementName() Gets the entity element name.
List<Entity>	getMembers() Gets the members.
<T extends Entity> Set<T>	getMembers(Class<T> membersClass) Gets the immediate members for a given cass.
<T extends Entity> Set<T>	getMembers(Class<T> membersClass, boolean recursive) Gets the members for a given class.
String	getPrefix() Gets the class prefix.
String	getReferenceName() Gets the entity reference name.
int	hashCode()
static GroupEntity.Builder	newBuilder() Returns a new builder.

Methods inherited from class MetadataEntity

addText, getAttributes, getAttributes, getTexts, setAttributes

Methods inherited from class AbstractEntity

getName, getNameInUpperCase, getThisLogger, getUUID, setName, setUUID, toString

Methods inherited from class Object

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

Field Detail

ELEMENT_NAME

public static final String ELEMENT_NAME

Group element name.

See Also:

Constant Field Values

ENTITY_PREFIX

public static final String ENTITY_PREFIX

Group entity prefix.

See Also:

Constant Field Values

ENTITY_REFERENCE_NAME

public static final String ENTITY_REFERENCE_NAME

Group entity reference name.

See Also:

Constant Field Values

Method Detail

newBuilder

@Nonnull
 @CheckReturnValue
public static GroupEntity.Builder newBuilder()

Returns a new builder.

Returns:

The new builder.

addMember

@CheckReturnValue
public boolean addMember(@Nonnull
                                            Entity member)
                                     throws TopologicalErrorException

Adds a member to this group.

Parameters:

member - The new member.

Returns:

True on success.

Throws:

TopologicalErrorException - When a cyclic reference is detected.

cleanUp

@CheckReturnValue
public boolean cleanUp()

Cleans up unreferenced entities.

Returns:

True if some members were removed.

compareTo

public int compareTo(Entity other)

Implements Comparable.

Specified by:

compareTo in interface Comparable<Entity>

Overrides:

compareTo in class AbstractEntity

Parameters:

other - An other Entity.

Returns:

A negative integer, zero, or a positive integer.

contains

@CheckReturnValue
public boolean contains(@Nonnull
                                           Entity member,
                                           boolean recursive)

Asks if this group contains a specified member.

Parameters:

member - The member.

recursive - True verifies descendant groups members.

Returns:

True if it is a member of this group.

copy

public GroupEntity copy()

Creates a copy of this entity.

Returns:

The copy.

equals

public boolean equals(Object other)

For two Entity to be equal, they must at least be instances of the same class, have the same UUID and name.

For two Metadata Entity to be equal, they must at least be instances of the same class, have the same UUID, Attributes, name and descriptive texts.

Overrides:

equals in class MetadataEntity

getElementName

public String getElementName()

Gets the entity element name.

The entity element is used to in the generation of the entity URI.

Returns:

The entity element name.

getMembers

@Nonnull
 @CheckReturnValue
public List<Entity> getMembers()

Gets the members.

Returns:

The members.

getMembers

@Nonnull
 @CheckReturnValue
public <T extends Entity> Set<T> getMembers(@Nonnull
                                                                          Class<T> membersClass)

Gets the immediate members for a given cass.

The returned set, if not empty, is the original.

Type Parameters:

T - The type of the returned values.

Parameters:

membersClass - The class of the requested members.

Returns:

The members for the given class.

getMembers

@Nonnull
 @CheckReturnValue
public <T extends Entity> Set<T> getMembers(@Nonnull
                                                                          Class<T> membersClass,
                                                                          boolean recursive)

Gets the members for a given class.

The returned set, even when recursive is true, is not the original.

Type Parameters:

T - The type of the returned values.

Parameters:

membersClass - The class of the requested members.

recursive - True adds descendant groups members.

Returns:

The members for the given class.

getPrefix

public String getPrefix()

Gets the class prefix.

Each concrete entity subclass has its own prefix which will be the same for all its instances. This prefix is used to avoid name collision between different classes in a common registry.

Returns:

The class prefix.

getReferenceName

public String getReferenceName()

Gets the entity reference name.

Returns:

The entity reference name.

hashCode

public int hashCode()

Overrides:

hashCode in class MetadataEntity