org.hawkular.inventory.api

Class EmptyInventory.MetricsReadAssociate

java.lang.Object

org.hawkular.inventory.api.EmptyInventory.MetricsReadAssociate

All Implemented Interfaces:

Metrics.ReadAssociate, ReadInterface<Metrics.Single,Metrics.Multiple>, ResolvingToMultiple<Metrics.Multiple>, ResolvingToSingle<Metrics.Single>

Enclosing class:

EmptyInventory

public static class EmptyInventory.MetricsReadAssociate
extends Object
implements Metrics.ReadAssociate

Constructor Summary

Constructors

Constructor and Description
MetricsReadAssociate()

Method Summary

Modifier and Type	Method and Description
Relationship	associate(String id) Adds a pre-existing entity into the relation with the current entity.
Relationship	associationWith(String id) Finds the relationship with the entity with the provided id.
Relationship	disassociate(String id) Removes an entity from the relation with the current entity.
Metrics.Single	get(String id) Tries to find a single entity in the current position in the inventory traversal.
Metrics.Multiple	getAll(Filter... filters) Returns access interface to all entities conforming to provided filters in the current position in the inventory traversal.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MetricsReadAssociate

public MetricsReadAssociate()

Method Detail

associate

public Relationship associate(String id)
                       throws EntityNotFoundException,
                              RelationAlreadyExistsException

Adds a pre-existing entity into the relation with the current entity. The current entity is determined by the current position in the inventory traversal as is the type of the entity being related to it. Consider this example:

 inventory.tenants().get(tenantId).environments().get(envId).resources().get(rId).metrics().associate(metricId);
 

In here the associate method will add a new metric (identified by the metricId) to the resource identified by the rId.

Parameters:

id - the id of a pre-existing entity to be related to the entity on the current position in the inventory traversal.

Returns:

the relationship that was created as the consequence of the association.

Throws:

EntityNotFoundException

RelationAlreadyExistsException

disassociate

public Relationship disassociate(String id)
                          throws EntityNotFoundException

Removes an entity from the relation with the current entity. The current entity and the type of the entity to remove from the relation is determined by the current position in the inventory traversal.

Parameters:

id - the id of the entity to remove from the relation with the current entity.

Returns:

the relationship that was deleted as a result of the disassociation

Throws:

EntityNotFoundException

See Also:

for explanation of how the current entity and the relation is determined.

associationWith

public Relationship associationWith(String id)
                             throws RelationNotFoundException

Finds the relationship with the entity with the provided id.

Parameters:

id - the id of the entity to find the relation with

Returns:

the relationship found

Throws:

RelationNotFoundException - if a relation with an entity of given id doesn't exist

See Also:

for the discussion of how the entity and the relationship is determined

getAll

public Metrics.Multiple getAll(Filter... filters)

Description copied from interface: ResolvingToMultiple

Returns access interface to all entities conforming to provided filters in the current position in the inventory traversal.

Specified by:

getAll in interface ResolvingToMultiple<Metrics.Multiple>

Parameters:

filters - the (possibly empty) list of filters to apply.

Returns:

the (read-only) access interface to the found entities

get

public Metrics.Single get(String id)
                   throws EntityNotFoundException

Description copied from interface: ResolvingToSingle

Tries to find a single entity in the current position in the inventory traversal.

Specified by:

get in interface ResolvingToSingle<Metrics.Single>

Parameters:

id - the id of the entity to find in the current traversal position

Returns:

access interface to the entity

Throws:

EntityNotFoundException