org.hawkular.inventory.base

Class BaseMetrics.ReadAssociate<BE>

java.lang.Object

org.hawkular.inventory.base.Traversal<BE,E>

org.hawkular.inventory.base.BaseMetrics.ReadAssociate<BE>

All Implemented Interfaces:

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

Enclosing class:

BaseMetrics

public static class BaseMetrics.ReadAssociate<BE>
extends Traversal<BE,E>
implements Metrics.ReadAssociate

Field Summary

Fields inherited from class org.hawkular.inventory.base.Traversal

context

Constructor Summary

Constructors

Constructor and Description
ReadAssociate(TraversalContext<BE,Metric> context)

Method Summary

Modifier and Type	Method and Description
Relationship	associate(Path id) 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.
protected Relationship	createAssociation(Class<? extends Entity<?,?>> sourceType, Relationships.WellKnown relationship, BE target)
protected Relationship	deleteAssociation(Class<? extends Entity<?,?>> sourceType, Relationships.WellKnown relationship, BE target)
Relationship	disassociate(Path id) Removes an entity from the relation with the current entity.
Metrics.Single	get(Path 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 the provided filters in the current position in the inventory traversal.
protected Relationship	getAssociation(Class<? extends Entity<?,?>> sourceType, Path targetPath, Relationships.WellKnown rel)

Methods inherited from class org.hawkular.inventory.base.Traversal

getSingle, isApplicable, mutating, readOnly

Methods inherited from class java.lang.Object

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

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

getAll

Constructor Detail

ReadAssociate

public ReadAssociate(TraversalContext<BE,Metric> context)

Method Detail

associate

public Relationship associate(Path 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(
 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:

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

public Relationship disassociate(Path 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(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

getAll

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

Description copied from interface: ResolvingToMultiple

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

The filters parameter is actually composed of individual sets of filters each of which is applied to the "source" entities. Each set can have multiple filters that are then applied one after another on their intermediate results. This becomes useful when you want to filter by sources having some kind of relationships with other entities and in addition filter on the sources themselves, too. E.g.:

 inventory.tenants().getAll(new Filter[][]{{Related.by("myRel"), With.type(ResourceType.class)},
 {With.id("asf")}}).entities();
 

The filter above would first check that the tenants in question have a relationship called "myRel" with some resource types and then would also check if the tenant has ID "asf".

Specified by:

getAll in interface ResolvingToMultiple<Metrics.Multiple>

Parameters:

filters - the sets of filters to apply

Returns:

the access to found entities

get

public Metrics.Single get(Path 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,Path>

Parameters:

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

Returns:

access interface to the entity

Throws:

EntityNotFoundException

createAssociation

protected Relationship createAssociation(Class<? extends Entity<?,?>> sourceType,
                                         Relationships.WellKnown relationship,
                                         BE target)

deleteAssociation

protected Relationship deleteAssociation(Class<? extends Entity<?,?>> sourceType,
                                         Relationships.WellKnown relationship,
                                         BE target)

getAssociation

protected Relationship getAssociation(Class<? extends Entity<?,?>> sourceType,
                                      Path targetPath,
                                      Relationships.WellKnown rel)