org.rvpf.metadata.entity

Class OriginEntity

Object

AbstractEntity

MetadataEntity

ParamsEntity

OriginEntity

All Implemented Interfaces:

Comparable<Entity>, Entity, Origin

public final class OriginEntity
extends ParamsEntity
implements Origin

Origin entity.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Fields inherited from interface Entity

UUID_COMPARATOR

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OriginEntity(Optional<String> name, Optional<UUID> uuid, Optional<KeyedGroups> attributes, Optional<Map<String,Text>> texts, Optional<Params> params, Set<PointEntity> pointEntities) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
boolean	addPointEntity(PointEntity pointEntity) Adds a a point entity.
OriginEntity	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.
Set<PointEntity>	getPointEntities() Gets the point entities.
String	getPrefix() Gets the class prefix.
String	getReferenceName() Gets the entity reference name.
int	hashCode()
static OriginEntity.Builder	newBuilder() Returns a new builder.

Methods inherited from class ParamsEntity

getParams, setParams

Methods inherited from class MetadataEntity

addText, getAttributes, getAttributes, getTexts, setAttributes

Methods inherited from class AbstractEntity

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

Methods inherited from class Object

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

Methods inherited from interface Entity

getAttributes, getName, getNameInUpperCase, getUUID

Methods inherited from interface Comparable

compareTo

Field Detail

ELEMENT_NAME

public static final String ELEMENT_NAME

Origin element name.

See Also:

Constant Field Values

ENTITY_PREFIX

public static final String ENTITY_PREFIX

Origin entity prefix.

See Also:

Constant Field Values

ENTITY_REFERENCE_NAME

public static final String ENTITY_REFERENCE_NAME

Origin entity reference name.

See Also:

Constant Field Values

Constructor Detail

OriginEntity

protected OriginEntity(@Nonnull
                       Optional<String> name,
                       @Nonnull
                       Optional<UUID> uuid,
                       @Nonnull
                       Optional<KeyedGroups> attributes,
                       @Nonnull
                       Optional<Map<String,Text>> texts,
                       @Nonnull
                       Optional<Params> params,
                       @Nonnull
                       Set<PointEntity> pointEntities)

Constructs an instance.

Parameters:

name - The optional entity name.

uuid - The optional entity UUID.

attributes - The optional attributes.

texts - The optional texts.

params - The optional params.

pointEntities - The point entities.

Method Detail

newBuilder

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

Returns a new builder.

Returns:

The new builder.

addPointEntity

@CheckReturnValue
public boolean addPointEntity(@Nonnull
                                                 PointEntity pointEntity)

Adds a a point entity.

Parameters:

pointEntity - The point entity.

Returns:

True if added.

copy

public OriginEntity copy()

Creates a copy of this entity.

Specified by:

copy in interface 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 ParamsEntity

getElementName

public String getElementName()

Gets the entity element name.

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

Specified by:

getElementName in interface Entity

Returns:

The entity element name.

getPointEntities

@Nonnull
 @CheckReturnValue
public Set<PointEntity> getPointEntities()

Gets the point entities.

Returns:

The point entities.

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.

Specified by:

getPrefix in interface Entity

Returns:

The class prefix.

getReferenceName

public String getReferenceName()

Gets the entity reference name.

Specified by:

getReferenceName in interface Entity

Returns:

The entity reference name.

hashCode

public int hashCode()

Overrides:

hashCode in class ParamsEntity