ai.grakn

Interface GraknGraph

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

AbstractGraknGraph, GraknTinkerGraph, GraknTitanGraph

public interface GraknGraph
extends AutoCloseable

A Grakn Graph

This is produced by Grakn.session(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
void	abort() Reverts any changes done to the graph and closes the transaction.
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() Commits any changes to the graph and closes the transaction.
<T extends Concept> T	getConcept(ConceptId id) Get the Concept with identifier provided, if it exists.
EntityType	getEntityType(String label) Get the Entity Type with the label provided, if it exists.
String	getKeyspace() Utility function to get the name of the keyspace where the graph is persisted.
RelationType	getRelationType(String label) Get the Relation Type with the label 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 label) Get the Resource Type with the label provided, if it exists.
RoleType	getRoleType(String label) Get the Role Type with the label provided, if it exists.
RuleType	getRuleType(String label) Get the Rule Type with the label provided, if it exists.
<T extends Type> T	getType(TypeLabel label) Get the Type with the label 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.
boolean	isReadOnly() Utility function used to check if the current transaction on the graph is a read only transaction
EntityType	putEntityType(String label) Create a new EntityType with super-type entity, or return a pre-existing EntityType, with the specified label.
EntityType	putEntityType(TypeLabel label) Create a new EntityType with super-type entity, or return a pre-existing EntityType, with the specified label.
RelationType	putRelationType(String label) Create a RelationType with super-type relation, or return a pre-existing RelationType, with the specified label.
RelationType	putRelationType(TypeLabel label) Create a RelationType with super-type relation, or return a pre-existing RelationType, with the specified label.
<V> ResourceType<V>	putResourceType(String label, 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 label and data type.
<V> ResourceType<V>	putResourceType(TypeLabel label, 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 label and data type.
RoleType	putRoleType(String label) Create a RoleType with super-type role, or return a pre-existing RoleType, with the specified label.
RoleType	putRoleType(TypeLabel label) Create a RoleType with super-type role, or return a pre-existing RoleType, with the specified label.
RuleType	putRuleType(String label) Create a RuleType with super-type rule, or return a pre-existing RuleType, with the specified label.
RuleType	putRuleType(TypeLabel label) Create a RuleType with super-type rule, or return a pre-existing RuleType, with the specified label.
void	showImplicitConcepts(boolean flag) Utility function to specify whether implicit and system-generated types should be returned.

Method Detail

putEntityType

EntityType putEntityType(String label)

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

Parameters:

label - A unique label for the EntityType

Returns:

A new or existing EntityType with the provided label

Throws:

GraphRuntimeException - if the graph is closed

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

putEntityType

EntityType putEntityType(TypeLabel label)

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

Parameters:

label - A unique label for the EntityType

Returns:

A new or existing EntityType with the provided label

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 label,
                                    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 label 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:

label - A unique label 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 label 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(TypeLabel label,
                                    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 label 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:

label - A unique label 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 label 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.

putRuleType

RuleType putRuleType(String label)

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

Parameters:

label - A unique label for the RuleType

Returns:

new or existing RuleType with the provided label.

Throws:

GraphRuntimeException - if the graph is closed

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

putRuleType

RuleType putRuleType(TypeLabel label)

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

Parameters:

label - A unique label for the RuleType

Returns:

new or existing RuleType with the provided label.

Throws:

GraphRuntimeException - if the graph is closed

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

putRelationType

RelationType putRelationType(String label)

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

Parameters:

label - A unique label for the RelationType

Returns:

A new or existing RelationType with the provided label.

Throws:

GraphRuntimeException - if the graph is closed

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

putRelationType

RelationType putRelationType(TypeLabel label)

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

Parameters:

label - A unique label for the RelationType

Returns:

A new or existing RelationType with the provided label.

Throws:

GraphRuntimeException - if the graph is closed

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

putRoleType

RoleType putRoleType(String label)

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

Parameters:

label - A unique label 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(TypeLabel label)

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

Parameters:

label - A unique label 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(TypeLabel label)

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

Parameters:

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

Returns:

The Type with the provided label 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 label)

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

Parameters:

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

Returns:

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

Throws:

GraphRuntimeException - if the graph is closed

getRelationType

RelationType getRelationType(String label)

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

Parameters:

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

Returns:

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

Throws:

GraphRuntimeException - if the graph is closed

getResourceType

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

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

Type Parameters:

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

Parameters:

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

Returns:

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

Throws:

GraphRuntimeException - if the graph is closed

getRoleType

RoleType getRoleType(String label)

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

Parameters:

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

Returns:

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

Throws:

GraphRuntimeException - if the graph is closed

getRuleType

RuleType getRuleType(String label)

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

Parameters:

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

Returns:

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

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

isReadOnly

boolean isReadOnly()

Utility function used to check if the current transaction on the graph is a read only transaction

Returns:

true if the current transaction is read only

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

close

void close()

Closes the current transaction. Rendering this graph unusable. You must use the GraknSession to get a new open transaction.

Specified by:

close in interface AutoCloseable

abort

void abort()

Reverts any changes done to the graph and closes the transaction. You must use the GraknSession to get a new open transaction.

commit

void commit()
     throws GraknValidationException

Commits any changes to the graph and closes the transaction. You must use the GraknSession to get a new open transaction.

Throws:

GraknValidationException - when the transaction contains graph mutations which does not conform to the Grakn knowledge model.