org.hawkular.inventory.api

Interface Relationships.ReadWrite

All Known Implementing Classes:

BaseRelationships.ReadWrite, EmptyInventory.RelationshipsReadWrite

Enclosing class:

Relationships

public static interface Relationships.ReadWrite

Provides read-write access to relationships.

Method Summary

Modifier and Type	Method and Description
void	delete(String id) Deletes an relationship with the provided id from the current position in the inventory traversal.
Single	get(String id) Tries to find a single relationship in the current position in the inventory traversal.
Multiple	getAll(RelationFilter... filters) Returns access interface to all relationships conforming to provided filters in the current position in the inventory traversal.
default Single	linkWith(Relationships.WellKnown name, CanonicalPath targetOrSource, Map<String,Object> properties)
Single	linkWith(String name, CanonicalPath targetOrSource, Map<String,Object> properties) Creates a new relationship at the current position in the inventory traversal.
Relationships.Multiple	named(Relationships.WellKnown name)
Relationships.Multiple	named(String name)
void	update(String id, Relationship.Update update) Updates the provided relationship on the current position in the inventory traversal.

Method Detail

named

Relationships.Multiple named(String name)

named

Relationships.Multiple named(Relationships.WellKnown name)

get

Single get(String id)
    throws EntityNotFoundException,
           RelationNotFoundException

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

Parameters:

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

Returns:

access interface to the relationship

Throws:

EntityNotFoundException

RelationNotFoundException

getAll

Multiple getAll(RelationFilter... filters)

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

Parameters:

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

Returns:

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

linkWith

Single linkWith(String name,
                CanonicalPath targetOrSource,
                Map<String,Object> properties)
         throws IllegalArgumentException

Creates a new relationship at the current position in the inventory traversal.

It is possible to have multiple relationships with the same name between 2 entities. These relationships will differ in their ids and can have different properties.

Note: please review the comments on the individual well-known relationships ( contains, defines, incorporates) for restrictions of usage, especially what restrictions the relationships impose when deleting entities.

Parameters:

name - the name of the relationship

targetOrSource - the the source/target entity (based on the chosen relationship direction) that the current entity (based on the position in the inventory traversal) will be in the relationship with

properties - the properties of the newly created relationship or null if none specified

Returns:

access interface to the freshly created relationship

Throws:

IllegalArgumentException - if any of the parameters is null

EntityNotFoundException - if the current position in the inventory traversal doesn't evaluate to an existing entity or if the provided other end of the relationship doesn't exist.

linkWith

default Single linkWith(Relationships.WellKnown name,
                        CanonicalPath targetOrSource,
                        Map<String,Object> properties)
                 throws IllegalArgumentException

Throws:

IllegalArgumentException

See Also:

linkWith(String, CanonicalPath, Map)

update

void update(String id,
            Relationship.Update update)
     throws RelationNotFoundException

Updates the provided relationship on the current position in the inventory traversal.

Parameters:

id - the id of the relationship to update

update - the update

Throws:

RelationNotFoundException - if the relationship is not found in the database

delete

void delete(String id)
     throws RelationNotFoundException

Deletes an relationship with the provided id from the current position in the inventory traversal.

Parameters:

id - the id of the relationship to delete

Throws:

RelationNotFoundException - if the relation with given id doesn't exist on the current position in the inventory traversal