org.hawkular.inventory.api

Interface MetricTypes.ReadAssociate

All Superinterfaces:

MetricTypes.Read, ReadInterface<MetricTypes.Single,MetricTypes.Multiple,Path>, ResolvingToMultiple<MetricTypes.Multiple>, ResolvingToSingle<MetricTypes.Single,Path>

All Known Implementing Classes:

BaseMetricTypes.ReadAssociate, EmptyInventory.MetricTypesReadAssociate

Enclosing class:

MetricTypes

public static interface MetricTypes.ReadAssociate
extends MetricTypes.Read

Provides read-only access to metric types with the additional ability to relate the metric types to the current position in the inventory traversal.

Method Summary

Modifier and Type	Method and Description
Relationship	associate(Path path) Adds a pre-existing entity into the relation with the current entity.
Relationship	associationWith(Path path) Finds the relationship with the entity with the provided id.
Relationship	disassociate(Path path) Removes an entity from the relation with the current entity.

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

get

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

getAll, getAll

Method Detail

associate

Relationship associate(Path path)
                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(
 RelativePath.to().up().metric(metricId));
 

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

The provided path can be a RelativePath (as in the above example) which is evaluated against the current position in the graph - the up() call will move up the path from the resource to the environment and the metric() call will the move to a metric in that environment.

The provided path can also be a CanonicalPath in which case it is fully evaluated and the entity on that path is associated (provided the path points to the correct type of entity and all the rules specific for the association of the two types of entities are fulfilled).

Parameters:

path - the path to 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

Relationship disassociate(Path path)
                   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:

path - 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

Relationship associationWith(Path path)
                      throws RelationNotFoundException

Finds the relationship with the entity with the provided id.

Parameters:

path - 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