org.hawkular.inventory.api.model

Class DataEntity

java.lang.Object

org.hawkular.inventory.api.model.AbstractElement<B,U>

org.hawkular.inventory.api.model.Entity<DataEntity.Blueprint<?>,DataEntity.Update>

org.hawkular.inventory.api.model.DataEntity

public class DataEntity
extends Entity<DataEntity.Blueprint<?>,DataEntity.Update>

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<DataRole extends DataEntity.Role>
static interface	DataEntity.Role An interface a Data entity role must implement.
static class	DataEntity.Update

Nested classes/interfaces inherited from class org.hawkular.inventory.api.model.AbstractElement

AbstractElement.Updater<U extends AbstractElement.Update,E extends AbstractElement<?,U>>

Field Summary

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

ID_PROPERTY, properties

Constructor Summary

Constructors

Constructor and Description
DataEntity(CanonicalPath owner, DataEntity.Role role, StructuredData value)
DataEntity(CanonicalPath owner, DataEntity.Role 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.
DataEntity.Role	getRole()
StructuredData	getValue()
AbstractElement.Updater<DataEntity.Update,? extends AbstractElement<?,DataEntity.Update>>	update()

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

appendToString, toString

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

equals, getId, getPath, getProperties, hashCode, valueOrDefault

Methods inherited from class java.lang.Object

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

Constructor Detail

DataEntity

public DataEntity(CanonicalPath owner,
                  DataEntity.Role role,
                  StructuredData value)

DataEntity

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

DataEntity

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

Method Detail

getValue

public StructuredData getValue()

getRole

public DataEntity.Role 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<DataEntity.Blueprint<?>,DataEntity.Update>

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

update

public AbstractElement.Updater<DataEntity.Update,? extends AbstractElement<?,DataEntity.Update>> update()

Specified by:

update in class AbstractElement<DataEntity.Blueprint<?>,DataEntity.Update>

Returns:

a new updater object to modify this entity and produce a new one.