ai.grakn.concept

Interface Instance

All Superinterfaces:

Comparable<Concept>, Concept

All Known Subinterfaces:

Entity, Relation, Resource<D>, Rule

public interface Instance
extends Concept

Represents an Instance of a particular schema Type. For example an Entity is an Instance of an EntityType just as a Resource is an Instance of a ResourceType.

It represents data in the graph, and allows retrieval of the Relations, RoleTypes and Resources associated with the Instance.

Method Summary

Modifier and Type	Method and Description
Relation	hasResource(Resource resource) Creates a relation from this instance to the provided resource.
Collection<RoleType>	playsRoles() Determine the Role Types that this Instance may play.
Collection<Relation>	relations(RoleType... roleTypes) Retrieves a Relations which the Instance takes part in, which may optionally be narrowed to a particular set according to the RoleType you are interested in.
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, asInstance, asRelation, asRelationType, asResource, asResourceType, asRoleType, asRule, asRuleType, asType, delete, getId, isEntity, isEntityType, isInstance, isRelation, isRelationType, isResource, isResourceType, isRoleType, isRule, isRuleType, isType

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

type

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

Collection<Relation> relations(RoleType... roleTypes)

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

Parameters:

roleTypes - 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:

RoleType, Relation

playsRoles

Collection<RoleType> playsRoles()

Determine the Role Types that this Instance may play.

Returns:

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

See Also:

RoleType

hasResource

Relation hasResource(Resource resource)

Creates a relation from this instance to the provided resource.

Parameters:

resource - The resource to which a relationship is created

Returns:

A relation which contains both the entity and the resource

resources

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 Instance.

See Also:

Resource