org.hawkular.inventory.api

Interface Data.Single

All Superinterfaces:

ResolvableToSingle<DataEntity,DataEntity.Update>

All Known Implementing Classes:

BaseData.Single, EmptyInventory.DatasSingle

Enclosing class:

Data

public static interface Data.Single
extends ResolvableToSingle<DataEntity,DataEntity.Update>

Method Summary

Modifier and Type	Method and Description
StructuredData	data(RelativePath dataPath) Returns the data on the path relative to the entity.
DataEntity	entity() Loads the data entity on the current position in the inventory traversal along with its data.
default boolean	exists() Similar to ResolvableToSingle.entity() but merely checks whether the entity exists on the position in the inventory traversal.
StructuredData	flatData(RelativePath dataPath) This is very similar to data(RelativePath) but this method doesn't load the child data.
void	update(DataEntity.Update update) Updates the entity.

Methods inherited from interface org.hawkular.inventory.api.ResolvableToSingle

delete

Method Detail

entity

DataEntity entity()
           throws EntityNotFoundException

Loads the data entity on the current position in the inventory traversal along with its data.

Note that this might be a potentially expensive operation because of the attached data structure being loaded.

Specified by:

entity in interface ResolvableToSingle<DataEntity,DataEntity.Update>

Returns:

the fully loaded structured data on the current position in the inventory traversal

Throws:

EntityNotFoundException - if there is no structured data on the current position in the inventory

See Also:

ResolvableToSingle.entity()

data

StructuredData data(RelativePath dataPath)

Returns the data on the path relative to the entity. In another words, you can use this method to obtain only a subset of the data stored on the data entity.

I.e if you have an data entity which contains a map with a key "foo", which contains a list and you want to obtain a third element of that list, you'd do: ...data(RelativePath.to().structuredData().key("foo").index(2).get());

If you want to obtain the whole data structure, use an empty path: RelativePath.empty().get().

Parameters:

dataPath - the path to the subset of the data.

Returns:

the subset of the data stored with the data entity

See Also:

flatData(RelativePath)

flatData

StructuredData flatData(RelativePath dataPath)

This is very similar to data(RelativePath) but this method doesn't load the child data.

If the data on the path contains a "primitive" value, the value is loaded. If the data contains a list, the returned instance will contain an empty list and if the data contains a map the returned instance will contain an empty map.

Parameters:

dataPath - the path to the subset of the data to return

Returns:

the subset of the data stored with the data entity

exists

default boolean exists()

Description copied from interface: ResolvableToSingle

Similar to ResolvableToSingle.entity() but merely checks whether the entity exists on the position in the inventory traversal.

Note that the default implementation might not be optimal performance-wise because it tries to fully resolve the entity using the ResolvableToSingle.entity() method but discards that result right after.

Specified by:

exists in interface ResolvableToSingle<DataEntity,DataEntity.Update>

Returns:

true if there is an entity, false otherwise.

update

void update(DataEntity.Update update)
     throws EntityNotFoundException,
            RelationNotFoundException,
            ValidationException

Description copied from interface: ResolvableToSingle

Updates the entity.

Specified by:

update in interface ResolvableToSingle<DataEntity,DataEntity.Update>

Parameters:

update - the update to be applied

Throws:

EntityNotFoundException - if there is no entity corresponding to the traversal

RelationNotFoundException - if there is no relation corresponding to the traversal

ValidationException