org.rvpf.metadata.entity

Class StoreEntity

Object

AbstractEntity

MetadataEntity

ParamsEntity

ProxyEntity

StoreEntity

All Implemented Interfaces:

Comparable<Entity>, Entity

public final class StoreEntity
extends ProxyEntity

Store entity.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Fields inherited from interface Entity

UUID_COMPARATOR

Method Summary

Modifier and Type	Method and Description
boolean	addPointReference(PointEntity pointEntity) Adds a reference to a point entity.
StoreEntity	copy() Creates a copy of this entity.
protected Proxied	createDefaultInstance() Creates a default instance.
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.
Optional<? extends Permissions>	getPermissions() Gets the permissions.
Optional<PermissionsEntity>	getPermissionsEntity() Gets the permissions entity.
Set<PointEntity>	getPointReferences() Gets the point references.
String	getPrefix() Gets the class prefix.
String	getReferenceName() Gets the entity reference name.
Optional<? extends Store>	getStore() Gets the store instance.
int	hashCode()
static StoreEntity.Builder	newBuilder() Returns a new builder.

Methods inherited from class ProxyEntity

clearInstance, getClassDef, getInstance, getProxy, is, is, setInstance, setUp, tearDown

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

Field Detail

ELEMENT_NAME

public static final String ELEMENT_NAME

Store element name.

See Also:

Constant Field Values

ENTITY_PREFIX

public static final String ENTITY_PREFIX

Store entity prefix.

See Also:

Constant Field Values

ENTITY_REFERENCE_NAME

public static final String ENTITY_REFERENCE_NAME

Store entity reference name.

See Also:

Constant Field Values

Method Detail

newBuilder

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

Returns a new builder.

Returns:

The new builder.

addPointReference

@CheckReturnValue
public boolean addPointReference(@Nonnull
                                                    PointEntity pointEntity)

Adds a reference to a point entity.

Parameters:

pointEntity - The point entity.

Returns:

True if added.

copy

public StoreEntity 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 ProxyEntity

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.

getPermissions

@Nonnull
 @CheckReturnValue
public Optional<? extends Permissions> getPermissions()

Gets the permissions.

Returns:

The optional permissions.

getPermissionsEntity

@Nonnull
 @CheckReturnValue
public Optional<PermissionsEntity> getPermissionsEntity()

Gets the permissions entity.

Returns:

The optional permissions entity.

getPointReferences

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

Gets the point references.

Returns:

The point references.

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.

getStore

@Nonnull
 @CheckReturnValue
public Optional<? extends Store> getStore()

Gets the store instance.

Returns:

The optional store instance.

hashCode

public int hashCode()

Overrides:

hashCode in class ProxyEntity

createDefaultInstance

protected Proxied createDefaultInstance()

Creates a default instance.

This must be overriden by the subclass when the 'classDef' attribute is optional; otherwise, it will always fail.

Overrides:

createDefaultInstance in class ProxyEntity

Returns:

A new instance or fails.