ai.grakn.concept

Interface ResourceType<D>

Type Parameters:

D - The data type of this resource type. Supported Types include: String, Long, Double, and Boolean

All Superinterfaces:

Comparable<Concept>, Concept, OntologyConcept, Type

public interface ResourceType<D>
extends Type

An ontological element which models and categorises the various Resource in the graph.

This ontological element behaves similarly to Type when defining how it relates to other types. It has two additional functions to be aware of: 1. It has a ResourceType.DataType constraining the data types of the values it's instances may take. 2. Any of it's instances are unique to the type. For example if you have a ResourceType modelling month throughout the year there can only be one January.

Author:

fppt

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
default ResourceType	asResourceType() Deprecated.
ResourceType<D>	deletePlays(Role role) Removes the Role to prevent instances of this ResourceType from playing it.
ResourceType<D>	deleteScope(Thing scope) Delete the scope specified.
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, or null if no regular expression is set.
Resource<D>	getResource(D 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.
default boolean	isResourceType() Deprecated.
ResourceType<D>	key(ResourceType resourceType) Creates a RelationType which allows this type and a resource type to be linked in a strictly one-to-one mapping.
ResourceType<D>	plays(Role role) Sets the Role which instances of this ResourceType may play.
Resource<D>	putResource(D value) Set the value for the Resource, unique to its type.
ResourceType<D>	resource(ResourceType resourceType) Creates a RelationType which allows this type and a resource type to be linked.
ResourceType<D>	scope(Thing scope) Classifies the type to a specific scope.
ResourceType<D>	setAbstract(Boolean isAbstract) Sets the ResourceType to be abstract - which prevents it from having any instances.
ResourceType	setLabel(Label label) Changes the Label of this Concept to a new one.
ResourceType<D>	setRegex(String regex) Set the regular expression that instances of the ResourceType must conform to.
ResourceType<D>	sub(ResourceType<D> type) Adds another subtype to this type
Collection<ResourceType<D>>	subs() Returns a collection of subtypes of this ResourceType.
ResourceType<D>	sup() Returns the supertype of this ResourceType.
ResourceType<D>	sup(ResourceType<D> type) Sets the supertype of the ResourceType to be the ResourceType specified.

Methods inherited from interface ai.grakn.concept.Type

asType, isAbstract, isType, keys, plays, resources, scopes

Methods inherited from interface ai.grakn.concept.OntologyConcept

asOntologyConcept, getLabel, getLabelId, getRulesOfConclusion, getRulesOfHypothesis, isImplicit, isOntologyConcept

Methods inherited from interface ai.grakn.concept.Concept

asEntity, asEntityType, asRelation, asRelationType, asResource, asRole, asRule, asRuleType, asThing, delete, getId, isEntity, isEntityType, isRelation, isRelationType, isResource, isRole, isRule, isRuleType, isThing

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

setLabel

ResourceType setLabel(Label label)

Changes the Label of this Concept to a new one.

Specified by:

setLabel in interface OntologyConcept

Specified by:

setLabel in interface Type

Parameters:

label - The new Label.

Returns:

The Concept itself

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.

sup

ResourceType<D> sup(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.

sub

ResourceType<D> sub(ResourceType<D> type)

Adds another subtype to this type

Parameters:

type - The sub type of this resource type

Returns:

The ResourceType itself

plays

ResourceType<D> plays(Role role)

Sets the Role which instances of this ResourceType may play.

Specified by:

plays in interface Type

Parameters:

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

Returns:

The ResourceType itself.

deletePlays

ResourceType<D> deletePlays(Role role)

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

Specified by:

deletePlays in interface Type

Parameters:

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

scope

ResourceType<D> scope(Thing scope)

Classifies the type to a specific scope. This allows you to optionally categorise types.

Specified by:

scope in interface Type

Parameters:

scope - The category of this Type

Returns:

The Type itself.

deleteScope

ResourceType<D> deleteScope(Thing scope)

Delete the scope specified.

Specified by:

deleteScope in interface Type

Parameters:

scope - The Instances that is currently scoping this Type.

Returns:

The Type itself

key

ResourceType<D> key(ResourceType resourceType)

Creates a RelationType which allows this type and a resource type to be linked in a strictly one-to-one mapping.

Specified by:

key in interface Type

Parameters:

resourceType - The resource type which instances of this type should be allowed to play.

Returns:

The Type itself.

resource

ResourceType<D> resource(ResourceType resourceType)

Creates a RelationType which allows this type and a resource type to be linked.

Specified by:

resource in interface Type

Parameters:

resourceType - The resource type which instances of this type should be allowed to play.

Returns:

The Type itself.

sup

@Nonnull
ResourceType<D> sup()

Returns the supertype of this ResourceType.

Specified by:

sup in interface OntologyConcept

Specified by:

sup in interface Type

Returns:

The supertype of this ResourceType,

getResource

@CheckReturnValue
 @Nullable
Resource<D> getResource(D value)

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

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

subs

Collection<ResourceType<D>> subs()

Returns a collection of subtypes of this ResourceType.

Specified by:

subs in interface OntologyConcept

Specified by:

subs 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

@CheckReturnValue
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

@CheckReturnValue
 @Nullable
String getRegex()

Retrieve the regular expression to which instances of this ResourceType must conform, or null if no regular expression is set. By default, a ResourceType does not have a regular expression set.

Returns:

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

asResourceType

@Deprecated
 @CheckReturnValue
default ResourceType asResourceType()

Deprecated.

Description copied from interface: Concept

Return as a RelationType if the Concept is a RelationType

Specified by:

asResourceType in interface Concept

Returns:

A RelationType if the Concept is a RelationType

isResourceType

@Deprecated
 @CheckReturnValue
default boolean isResourceType()

Deprecated.

Description copied from interface: Concept

Determine if the Concept is a ResourceType.

Specified by:

isResourceType in interface Concept

Returns:

true if theConcept concept is a ResourceType