org.hawkular.inventory.api.model

Class DataEntity

java.lang.Object

org.hawkular.inventory.api.model.AbstractElement

org.hawkular.inventory.api.model.Entity

org.hawkular.inventory.api.model.DataEntity

public final class DataEntity
extends Entity

A data entity is an entity wrapping the data. It's sole purpose is to give a path to the piece of structured data.

A data entity has an owner - the data entities are not shared amongst entities. Further, it has a role - a purpose for which the owner holds on to the data.

Since:

0.3.0

Author:

Lukas Krejci

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataEntity.Blueprint<DR extends DataRole>

Field Summary

Fields

Modifier and Type	Field and Description
static SegmentType	SEGMENT_TYPE

Fields inherited from class org.hawkular.inventory.api.model.AbstractElement

properties

Constructor Summary

Constructors

Constructor and Description
DataEntity(CanonicalPath owner, DataRole role, StructuredData value)
DataEntity(CanonicalPath owner, DataRole role, StructuredData value, Map<String,Object> properties)
DataEntity(CanonicalPath path, StructuredData value, Map<String,Object> properties)

Method Summary

Modifier and Type	Method and Description
<R,P> R	accept(ElementVisitor<R,P> visitor, P parameter) Accepts the provided visitor.
String	getName()
DataRole	getRole()
StructuredData	getValue()

Methods inherited from class org.hawkular.inventory.api.model.Entity

appendToString, entityTypeFromSegmentType, toString, typeFromSegmentType

Methods inherited from class org.hawkular.inventory.api.model.AbstractElement

equals, getId, getPath, getProperties, hashCode, segmentTypeFromType, toElementClass

Methods inherited from class java.lang.Object

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

Field Detail

SEGMENT_TYPE

public static final SegmentType SEGMENT_TYPE

Constructor Detail

DataEntity

public DataEntity(CanonicalPath owner,
                  DataRole role,
                  StructuredData value)

DataEntity

public DataEntity(CanonicalPath owner,
                  DataRole role,
                  StructuredData value,
                  Map<String,Object> properties)

DataEntity

public DataEntity(CanonicalPath path,
                  StructuredData value,
                  Map<String,Object> properties)

Method Detail

getName

public String getName()

Overrides:

getName in class Entity

Returns:

The human readable name of the entity, can be null

getValue

public StructuredData getValue()

getRole

public DataRole getRole()

accept

public <R,P> R accept(ElementVisitor<R,P> visitor,
                      P parameter)

Description copied from class: AbstractElement

Accepts the provided visitor.

Specified by:

accept in class AbstractElement

Type Parameters:

R - the return type

P - the type of the parameter

Parameters:

visitor - the visitor to visit this entity

parameter - the parameter to pass on to the visitor

Returns:

the return value provided by the visitor