ai.grakn.concept

Interface Thing

All Superinterfaces:

Comparable<Concept>, Concept

All Known Subinterfaces:

Entity, Relation, Resource<D>, Rule

All Known Implementing Classes:

RelationReified

public interface Thing
extends Concept

A data instance in the graph belonging to a specific Type

Instances represent data in the graph. Every instance belongs to a Type which serves as a way of categorising them. Instances can relate to one another via Relation

Author:

fppt

See Also:

Entity, Relation, Resource, Rule

Method Summary

Modifier and Type	Method and Description
default Thing	asThing() Deprecated.
default boolean	isThing() Deprecated.
Collection<Role>	plays() Determine the Role Types that this Thing may play.
Collection<Relation>	relations(Role... roles) Retrieves a Relations which the Thing takes part in, which may optionally be narrowed to a particular set according to the Role you are interested in.
Thing	resource(Resource resource) Creates a relation from this instance to the provided resource.
Collection<Resource<?>>	resources(ResourceType... resourceTypes) Retrieves a collection of Resources attached to this Instances
Type	type() Return the Type of the Concept.

Methods inherited from interface ai.grakn.concept.Concept

asEntity, asEntityType, asOntologyConcept, asRelation, asRelationType, asResource, asResourceType, asRole, asRule, asRuleType, asType, delete, getId, isEntity, isEntityType, isOntologyConcept, isRelation, isRelationType, isResource, isResourceType, isRole, isRule, isRuleType, isType

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

type

@CheckReturnValue
Type type()

Return the Type of the Concept.

Returns:

A Type which is the type of this concept. This concept is an instance of that type.

relations

@CheckReturnValue
Collection<Relation> relations(Role... roles)

Retrieves a Relations which the Thing takes part in, which may optionally be narrowed to a particular set according to the Role you are interested in.

Parameters:

roles - An optional parameter which allows you to specify the role of the relations you wish to retrieve.

Returns:

A set of Relations which the concept instance takes part in, optionally constrained by the Role Type.

See Also:

Role, Relation

plays

@CheckReturnValue
Collection<Role> plays()

Determine the Role Types that this Thing may play.

Returns:

A set of all the Role Types which this instance plays.

See Also:

Role

resource

Thing resource(Resource resource)

Creates a relation from this instance to the provided resource.

Parameters:

resource - The resource to which a relationship is created

Returns:

The instance itself

resources

@CheckReturnValue
Collection<Resource<?>> resources(ResourceType... resourceTypes)

Retrieves a collection of Resources attached to this Instances

Parameters:

resourceTypes - Resource Types of the resources attached to this entity

Returns:

A collection of resources attached to this Thing.

See Also:

Resource

asThing

@Deprecated
 @CheckReturnValue
default Thing asThing()

Deprecated.

Description copied from interface: Concept

Return as an Thing if the Concept is an Thing.

Specified by:

asThing in interface Concept

Returns:

An Thing if the Concept is an Thing

isThing

@Deprecated
 @CheckReturnValue
default boolean isThing()

Deprecated.

Description copied from interface: Concept

Determine if the Concept is an Thing.

Specified by:

isThing in interface Concept

Returns:

true if the Concept is an Thing