org.hawkular.inventory.api.filters

Class Related<T extends Entity>

java.lang.Object

org.hawkular.inventory.api.filters.Filter

org.hawkular.inventory.api.filters.Related<T>

Type Parameters:

T - The type of the entity using which the filter is constructed.

Direct Known Subclasses:

Contained, Defined, Owned

public class Related<T extends Entity>
extends Filter

Defines a filter on entities having specified relationship.

Since:

1.0

Author:

Lukas Krejci

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Related.EntityRole

Nested classes/interfaces inherited from class org.hawkular.inventory.api.filters.Filter

Filter.Accumulator

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Related(T entity, String relationshipName, Related.EntityRole entityRole)
protected	Related(T entity, String relationshipName, String relationshipId, Related.EntityRole entityRole)

Method Summary

Modifier and Type	Method and Description
static Related<?>	asTargetBy(Relationships.WellKnown relationship) Overloaded version of asTargetBy(String) that uses the Relationships.WellKnown as the name of the relationship.
static Related<?>	asTargetBy(String relationshipName) Creates a filter for entities that are targets of at least one relationship with the specified name.
static <U extends Entity> Related<U>	asTargetWith(U entity, Relationships.WellKnown relationship) An overloaded version of asTargetWith(org.hawkular.inventory.api.model.Entity, String) that uses one of the Relationships.WellKnown as the name of the relationship.
static <U extends Entity> Related<U>	asTargetWith(U entity, String relationship) Specifies a filter for entities that are targets of a relationship with the specified entity.
static Related<?>	by(Relationships.WellKnown relationship) Overloaded version of by(String) that uses the Relationships.WellKnown as the name of the relationship.
static Related<?>	by(String relationshipName) Creates a filter for entities that are sources of at least one relationship with the specified name.
static Related<?>	byRelationshipWithId(String relationshipId) Creates a filter for entities that are sources of at least one relationship with the specified id.
boolean	equals(Object o)
T	getEntity()
Related.EntityRole	getEntityRole()
String	getRelationshipId()
String	getRelationshipName()
int	hashCode()
String	toString()
static <U extends Entity> Related<U>	with(U entity, Relationships.WellKnown relationship) An overloaded version of with(org.hawkular.inventory.api.model.Entity, String) that uses one of the Relationships.WellKnown as the name of the relationship.
static <U extends Entity> Related<U>	with(U entity, String relationship) Specifies a filter for entities that are sources of a relationship with the specified entity.

Methods inherited from class org.hawkular.inventory.api.filters.Filter

all, by, pathTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Related

protected Related(T entity,
                  String relationshipName,
                  String relationshipId,
                  Related.EntityRole entityRole)

Related

protected Related(T entity,
                  String relationshipName,
                  Related.EntityRole entityRole)

Method Detail

with

public static <U extends Entity> Related<U> with(U entity,
                                                 String relationship)

Specifies a filter for entities that are sources of a relationship with the specified entity.

Type Parameters:

U - the type of the entity

Parameters:

entity - the entity that is the target of the relationship

relationship - the name of the relationship

Returns:

a new "related" filter instance

with

public static <U extends Entity> Related<U> with(U entity,
                                                 Relationships.WellKnown relationship)

An overloaded version of with(org.hawkular.inventory.api.model.Entity, String) that uses one of the Relationships.WellKnown as the name of the relationship.

Type Parameters:

U - the type of the entity

Parameters:

entity - the entity that is the target of the relationship

relationship - the type of the relationship

Returns:

a new "related" filter instance

by

public static Related<?> by(String relationshipName)

Creates a filter for entities that are sources of at least one relationship with the specified name. The target entity is not specified and can be anything.

Parameters:

relationshipName - the name of the relationship

Returns:

a new "related" filter instance

by

public static Related<?> by(Relationships.WellKnown relationship)

Overloaded version of by(String) that uses the Relationships.WellKnown as the name of the relationship.

Parameters:

relationship - the type of the relationship

Returns:

a new "related" filter instance

byRelationshipWithId

public static Related<?> byRelationshipWithId(String relationshipId)

Creates a filter for entities that are sources of at least one relationship with the specified id. The target entity is not specified and can be anything.

Parameters:

relationshipId - the id of the relationship

Returns:

a new "related" filter instance

asTargetWith

public static <U extends Entity> Related<U> asTargetWith(U entity,
                                                         String relationship)

Specifies a filter for entities that are targets of a relationship with the specified entity.

Type Parameters:

U - the type of the entity

Parameters:

entity - the entity that is the source of the relationship

relationship - the name of the relationship

Returns:

a new "related" filter instance

asTargetWith

public static <U extends Entity> Related<U> asTargetWith(U entity,
                                                         Relationships.WellKnown relationship)

An overloaded version of asTargetWith(org.hawkular.inventory.api.model.Entity, String) that uses one of the Relationships.WellKnown as the name of the relationship.

Type Parameters:

U - the type of the entity

Parameters:

entity - the entity that is the source of the relationship

relationship - the type of the relationship

Returns:

a new "related" filter instance

asTargetBy

public static Related<?> asTargetBy(String relationshipName)

Creates a filter for entities that are targets of at least one relationship with the specified name. The source entity is not specified and can be anything.

Parameters:

relationshipName - the name of the relationship

Returns:

a new "related" filter instance

asTargetBy

public static Related<?> asTargetBy(Relationships.WellKnown relationship)

Overloaded version of asTargetBy(String) that uses the Relationships.WellKnown as the name of the relationship.

Parameters:

relationship - the type of the relationship

Returns:

a new "related" filter instance

getEntity

public T getEntity()

Returns:

the entity used for creating this filter.

getRelationshipName

public String getRelationshipName()

Returns:

the name of the relationship

getRelationshipId

public String getRelationshipId()

Returns:

the id of the relationship

getEntityRole

public Related.EntityRole getEntityRole()

Returns:

the role of the entity in the filter

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object