ai.grakn

Interface GraknGraph

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

AbstractGraknGraph, GraknOrientDBGraph, GraknTinkerGraph, GraknTitanGraph

public interface GraknGraph
extends AutoCloseable

A GraknGraph instance which connects to a specific graph keyspace. Through this object, transactions are automatically opened, which enable the graph to be queried and mutated.

Version:

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 graph, rendering it unusable.
void	commit() Validates and attempts to commit the graph.
<T extends Concept> T	getConcept(String 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 collection of Relations that match 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 the 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.
Type	getType(String 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.
EntityType	putEntityType(String name) Create a new Entity Type, or return a pre-existing Entity Type, with the specified name.
RelationType	putRelationType(String name) Create a Relation Type, or return a pre-existing Relation Type, with the specified name.
<V> ResourceType<V>	putResourceType(String name, ResourceType.DataType<V> dataType) Create a Resource Type, or return a pre-existing Resource Type, with the specified name.
<V> ResourceType<V>	putResourceTypeUnique(String name, ResourceType.DataType<V> dataType) Create a unique Resource Type, or return a pre-existing Resource Type, with the specified name.
RoleType	putRoleType(String name) Create a Role Type, or return a pre-existing Role Type, with the specified name.
RuleType	putRuleType(String name) Create a Rule Type, or return a pre-existing Rule Type, 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 Entity Type, or return a pre-existing Entity Type, with the specified name.

Parameters:

name - A unique name for the Entity Type

Returns:

A new or existing Entity Type with the provided name

putResourceType

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

Create a Resource Type, or return a pre-existing Resource Type, with the specified name.

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 Resource Type

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

Returns:

A new or existing Resource Type with the provided name.

putResourceTypeUnique

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

Create a unique Resource Type, or return a pre-existing Resource Type, with the specified name. The Resource Type 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 Resource Type

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

Returns:

A new or existing Resource Type with the provided name.

putRuleType

RuleType putRuleType(String name)

Create a Rule Type, or return a pre-existing Rule Type, with the specified name.

Parameters:

name - A unique name for the Rule Type

Returns:

new or existing Rule Type with the provided Id.

putRelationType

RelationType putRelationType(String name)

Create a Relation Type, or return a pre-existing Relation Type, with the specified name.

Parameters:

name - A unique name for the Relation Type

Returns:

A new or existing Relation Type with the provided Id.

putRoleType

RoleType putRoleType(String name)

Create a Role Type, or return a pre-existing Role Type, with the specified name.

Parameters:

name - A unique name for the Role Type

Returns:

new or existing Role Type with the provided Id.

getConcept

<T extends Concept> T getConcept(String 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.

getType

Type getType(String 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.

getResourcesByValue

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

Get the 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.

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.

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.

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.

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.

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.

getRelation

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

Get a collection of Relations that match the specified Relation Type and role map, if it exists. 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 collection of Relations which meet the above requirements or an empty collection is no relationship exists fulfilling the above requirements.

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.

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

commit

void commit()
     throws GraknValidationException

Validates and attempts to commit the graph. 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.

rollback

void rollback()

Resets the current transaction without committing.

close

void close()

Closes the current graph, rendering it unusable.

Specified by:

close in interface AutoCloseable