Point.Named (RVPF-Core API Documentation)

Object
- Point.Named

All Implemented Interfaces:

Comparable<Entity>, Entity, Point

Enclosing interface:

Point
```
@Immutable
public static final class Point.Named
extends Object
implements Point
```
Named.
A named point object represents a point only by its name or by one of its aliases. This allows requests by clients which do not have access to the complete metadata.

Nested Class Summary
- Nested classes/interfaces inherited from interface Point
  Point.Named, Point.Replicate

Field Summary
- Fields inherited from interface Point
  ARCHIVE_TIME_PARAM, CAPTURE_LIMIT_PARAM, CAPTURE_TIME_PARAM, CEILING_GAP_PARAM, CEILING_RATIO_PARAM, CONFIRM_PARAM, DEADBAND_GAP_PARAM, DEADBAND_RATIO_PARAM, FAIL_RETURNS_NULL_PARAM, FILTER_PARAM, FILTER_STAMP_TRIM_UNIT_PARAM, FILTER_TIME_LIMIT_PARAM, FLOOR_GAP_PARAM, FLOOR_RATIO_PARAM, KEEP_AT_LEAST_PARAM, KEEP_AT_MOST_PARAM, LIFE_TIME_PARAM, NOTIFY_PARAM, NULL, NULL_REMOVES_PARAM, PARAM_PARAM, POLATOR_PARAM, POLATOR_TIME_LIMIT_PARAM, RECALC_LATEST_PARAM, REPLICATED_PARAM, RESPECT_VERSION_PARAM, RESYNCHRONIZED_PARAM, STATES_PARAM, STEP_SIZE_PARAM, TAG_PARAM, VOLATILE_PARAM
- Fields inherited from interface Entity
  UUID_COMPARATOR

Constructor Summary

Constructors
Constructor and Description

Named(String name)
Constructs an instance.

Named(String name, Optional<UUID> uuid)
Constructs an instance.

Constructors
Constructor and Description
`Named(String name)` Constructs an instance.
`Named(String name, Optional<UUID> uuid)` Constructs an instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(Entity other)`
`Point.Named`	`copy()` Creates a copy of this entity.
`boolean`	`equals(Object other)`
`ValueFilter`	`filter()` Returns a configured filter.
`Optional<Attributes>`	`getAttributes(String usage)` Gets the attributes for an usage.
`Optional<Content>`	`getContent()` Gets this point's content handling instance.
`String`	`getElementName()` Gets the entity element name.
`List<? extends PointRelation>`	`getInputs()` Gets this point's inputs.
`int`	`getLevel()` Gets this point's level.
`Optional<String>`	`getName()` Gets the name of this.
`Optional<String>`	`getNameInUpperCase()` Gets the name of this in upper case.
`Optional<Origin>`	`getOrigin()` Gets this point's origin.
`Params`	`getParams()` Gets this point's parameters.
`String`	`getPrefix()` Gets the class prefix.
`String`	`getReferenceName()` Gets the entity reference name.
`List<Point.Replicate>`	`getReplicates()` Gets this point's replicates.
`List<? extends PointRelation>`	`getResults()` Gets this point's dependents.
`Optional<Store>`	`getStore()` Gets this point's store.
`Optional<Sync>`	`getSync()` Gets a synchronization object for this point.
`Optional<UUID>`	`getUUID()` Gets the UUID of this Entity.
`int`	`hashCode()`
`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.
`String`	`toString()`

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

- Constructor Detail
  - Named
```
public Named(@Nonnull
             String name)
```
    Constructs an instance.
    
    Parameters:
    
    name - The point's name.
  - Named
```
public Named(@Nonnull
             String name,
             @Nonnull
             Optional<UUID> uuid)
```
    Constructs an instance.
    
    Parameters:
    
    name - The point's name.
    
    uuid - The optional point's UUID.
- Method Detail
  - compareTo
```
public int compareTo(Entity other)
```
    Specified by:
    
    compareTo in interface Comparable<Entity>
  - copy
```
public Point.Named copy()
```
    Creates a copy of this entity.
    
    Specified by:
    
    copy in interface Entity
    
    Returns:
    
    The copy.
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - filter
```
public ValueFilter filter()
```
    Returns a configured filter.
    
    Specified by:
    
    filter in interface Point
    
    Returns:
    
    The step filter.
  - getAttributes
```
public Optional<Attributes> getAttributes(String usage)
```
    Gets the attributes for an usage.
    
    Specified by:
    
    getAttributes in interface Entity
    
    Parameters:
    
    usage - The usage.
    
    Returns:
    
    The optional attributes.
  - getContent
```
public 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.
  - 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.
  - getInputs
```
public List<? extends PointRelation> 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 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.
  - getName
```
public Optional<String> getName()
```
    Gets the name of this.
    
    Specified by:
    
    getName in interface Entity
    
    Returns:
    
    The optional name.
  - getNameInUpperCase
```
public Optional<String> getNameInUpperCase()
```
    Gets the name of this in upper case.
    
    Specified by:
    
    getNameInUpperCase in interface Entity
    
    Returns:
    
    The optional name in upper case.
  - getOrigin
```
public Optional<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.
  - getParams
```
public Params getParams()
```
    Gets this point's parameters.
    
    Specified by:
    
    getParams in interface Point
    
    Returns:
    
    The point's parameters.
  - 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.
  - getReplicates
```
public List<Point.Replicate> getReplicates()
```
    Gets this point's replicates.
    
    Specified by:
    
    getReplicates in interface Point
    
    Returns:
    
    The point's replicates.
  - getResults
```
public List<? extends PointRelation> 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 Optional<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.
  - getSync
```
public Optional<Sync> getSync()
```
    Gets a synchronization object for this point.
    
    Specified by:
    
    getSync in interface Point
    
    Returns:
    
    An optional synchronization object.
  - getUUID
```
public Optional<UUID> getUUID()
```
    Gets the UUID of this Entity.
    
    Specified by:
    
    getUUID in interface Entity
    
    Returns:
    
    The optional UUID.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - isDropped
```
public 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 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 boolean isVolatile()
```
    Asks if this point is volatile.
    
    Specified by:
    
    isVolatile in interface Point
    
    Returns:
    
    True if volatile.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Point.Named

Nested Class Summary

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 Object

Constructor Detail

Named

Named

Method Detail

compareTo

copy

equals

filter

getAttributes

getContent

getElementName

getInputs

getLevel

getName

getNameInUpperCase

getOrigin

getParams

getPrefix

getReferenceName

getReplicates

getResults

getStore

getSync

getUUID

hashCode

isDropped

isNullRemoves

isSynced

isVolatile

toString