ai.grakn.concept

Interface ResourceType<D>

All Superinterfaces:

Comparable<Concept>, Concept, Type

public interface ResourceType<D>
extends Type

A ResourceType is a schema element which represents the category of resources in the graph.

For the methods below, @param is the data type of this resource represented by the Resource Type. Supported Types include: String, Long, Double, and Boolean

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ResourceType.DataType<D> A class used to hold the supported data types of resources and any other concepts.

Method Summary

Modifier and Type	Method and Description
ResourceType<D>	deletePlaysRole(RoleType roleType) Removes the RoleType to prevent instances of this ResourceType from playing it.
ResourceType.DataType<D>	getDataType() Get the data type to which instances of the ResourceType must conform.
String	getRegex() Retrieve the regular expression to which instances of this ResourceType must conform.
<V> Resource<V>	getResource(V value) Get the Resource with the value provided, and its type, or return NULL
Collection<Resource<D>>	instances() Returns a collection of all Resource Instances of this ResourceType.
Boolean	isUnique() Returns whether the ResourceType is unique.
ResourceType<D>	playsRole(RoleType roleType) Sets the RoleType which instances of this ResourceType may play.
Resource<D>	putResource(D value) Set the value for the Resource, unique to its type.
ResourceType<D>	setAbstract(Boolean isAbstract) Sets the ResourceType to be abstract - which prevents it from having any instances.
ResourceType<D>	setRegex(String regex) Set the regular expression that instances of the ResourceType must conform to.
ResourceType<D>	subType(ResourceType<D> type) Adds another subtype to this type
Collection<ResourceType<D>>	subTypes() Returns a collection of subtypes of this ResourceType.
ResourceType<D>	superType() Returns the supertype of this ResourceType.
ResourceType<D>	superType(ResourceType<D> type) Sets the supertype of the ResourceType to be the ResourceType specified.

Methods inherited from interface ai.grakn.concept.Type

getName, getRulesOfConclusion, getRulesOfHypothesis, hasResource, isAbstract, isImplicit, key, playsRoles

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

setAbstract

ResourceType<D> setAbstract(Boolean isAbstract)

Sets the ResourceType to be abstract - which prevents it from having any instances.

Specified by:

setAbstract in interface Type

Parameters:

isAbstract - Specifies if the ResourceType is to be abstract (true) or not (false).

Returns:

The ResourceType itself.

superType

ResourceType<D> superType(ResourceType<D> type)

Sets the supertype of the ResourceType to be the ResourceType specified.

Parameters:

type - The super type of this ResourceType.

Returns:

The ResourceType itself.

subType

ResourceType<D> subType(ResourceType<D> type)

Adds another subtype to this type

Parameters:

type - The sub type of this resource type

Returns:

The ResourceType itself

playsRole

ResourceType<D> playsRole(RoleType roleType)

Sets the RoleType which instances of this ResourceType may play.

Specified by:

playsRole in interface Type

Parameters:

roleType - The Role Type which the instances of this ResourceType are allowed to play.

Returns:

The ResourceType itself.

deletePlaysRole

ResourceType<D> deletePlaysRole(RoleType roleType)

Removes the RoleType to prevent instances of this ResourceType from playing it.

Specified by:

deletePlaysRole in interface Type

Parameters:

roleType - The Role Type which the instances of this ResourceType should no longer be allowed to play.

Returns:

The ResourceType itself.

setRegex

ResourceType<D> setRegex(String regex)

Set the regular expression that instances of the ResourceType must conform to.

Parameters:

regex - The regular expression that instances of this ResourceType must conform to.

Returns:

The ResourceType itself.

putResource

Resource<D> putResource(D value)

Set the value for the Resource, unique to its type.

Parameters:

value - A value for the Resource which is unique to its type

Returns:

new or existing Resource of this type with the provided value.

superType

ResourceType<D> superType()

Returns the supertype of this ResourceType.

Specified by:

superType in interface Type

Returns:

The supertype of this ResourceType,

getResource

<V> Resource<V> getResource(V value)

Get the Resource with the value provided, and its type, or return NULL

Type Parameters:

V - The data type of the value. Supported types include: String, Long, Double, and Boolean.

Parameters:

value - A value which a Resource in the graph may be holding

Returns:

The Resource with the provided value and type or null if no such Resource exists.

See Also:

Resource

subTypes

Collection<ResourceType<D>> subTypes()

Returns a collection of subtypes of this ResourceType.

Specified by:

subTypes in interface Type

Returns:

The subtypes of this ResourceType

instances

Collection<Resource<D>> instances()

Returns a collection of all Resource Instances of this ResourceType.

Specified by:

instances in interface Type

Returns:

The resource instances of this ResourceType

getDataType

ResourceType.DataType<D> getDataType()

Get the data type to which instances of the ResourceType must conform.

Returns:

The data type to which instances of this resource must conform.

getRegex

String getRegex()

Retrieve the regular expression to which instances of this ResourceType must conform.

Returns:

The regular expression to which instances of this ResourceType must conform.

isUnique

Boolean isUnique()

Returns whether the ResourceType is unique.

Returns:

True if the ResourceType is unique and its instances are limited to one connection to an entity