PointEntity (RVPF-Core API Documentation)

Object
- AbstractEntity
- - MetadataEntity
  - - ParamsEntity
    - - PointEntity

All Implemented Interfaces:

Comparable<Entity>, Entity, Point

Direct Known Subclasses:

PointEntity.Definition, PointEntity.Reference
```
public abstract class PointEntity
extends ParamsEntity
implements Point
```
Point entity.
Holds the informations on a point and is the reference for all the values processed by the framework.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PointEntity.Definition
Defined Point Entity.

static class PointEntity.Reference
Undefined Point Entity.
- Nested classes/interfaces inherited from class ParamsEntity
  ParamsEntity.Builder
- Nested classes/interfaces inherited from interface Point
  Point.Named, Point.Replicate

Nested Classes
Modifier and Type	Class and Description
`static class`	`PointEntity.Definition` Defined Point Entity.
`static class`	`PointEntity.Reference` Undefined Point Entity.

Field Summary

Fields
Modifier and Type	Field and Description
`static ClassDef`	`DEFAULT_FILTER` Default filter.
`static String`	`ELEMENT_NAME` Point element name.
`static String`	`ENTITY_PREFIX` Point entity prefix.
`static String`	`ENTITY_REFERENCE_NAME` Point reference name.

Fields inherited from interface Entity
UUID_COMPARATOR

Constructor Summary

Constructors
Modifier Constructor and Description

protected PointEntity()
Constructs an instance.

protected PointEntity(PointEntity other)
Constructs an instance from an other.

Constructors
Modifier	Constructor and Description
`protected`	`PointEntity()` Constructs an instance.
`protected`	`PointEntity(PointEntity other)` Constructs an instance from an other.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addInputRelation(PointInput inputRelation)` Adds an input relation.
`void`	`addReplicate(Point.Replicate replicate)` Adds a replicate.
`void`	`adjustLevel()` Adjust the level of this point's dependents.
`void`	`clearContentEntity()` Clears the content entity for this point.
`void`	`clearInputs()` Clears the input relations.
`void`	`clearResults()` Clears the result relations.
`void`	`clearTransformEntity()` Clears the transform entity for this point.
`void`	`close()` Closes the current store connection.
`int`	`compareTo(Entity other)` Implements Comparable.
`boolean`	`contentIs(String name)` Asks if the content implements a specified interface.
`abstract PointEntity`	`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.
`ValueFilter`	`filter()` Returns a configured filter.
`void`	`flagResultRelations()` Flags the point as having result relations.
`Optional<Content>`	`getContent()` Gets this point's content handling instance.
`Optional<ContentEntity>`	`getContentEntity()` Gets the content entity for this point.
`abstract Optional<PointEntity>`	`getDefinition()` Gets the point's definition.
`String`	`getElementName()` Gets the entity element name.
`List<PointInput>`	`getInputs()` Gets this point's inputs.
`int`	`getLevel()` Gets this point's level.
`Optional<? extends Origin>`	`getOrigin()` Gets this point's origin.
`Optional<OriginEntity>`	`getOriginEntity()` Gets the origin entity for this point.
`Optional<? extends Permissions>`	`getPermissions()` Gets the permissions.
`Optional<PermissionsEntity>`	`getPermissionsEntity()` Gets the premissions entity.
`String`	`getPrefix()` Gets the class prefix.
`int`	`getRecalcLatest()` Gets the recalc limit.
`String`	`getReferenceName()` Gets the entity reference name.
`List<Point.Replicate>`	`getReplicates()` Gets this point's replicates.
`List<PointInput>`	`getResults()` Gets this point's dependents.
`Optional<? extends Store>`	`getStore()` Gets this point's store.
`Optional<StoreEntity>`	`getStoreEntity()` Gets the store entity for this point.
`Optional<Sync>`	`getSync()` Gets a synchronization object for this point.
`Optional<SyncEntity>`	`getSyncEntity()` Gets the sync entity.
`Optional<Transform>`	`getTransform()` Gets this point's transform.
`Optional<TransformEntity>`	`getTransformEntity()` Gets the transform entity for this point.
`int`	`hashCode()`
`boolean`	`hasInputRelations()` Asks if this point has input relations.
`boolean`	`hasResultRelations()` Asks if this point has result relations.
`abstract boolean`	`isDefinition()` Asks if this point is a definition.
`boolean`	`isDropped()` Asks if this point is dropped.
`boolean`	`isNullRemoves(boolean defaultNullRemoves)` Asks if a null point values should result in the removal of the values at the corresponding time stamp.
`boolean`	`isSynced()` Asks if this point has a synchronization object.
`boolean`	`isVolatile()` Asks if this point is volatile.
`void`	`resetInputs()` Reset the input relations.
`void`	`resetReplicates()` Resets this point's replicates.
`void`	`resetResults()` Resets the result relations.
`void`	`setContentEntity(ContentEntity content)` Sets the content entity for this point.
`abstract void`	`setDefinition(PointEntity definition)` Sets the point's definition.
`void`	`setDropped(boolean dropped)` Sets the dropped indicator.
`void`	`setOriginEntity(Optional<OriginEntity> originEntity)` Sets the origin entity for this point.
`void`	`setPermissionsEntity(Optional<PermissionsEntity> permissions)` Sets the permissions.
`void`	`setStoreEntity(Optional<StoreEntity> storeEntity)` Sets the store entity for this point.
`void`	`setSyncEntity(Optional<SyncEntity> syncEntity)` Sets the synchronization reference for this point.
`void`	`setTransformEntity(TransformEntity transform)` Sets the transform entity for this point.
`boolean`	`setUp(Metadata metadata)` Sets up this point.
`boolean`	`setUpRelations(Metadata metadata)` Sets up the input relations of this point.
`boolean`	`setUpStore(Metadata metadata)` Sets up the store associated with this point.
`void`	`tearDown()` Tears down what has been set up.
`void`	`tearDownStore()` Tears down the store associated with this point.
`boolean`	`tidy()` Tidies the point entity.
`String`	`toString()`

Methods inherited from class ParamsEntity
getParams, setParams

Methods inherited from class MetadataEntity
addText, getAttributes, getAttributes, getTexts, setAttributes

Methods inherited from class AbstractEntity
getName, getNameInUpperCase, getThisLogger, getUUID, setName, setUUID

Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Point
getParams

Methods inherited from interface Entity
getAttributes, getName, getNameInUpperCase, getUUID

- Field Detail
  - DEFAULT_FILTER
```
public static final ClassDef DEFAULT_FILTER
```
    Default filter.
  - ELEMENT_NAME
```
public static final String ELEMENT_NAME
```
    Point element name.
    
    See Also:
    
    Constant Field Values
  - ENTITY_PREFIX
```
public static final String ENTITY_PREFIX
```
    Point entity prefix.
    
    See Also:
    
    Constant Field Values
  - ENTITY_REFERENCE_NAME
```
public static final String ENTITY_REFERENCE_NAME
```
    Point reference name.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PointEntity
```
protected PointEntity()
```
    Constructs an instance.
  - PointEntity
```
protected PointEntity(@Nonnull
                      PointEntity other)
```
    Constructs an instance from an other.
    
    Parameters:
    
    other - The other instance.
- Method Detail
  - addInputRelation
```
public final void addInputRelation(@Nonnull
                                   PointInput inputRelation)
```
    Adds an input relation.
    
    Parameters:
    
    inputRelation - The input relation.
  - addReplicate
```
public final void addReplicate(@Nonnull
                               Point.Replicate replicate)
```
    Adds a replicate.
    
    Parameters:
    
    replicate - The replicate.
  - adjustLevel
```
public final void adjustLevel()
                       throws TopologicalErrorException
```
    Adjust the level of this point's dependents.
    
    Throws:
    
    TopologicalErrorException - When a recursive reference is found.
  - clearContentEntity
```
public final void clearContentEntity()
```
    Clears the content entity for this point.
  - clearInputs
```
public final void clearInputs()
```
    Clears the input relations.
    Removes all input relations while keeping the indication that this point has held input relations.
  - clearResults
```
public final void clearResults()
```
    Clears the result relations.
    Removes all result relations while keeping the indication that this point has held result relations.
  - clearTransformEntity
```
public final void clearTransformEntity()
```
    Clears the transform entity for this point.
  - close
```
public final void close()
```
    Closes the current store connection.
  - compareTo
```
public final 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.
  - contentIs
```
@CheckReturnValue
public final boolean contentIs(@Nonnull
                                                  String name)
                                           throws UndefinedEntityException
```
    Asks if the content implements a specified interface.
    
    Parameters:
    
    name - The name of the ClassDef representing the interface.
    
    Returns:
    
    True if the interface is implemented.
    
    Throws:
    
    UndefinedEntityException - When the interface is undefined.
  - copy
```
public abstract PointEntity 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
  - filter
```
public final ValueFilter filter()
```
    Returns a configured filter.
    
    Specified by:
    
    filter in interface Point
    
    Returns:
    
    The step filter.
  - flagResultRelations
```
public void flagResultRelations()
```
    Flags the point as having result relations.
  - getContent
```
public final Optional<Content> getContent()
```
    Gets this point's content handling instance.
    The point's content handling provides normalization / denormalization services.
    
    Specified by:
    
    getContent in interface Point
    
    Returns:
    
    The optional content handling instance.
  - getContentEntity
```
@Nonnull
 @CheckReturnValue
public final Optional<ContentEntity> getContentEntity()
```
    Gets the content entity for this point.
    
    Returns:
    
    The optional content entity.
  - getDefinition
```
@Nonnull
 @CheckReturnValue
public abstract Optional<PointEntity> getDefinition()
```
    Gets the point's definition.
    Allows a reference to supply the referent.
    
    Returns:
    
    The optional point's definition.
  - getElementName
```
public final 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.
  - getInputs
```
public final List<PointInput> getInputs()
```
    Gets this point's inputs.
    The point's inputs are the points that may trigger a computation of this point and / or are needed by this point's transform program.
    
    Specified by:
    
    getInputs in interface Point
    
    Returns:
    
    The list of input points.
  - getLevel
```
public final int getLevel()
```
    Gets this point's level.
    A point's level determines the order of processing for the processor.
    
    Specified by:
    
    getLevel in interface Point
    
    Returns:
    
    An int where 0 means that the values of this point are not generated elsewhere. Higher values represent the level of dependencies.
  - getOrigin
```
public final Optional<? extends Origin> getOrigin()
```
    Gets this point's origin.
    
    Specified by:
    
    getOrigin in interface Point
    
    Returns:
    
    The optional definition of the origin of this point's values.
  - getOriginEntity
```
@Nonnull
 @CheckReturnValue
public final Optional<OriginEntity> getOriginEntity()
```
    Gets the origin entity for this point.
    
    Returns:
    
    The optional origin entity.
  - getPermissions
```
@Nonnull
 @CheckReturnValue
public final Optional<? extends Permissions> getPermissions()
```
    Gets the permissions.
    
    Returns:
    
    The optional permissions.
  - getPermissionsEntity
```
@Nonnull
 @CheckReturnValue
public final Optional<PermissionsEntity> getPermissionsEntity()
```
    Gets the premissions entity.
    
    Returns:
    
    The optional permissions entity.
  - getPrefix
```
public final 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.
  - getRecalcLatest
```
@CheckReturnValue
public final int getRecalcLatest()
```
    Gets the recalc limit.
    
    Returns:
    
    The recalc limit.
  - getReferenceName
```
public String getReferenceName()
```
    Gets the entity reference name.
    
    Specified by:
    
    getReferenceName in interface Entity
    
    Returns:
    
    The entity reference name.
  - getReplicates
```
public List<Point.Replicate> getReplicates()
```
    Gets this point's replicates.
    
    Specified by:
    
    getReplicates in interface Point
    
    Returns:
    
    The point's replicates.
  - getResults
```
public final List<PointInput> getResults()
```
    Gets this point's dependents.
    When a new or updated value of this point may trigger the computation of the value of an other point and / or this point's value is used in its computation, that other point is considered a dependent.
    
    Specified by:
    
    getResults in interface Point
    
    Returns:
    
    A List of point relations.
  - getStore
```
public final Optional<? extends Store> getStore()
```
    Gets this point's store.
    
    Specified by:
    
    getStore in interface Point
    
    Returns:
    
    The optional definition of the store holding this point's values.
  - getStoreEntity
```
@Nonnull
 @CheckReturnValue
public final Optional<StoreEntity> getStoreEntity()
```
    Gets the store entity for this point.
    
    Returns:
    
    The optional store entity.
  - getSync
```
public final Optional<Sync> getSync()
```
    Gets a synchronization object for this point.
    
    Specified by:
    
    getSync in interface Point
    
    Returns:
    
    An optional synchronization object.
  - getSyncEntity
```
@Nonnull
 @CheckReturnValue
public final Optional<SyncEntity> getSyncEntity()
```
    Gets the sync entity.
    
    Returns:
    
    The optional sync entity.
  - getTransform
```
@Nonnull
 @CheckReturnValue
public final Optional<Transform> getTransform()
```
    Gets this point's transform.
    
    Returns:
    
    The optional transform used to compute values for this point.
  - getTransformEntity
```
@Nonnull
 @CheckReturnValue
public final Optional<TransformEntity> getTransformEntity()
```
    Gets the transform entity for this point.
    
    Returns:
    
    The optional transform entity.
  - hasInputRelations
```
@CheckReturnValue
public final boolean hasInputRelations()
```
    Asks if this point has input relations.
    
    Returns:
    
    True if it has input relations.
  - hasResultRelations
```
@CheckReturnValue
public final boolean hasResultRelations()
```
    Asks if this point has result relations.
    
    Returns:
    
    True if it has result relations.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class ParamsEntity
  - isDefinition
```
@CheckReturnValue
public abstract boolean isDefinition()
```
    Asks if this point is a definition.
    
    Returns:
    
    True if this is a definition.
  - isDropped
```
public final boolean isDropped()
```
    Asks if this point is dropped.
    A point may be dropped from the metadata of a service if it is not used to fulfill the responsibilities of the service.
    
    Specified by:
    
    isDropped in interface Point
    
    Returns:
    
    True if dropped.
  - isNullRemoves
```
public final boolean isNullRemoves(boolean defaultNullRemoves)
```
    Asks if a null point values should result in the removal of the values at the corresponding time stamp.
    
    Specified by:
    
    isNullRemoves in interface Point
    
    Parameters:
    
    defaultNullRemoves - A default value for the answer.
    
    Returns:
    
    True if null values should be removed.
  - isSynced
```
public boolean isSynced()
```
    Asks if this point has a synchronization object.
    
    Specified by:
    
    isSynced in interface Point
    
    Returns:
    
    True if this point has a synchronization object.
  - isVolatile
```
public final boolean isVolatile()
```
    Asks if this point is volatile.
    
    Specified by:
    
    isVolatile in interface Point
    
    Returns:
    
    True if volatile.
  - resetInputs
```
public final void resetInputs()
```
    Reset the input relations.
  - resetReplicates
```
public final void resetReplicates()
```
    Resets this point's replicates.
  - resetResults
```
public final void resetResults()
```
    Resets the result relations.
  - setContentEntity
```
public final void setContentEntity(@Nonnull
                                   ContentEntity content)
```
    Sets the content entity for this point.
    
    Parameters:
    
    content - The content entity.
  - setDefinition
```
public abstract void setDefinition(@Nonnull
                                   PointEntity definition)
```
    Sets the point's definition.
    
    Parameters:
    
    definition - The point's definition.
  - setDropped
```
public final void setDropped(boolean dropped)
```
    Sets the dropped indicator.
    
    Parameters:
    
    dropped - The new value of the dropped indicator.
  - setOriginEntity
```
public final void setOriginEntity(@Nonnull
                                  Optional<OriginEntity> originEntity)
```
    Sets the origin entity for this point.
    
    Parameters:
    
    originEntity - The optional origin entity.
  - setPermissionsEntity
```
public final void setPermissionsEntity(@Nonnull
                                       Optional<PermissionsEntity> permissions)
```
    Sets the permissions.
    
    Parameters:
    
    permissions - The optional permissions.
  - setStoreEntity
```
public final void setStoreEntity(@Nonnull
                                 Optional<StoreEntity> storeEntity)
```
    Sets the store entity for this point.
    
    Parameters:
    
    storeEntity - The optional store entity.
  - setSyncEntity
```
public final void setSyncEntity(@Nonnull
                                Optional<SyncEntity> syncEntity)
```
    Sets the synchronization reference for this point.
    
    Parameters:
    
    syncEntity - The optional entity used for synchronization.
  - setTransformEntity
```
public final void setTransformEntity(@Nonnull
                                     TransformEntity transform)
```
    Sets the transform entity for this point.
    
    Parameters:
    
    transform - The transform entity.
  - setUp
```
@CheckReturnValue
public final boolean setUp(@Nonnull
                                              Metadata metadata)
```
    Sets up this point.
    
    Parameters:
    
    metadata - The metadata.
    
    Returns:
    
    True if successful.
  - setUpRelations
```
@CheckReturnValue
public final boolean setUpRelations(@Nonnull
                                                       Metadata metadata)
```
    Sets up the input relations of this point.
    
    Parameters:
    
    metadata - The metadata.
    
    Returns:
    
    True if successful.
  - setUpStore
```
@CheckReturnValue
public final boolean setUpStore(@Nonnull
                                                   Metadata metadata)
```
    Sets up the store associated with this point.
    
    Parameters:
    
    metadata - The metadata.
    
    Returns:
    
    True if successful.
  - tearDown
```
public final void tearDown()
```
    Tears down what has been set up.
  - tearDownStore
```
public final void tearDownStore()
```
    Tears down the store associated with this point.
  - tidy
```
public final boolean tidy()
```
    Tidies the point entity.
    This is called after the document load.
    
    Returns:
    
    True on success.
  - toString
```
public final String toString()
```
    Overrides:
    
    toString in class AbstractEntity
    
    Returns:
    
    Its ident, name, uuid (String) or "?".

Class PointEntity

Nested Class Summary

Nested classes/interfaces inherited from class ParamsEntity

Nested classes/interfaces inherited from interface Point

Field Summary

Fields inherited from interface Point

Fields inherited from interface Entity

Constructor Summary

Method Summary

Methods inherited from class ParamsEntity

Methods inherited from class MetadataEntity

Methods inherited from class AbstractEntity

Methods inherited from class Object

Methods inherited from interface Point

Methods inherited from interface Entity

Field Detail

DEFAULT_FILTER

ELEMENT_NAME

ENTITY_PREFIX

ENTITY_REFERENCE_NAME

Constructor Detail

PointEntity

PointEntity

Method Detail

addInputRelation

addReplicate

adjustLevel

clearContentEntity

clearInputs

clearResults

clearTransformEntity

close

compareTo

contentIs

copy

equals

filter

flagResultRelations

getContent

getContentEntity

getDefinition

getElementName

getInputs

getLevel

getOrigin

getOriginEntity

getPermissions

getPermissionsEntity

getPrefix

getRecalcLatest

getReferenceName

getReplicates

getResults

getStore

getStoreEntity

getSync

getSyncEntity

getTransform

getTransformEntity

hasInputRelations

hasResultRelations

hashCode

isDefinition

isDropped

isNullRemoves

isSynced

isVolatile

resetInputs

resetReplicates

resetResults

setContentEntity

setDefinition

setDropped

setOriginEntity

setPermissionsEntity

setStoreEntity

setSyncEntity

setTransformEntity

setUp

setUpRelations