ai.grakn

Interface GraknGraph

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

AbstractGraknGraph, GraknOrientDBGraph, GraknTinkerGraph, GraknTitanGraph

public interface GraknGraph
extends AutoCloseable

A Grakn Graph

This is produced by Grakn.factory(String, String) and allows the user to construct and perform basic look ups to a Grakn Graph. This also allows the execution of Graql queries.

Author:

fppt

Method Summary

Modifier and Type	Method and Description
GraknAdmin	admin() Returns access to the low-level details of the graph via GraknAdmin
void	clear() Closes and clears the current graph.
void	close() Closes the current transaction.
void	commit() Validates and attempts to commit the graph.
<T extends Concept> T	getConcept(ConceptId id) Get the Concept with identifier provided, if it exists.
EntityType	getEntityType(String name) Get the Entity Type with the name provided, if it exists.
String	getKeyspace() Utility function to get the name of the keyspace where the graph is persisted.
Relation	getRelation(RelationType relationType, Map<RoleType,Instance> roleMap) Get a Relation that has the specified Relation Type and role map, if it exists.
RelationType	getRelationType(String name) Get the Relation Type with the name provided, if it exists.
<V> Collection<Resource<V>>	getResourcesByValue(V value) Get all Resources holding the value provided, if they exist.
<V> ResourceType<V>	getResourceType(String name) Get the Resource Type with the name provided, if it exists.
RoleType	getRoleType(String name) Get the Role Type with the name provided, if it exists.
RuleType	getRuleType(String name) Get the Rule Type with the name provided, if it exists.
<T extends Type> T	getType(TypeName name) Get the Type with the name provided, if it exists.
QueryBuilder	graql() Returns a QueryBuilder
boolean	implicitConceptsVisible() Utility function to specify whether implicit concepts should be exposed.
boolean	isClosed() Utility function to determine whether the graph has been closed.
void	open() Opens the graph.
EntityType	putEntityType(String name) Create a new EntityType with super-type entity, or return a pre-existing EntityType, with the specified name.
EntityType	putEntityType(TypeName name) Create a new EntityType with super-type entity, or return a pre-existing EntityType, with the specified name.
RelationType	putRelationType(String name) Create a RelationType with super-type relation, or return a pre-existing RelationType, with the specified name.
RelationType	putRelationType(TypeName name) Create a RelationType with super-type relation, or return a pre-existing RelationType, with the specified name.
<V> ResourceType<V>	putResourceType(String name, ResourceType.DataType<V> dataType) Create a new non-unique ResourceType with super-type resource, or return a pre-existing non-unique ResourceType, with the specified name and data type.
<V> ResourceType<V>	putResourceType(TypeName name, ResourceType.DataType<V> dataType) Create a new non-unique ResourceType with super-type resource, or return a pre-existing non-unique ResourceType, with the specified name and data type.
<V> ResourceType<V>	putResourceTypeUnique(String name, ResourceType.DataType<V> dataType) Create a unique ResourceType with super-type resource, or return a pre-existing unique ResourceType, with the specified name and data type.
<V> ResourceType<V>	putResourceTypeUnique(TypeName name, ResourceType.DataType<V> dataType) Create a unique ResourceType with super-type resource, or return a pre-existing unique ResourceType, with the specified name and data type.
RoleType	putRoleType(String name) Create a RoleType with super-type role, or return a pre-existing RoleType, with the specified name.
RoleType	putRoleType(TypeName name) Create a RoleType with super-type role, or return a pre-existing RoleType, with the specified name.
RuleType	putRuleType(String name) Create a RuleType with super-type rule, or return a pre-existing RuleType, with the specified name.
RuleType	putRuleType(TypeName name) Create a RuleType with super-type rule, or return a pre-existing RuleType, with the specified name.
void	rollback() Resets the current transaction without committing.
void	showImplicitConcepts(boolean flag) Utility function to specify whether implicit and system-generated types should be returned.

Method Detail

putEntityType

EntityType putEntityType(String name)

Create a new EntityType with super-type entity, or return a pre-existing EntityType, with the specified name.

Parameters:

name - A unique name for the EntityType

Returns:

A new or existing EntityType with the provided name

Throws:

GraphRuntimeException - if the graph is closed

ConceptNotUniqueException - if the is already in use by an existing non-EntityType.

putEntityType

EntityType putEntityType(TypeName name)

Create a new EntityType with super-type entity, or return a pre-existing EntityType, with the specified name.

Parameters:

name - A unique name for the EntityType

Returns:

A new or existing EntityType with the provided name

Throws:

GraphRuntimeException - if the graph is closed

ConceptNotUniqueException - if the is already in use by an existing non-EntityType.

putResourceType

<V> ResourceType<V> putResourceType(String name,
                                    ResourceType.DataType<V> dataType)

Create a new non-unique ResourceType with super-type resource, or return a pre-existing non-unique ResourceType, with the specified name and data type.

Type Parameters:

V - The data type of the resource type. Supported types include: String, Long, Double, Boolean. This should match the parameter type

Parameters:

name - A unique name for the ResourceType

dataType - The data type of the ResourceType. Supported types include: DataType.STRING, DataType.LONG, DataType.DOUBLE, and DataType.BOOLEAN

Returns:

A new or existing ResourceType with the provided name and data type.

Throws:

GraphRuntimeException - if the graph is closed

ConceptNotUniqueException - if the is already in use by an existing non-ResourceType.

ConceptException - if the is already in use by an existing ResourceType which is unique or has a different datatype.

putResourceType

<V> ResourceType<V> putResourceType(TypeName name,
                                    ResourceType.DataType<V> dataType)

Create a new non-unique ResourceType with super-type resource, or return a pre-existing non-unique ResourceType, with the specified name and data type.

Type Parameters:

V - The data type of the resource type. Supported types include: String, Long, Double, Boolean. This should match the parameter type

Parameters:

name - A unique name for the ResourceType

dataType - The data type of the ResourceType. Supported types include: DataType.STRING, DataType.LONG, DataType.DOUBLE, and DataType.BOOLEAN

Returns:

A new or existing ResourceType with the provided name and data type.

Throws:

GraphRuntimeException - if the graph is closed

ConceptNotUniqueException - if the is already in use by an existing non-ResourceType.

ConceptException - if the is already in use by an existing ResourceType which is unique or has a different datatype.

putResourceTypeUnique

<V> ResourceType<V> putResourceTypeUnique(String name,
                                          ResourceType.DataType<V> dataType)

Create a unique ResourceType with super-type resource, or return a pre-existing unique ResourceType, with the specified name and data type. The ResourceType is guaranteed to be unique, in that its instances can be connected to one entity.

Type Parameters:

V - The data type of the resource type. Supported types include: String, Long, Double, Boolean. This should match the parameter type

Parameters:

name - A unique name for the ResourceType

dataType - The data type of the ResourceType. Supported types include: DataType.STRING, DataType.LONG, DataType.DOUBLE, and DataType.BOOLEAN

Returns:

A new or existing ResourceType with the provided name.

Throws:

GraphRuntimeException - if the graph is closed

ConceptNotUniqueException - if the is already in use by an existing non-ResourceType.

ConceptException - if the is already in use by an existing ResourceType which is not unique or has a different datatype.

putResourceTypeUnique

<V> ResourceType<V> putResourceTypeUnique(TypeName name,
                                          ResourceType.DataType<V> dataType)

Create a unique ResourceType with super-type resource, or return a pre-existing unique ResourceType, with the specified name and data type. The ResourceType is guaranteed to be unique, in that its instances can be connected to one entity.

Type Parameters:

V - The data type of the resource type. Supported types include: String, Long, Double, Boolean. This should match the parameter type

Parameters:

name - A unique name for the ResourceType

dataType - The data type of the ResourceType. Supported types include: DataType.STRING, DataType.LONG, DataType.DOUBLE, and DataType.BOOLEAN

Returns:

A new or existing ResourceType with the provided name.

Throws:

GraphRuntimeException - if the graph is closed

ConceptNotUniqueException - if the is already in use by an existing non-ResourceType.

ConceptException - if the is already in use by an existing ResourceType which is not unique or has a different datatype.

putRuleType

RuleType putRuleType(String name)

Create a RuleType with super-type rule, or return a pre-existing RuleType, with the specified name.

Parameters:

name - A unique name for the RuleType

Returns:

new or existing RuleType with the provided name.

Throws:

GraphRuntimeException - if the graph is closed

ConceptNotUniqueException - if the is already in use by an existing non-RuleType.

putRuleType

RuleType putRuleType(TypeName name)

Create a RuleType with super-type rule, or return a pre-existing RuleType, with the specified name.

Parameters:

name - A unique name for the RuleType

Returns:

new or existing RuleType with the provided name.

Throws:

GraphRuntimeException - if the graph is closed

ConceptNotUniqueException - if the is already in use by an existing non-RuleType.

putRelationType

RelationType putRelationType(String name)

Create a RelationType with super-type relation, or return a pre-existing RelationType, with the specified name.

Parameters:

name - A unique name for the RelationType

Returns:

A new or existing RelationType with the provided name.

Throws:

GraphRuntimeException - if the graph is closed

ConceptNotUniqueException - if the is already in use by an existing non-RelationType.

putRelationType

RelationType putRelationType(TypeName name)

Create a RelationType with super-type relation, or return a pre-existing RelationType, with the specified name.

Parameters:

name - A unique name for the RelationType

Returns:

A new or existing RelationType with the provided name.

Throws:

GraphRuntimeException - if the graph is closed

ConceptNotUniqueException - if the is already in use by an existing non-RelationType.

putRoleType

RoleType putRoleType(String name)

Create a RoleType with super-type role, or return a pre-existing RoleType, with the specified name.

Parameters:

name - A unique name for the RoleType

Returns:

new or existing RoleType with the provided Id.

Throws:

GraphRuntimeException - if the graph is closed

ConceptNotUniqueException - if the is already in use by an existing non-RoleType.

putRoleType

RoleType putRoleType(TypeName name)

Create a RoleType with super-type role, or return a pre-existing RoleType, with the specified name.

Parameters:

name - A unique name for the RoleType

Returns:

new or existing RoleType with the provided Id.

Throws:

GraphRuntimeException - if the graph is closed

ConceptNotUniqueException - if the is already in use by an existing non-RoleType.

getConcept

<T extends Concept> T getConcept(ConceptId id)

Get the Concept with identifier provided, if it exists.

Parameters:

id - A unique identifier for the Concept in the graph.

Returns:

The Concept with the provided id or null if no such Concept exists.

Throws:

GraphRuntimeException - if the graph is closed

ClassCastException - if the concept is not an instance of T

getType

<T extends Type> T getType(TypeName name)

Get the Type with the name provided, if it exists.

Parameters:

name - A unique name which identifies the Type in the graph.

Returns:

The Type with the provided name or null if no such Type exists.

Throws:

GraphRuntimeException - if the graph is closed

ClassCastException - if the type is not an instance of T

getResourcesByValue

<V> Collection<Resource<V>> getResourcesByValue(V value)

Get all Resources holding the value provided, if they exist.

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 Resources holding the provided value or an empty collection if no such Resource exists.

Throws:

GraphRuntimeException - if the graph is closed

getEntityType

EntityType getEntityType(String name)

Get the Entity Type with the name provided, if it exists.

Parameters:

name - A unique name which identifies the Entity Type in the graph.

Returns:

The Entity Type with the provided name or null if no such Entity Type exists.

Throws:

GraphRuntimeException - if the graph is closed

getRelationType

RelationType getRelationType(String name)

Get the Relation Type with the name provided, if it exists.

Parameters:

name - A unique name which identifies the Relation Type in the graph.

Returns:

The Relation Type with the provided name or null if no such Relation Type exists.

Throws:

GraphRuntimeException - if the graph is closed

getResourceType

<V> ResourceType<V> getResourceType(String name)

Get the Resource Type with the name provided, if it exists.

Type Parameters:

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

Parameters:

name - A unique name which identifies the Resource Type in the graph.

Returns:

The Resource Type with the provided name or null if no such Resource Type exists.

Throws:

GraphRuntimeException - if the graph is closed

getRoleType

RoleType getRoleType(String name)

Get the Role Type with the name provided, if it exists.

Parameters:

name - A unique name which identifies the Role Type in the graph.

Returns:

The Role Type with the provided name or null if no such Role Type exists.

Throws:

GraphRuntimeException - if the graph is closed

getRuleType

RuleType getRuleType(String name)

Get the Rule Type with the name provided, if it exists.

Parameters:

name - A unique name which identifies the Rule Type in the graph.

Returns:

The Rule Type with the provided name or null if no such Rule Type exists.

Throws:

GraphRuntimeException - if the graph is closed

getRelation

Relation getRelation(RelationType relationType,
                     Map<RoleType,Instance> roleMap)

Get a Relation that has the specified Relation Type and role map, if it exists. Otherwise, return null. Caller specifies a Relation Type and a role map, which lists the Instances or Resources in the relationship, and the roles each play.

Parameters:

relationType - The Relation Type which we wish to find a Relation instance of.

roleMap - A role map specifying the rolePlayers (Instances or Resources) in the relationship and the roles (Role Types) they play.

Returns:

a Relation which meet the above requirements or null if no relationship exists fulfilling the above requirements.

Throws:

GraphRuntimeException - if the graph is closed

admin

GraknAdmin admin()

Returns access to the low-level details of the graph via GraknAdmin

Returns:

The admin interface which allows you to access more low level details of the graph.

See Also:

GraknAdmin

showImplicitConcepts

void showImplicitConcepts(boolean flag)

Utility function to specify whether implicit and system-generated types should be returned.

Parameters:

flag - Specifies if implicit and system-generated types should be returned.

implicitConceptsVisible

boolean implicitConceptsVisible()

Utility function to specify whether implicit concepts should be exposed.

Returns:

true if implicit concepts are exposed.

clear

void clear()

Closes and clears the current graph.

Throws:

GraphRuntimeException - if the graph is closed

getKeyspace

String getKeyspace()

Utility function to get the name of the keyspace where the graph is persisted.

Returns:

The name of the keyspace where the graph is persisted

isClosed

boolean isClosed()

Utility function to determine whether the graph has been closed.

Returns:

True if the graph has been closed

graql

QueryBuilder graql()

Returns a QueryBuilder

Returns:

returns a query builder to allow for the creation of graql queries

See Also:

QueryBuilder

rollback

void rollback()

Resets the current transaction without committing.

Throws:

GraphRuntimeException - if the graph is closed

close

void close()

Closes the current transaction. If no transactions remain open the graph connection is closed permanently and the GraknGraphFactory must be used to get a new connection.

Specified by:

close in interface AutoCloseable

open

void open()

Opens the graph. This must be called before a new thread can use the graph.

commit

void commit()
     throws GraknValidationException

Validates and attempts to commit the graph. Also submits commit logs for post processing An exception is thrown if validation fails or if the graph cannot be persisted due to an underlying database issue.

Throws:

GraknValidationException - is thrown when a structural validation fails.