ai.grakn.graph.internal

Class AbstractGraknGraph<G extends org.apache.tinkerpop.gremlin.structure.Graph>

java.lang.Object

ai.grakn.graph.internal.AbstractGraknGraph<G>

Type Parameters:

G - A vendor specific implementation of a Tinkerpop Graph.

All Implemented Interfaces:

GraknGraph, GraknAdmin, AutoCloseable

Direct Known Subclasses:

GraknOrientDBGraph, GraknTinkerGraph, GraknTitanGraph

public abstract class AbstractGraknGraph<G extends org.apache.tinkerpop.gremlin.structure.Graph>
extends Object
implements GraknGraph, GraknAdmin

The Grakn Graph Base Implementation

This defines how a grakn graph sits on top of a Tinkerpop Graph. It mostly act as a construction object which ensure the resulting graph conforms to the Grakn Object model.

Author:

fppt

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	LOG

Constructor Summary

Constructors

Constructor and Description
AbstractGraknGraph(G graph, String keyspace, String engine, boolean batchLoadingEnabled)

Method Summary

Modifier and Type	Method and Description
GraknAdmin	admin() Returns access to the low-level details of the graph via GraknAdmin
<T extends Concept> T	buildConcept(org.apache.tinkerpop.gremlin.structure.Vertex vertex)
void	clear() Clears the graph completely.
protected void	clearGraph()
void	close() Closes the current graph, rendering it unusable.
void	closeGraph(String closedReason)
void	closePermanent()
void	commit() Commits the graph
void	commit(java.util.function.BiConsumer<Set<org.javatuples.Pair<String,ConceptId>>,Set<org.javatuples.Pair<String,ConceptId>>> conceptLogger)
void	commit(Map<String,Set<ConceptId>> resourceCache, Map<String,Set<ConceptId>> castingCache) Commits the graph and adds concepts for post processing directly to the cache
void	commitNoLogs() Commits to the graph without submitting any commit logs.
protected void	commitTransaction()
void	finaliseClose(Runnable closer, String closedReason)
boolean	fixDuplicateCastings(String index, Set<ConceptId> castingVertexIds) Merges the provided duplicate castings.
boolean	fixDuplicateResources(String index, Set<ConceptId> resourceVertexIds)
<T extends Concept> T	getConcept(ConceptId id) Get the Concept with identifier provided, if it exists.
<T extends Concept> T	getConcept(Schema.ConceptProperty key, String value)
<T extends Concept> T	getConceptByBaseIdentifier(Object baseIdentifier)
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.
Type	getMetaConcept() Get the root of all Types.
EntityType	getMetaEntityType() Get the root of all the Entity Types.
RelationType	getMetaRelationType() Get the root of all Relation Types.
ResourceType	getMetaResourceType() Get the root of all the Resource Types.
RoleType	getMetaRoleType() Get the root of all the Role Types.
RuleType	getMetaRuleConstraint() Get the root of all constraint rules.
RuleType	getMetaRuleInference() Get the root of all inference rules.
RuleType	getMetaRuleType() Get the root of all Rule Types;
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.
G	getTinkerPopGraph()
org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal<org.apache.tinkerpop.gremlin.structure.Vertex,org.apache.tinkerpop.gremlin.structure.Vertex>	getTinkerTraversal() Utility function to get a read-only Tinkerpop traversal.
<T extends Type> T	getType(TypeName name) Get the Type with the name provided, if it exists.
QueryBuilder	graql() Returns a QueryBuilder
boolean	hasCommitted()
boolean	implicitConceptsVisible() Utility function to specify whether implicit concepts should be exposed.
boolean	initialiseMetaConcepts()
boolean	isBatchLoadingEnabled() A flag to check if batch loading is enabled and consistency checks are switched off
boolean	isClosed() Utility function to determine whether the graph has been closed.
abstract boolean	isConceptModified(ai.grakn.graph.internal.ConceptImpl concept)
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.
boolean	validVertex(org.apache.tinkerpop.gremlin.structure.Vertex vertex)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

protected final org.slf4j.Logger LOG

Constructor Detail

AbstractGraknGraph

public AbstractGraknGraph(G graph,
                          String keyspace,
                          String engine,
                          boolean batchLoadingEnabled)

Method Detail

isConceptModified

public abstract boolean isConceptModified(ai.grakn.graph.internal.ConceptImpl concept)

Parameters:

concept - A concept in the graph

Returns:

True if the concept has been modified in the transaction

getKeyspace

public String getKeyspace()

Description copied from interface: GraknGraph

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

Specified by:

getKeyspace in interface GraknGraph

Returns:

The name of the keyspace where the graph is persisted

isClosed

public boolean isClosed()

Description copied from interface: GraknGraph

Utility function to determine whether the graph has been closed.

Specified by:

isClosed in interface GraknGraph

Returns:

True if the graph has been closed

implicitConceptsVisible

public boolean implicitConceptsVisible()

Description copied from interface: GraknGraph

Utility function to specify whether implicit concepts should be exposed.

Specified by:

implicitConceptsVisible in interface GraknGraph

Returns:

true if implicit concepts are exposed.

showImplicitConcepts

public void showImplicitConcepts(boolean flag)

Description copied from interface: GraknGraph

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

Specified by:

showImplicitConcepts in interface GraknGraph

Parameters:

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

admin

public GraknAdmin admin()

Description copied from interface: GraknGraph

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

Specified by:

admin in interface GraknGraph

Returns:

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

See Also:

GraknAdmin

buildConcept

public <T extends Concept> T buildConcept(org.apache.tinkerpop.gremlin.structure.Vertex vertex)

Specified by:

buildConcept in interface GraknAdmin

Type Parameters:

T - The type of the concept being built

Parameters:

vertex - A vertex which contains properties necessary to build a concept from.

Returns:

A concept built using the provided vertex

hasCommitted

public boolean hasCommitted()

isBatchLoadingEnabled

public boolean isBatchLoadingEnabled()

Description copied from interface: GraknAdmin

A flag to check if batch loading is enabled and consistency checks are switched off

Specified by:

isBatchLoadingEnabled in interface GraknAdmin

Returns:

true if batch loading is enabled

initialiseMetaConcepts

public boolean initialiseMetaConcepts()

getTinkerPopGraph

public G getTinkerPopGraph()

getTinkerTraversal

public org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal<org.apache.tinkerpop.gremlin.structure.Vertex,org.apache.tinkerpop.gremlin.structure.Vertex> getTinkerTraversal()

Description copied from interface: GraknAdmin

Utility function to get a read-only Tinkerpop traversal.

Specified by:

getTinkerTraversal in interface GraknAdmin

Returns:

A read-only Tinkerpop traversal for manually traversing the graph

graql

public QueryBuilder graql()

Description copied from interface: GraknGraph

Returns a QueryBuilder

Specified by:

graql in interface GraknGraph

Returns:

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

See Also:

QueryBuilder

getConcept

public <T extends Concept> T getConcept(Schema.ConceptProperty key,
                                        String value)

Specified by:

getConcept in interface GraknAdmin

Parameters:

key - The concept property tp search by.

value - The value of the concept

Returns:

A concept with the matching key and value

putEntityType

public EntityType putEntityType(String name)

Description copied from interface: GraknGraph

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

Specified by:

putEntityType in interface GraknGraph

Parameters:

name - A unique name for the EntityType

Returns:

A new or existing EntityType with the provided name

putEntityType

public EntityType putEntityType(TypeName name)

Description copied from interface: GraknGraph

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

Specified by:

putEntityType in interface GraknGraph

Parameters:

name - A unique name for the EntityType

Returns:

A new or existing EntityType with the provided name

putRelationType

public RelationType putRelationType(String name)

Description copied from interface: GraknGraph

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

Specified by:

putRelationType in interface GraknGraph

Parameters:

name - A unique name for the RelationType

Returns:

A new or existing RelationType with the provided name.

putRelationType

public RelationType putRelationType(TypeName name)

Description copied from interface: GraknGraph

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

Specified by:

putRelationType in interface GraknGraph

Parameters:

name - A unique name for the RelationType

Returns:

A new or existing RelationType with the provided name.

putRoleType

public RoleType putRoleType(String name)

Description copied from interface: GraknGraph

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

Specified by:

putRoleType in interface GraknGraph

Parameters:

name - A unique name for the RoleType

Returns:

new or existing RoleType with the provided Id.

putRoleType

public RoleType putRoleType(TypeName name)

Description copied from interface: GraknGraph

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

Specified by:

putRoleType in interface GraknGraph

Parameters:

name - A unique name for the RoleType

Returns:

new or existing RoleType with the provided Id.

putResourceType

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

Description copied from interface: GraknGraph

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.

Specified by:

putResourceType in interface GraknGraph

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.

putResourceType

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

Description copied from interface: GraknGraph

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.

Specified by:

putResourceType in interface GraknGraph

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.

putResourceTypeUnique

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

Description copied from interface: GraknGraph

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.

Specified by:

putResourceTypeUnique in interface GraknGraph

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.

putResourceTypeUnique

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

Description copied from interface: GraknGraph

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.

Specified by:

putResourceTypeUnique in interface GraknGraph

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.

putRuleType

public RuleType putRuleType(String name)

Description copied from interface: GraknGraph

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

Specified by:

putRuleType in interface GraknGraph

Parameters:

name - A unique name for the RuleType

Returns:

new or existing RuleType with the provided name.

putRuleType

public RuleType putRuleType(TypeName name)

Description copied from interface: GraknGraph

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

Specified by:

putRuleType in interface GraknGraph

Parameters:

name - A unique name for the RuleType

Returns:

new or existing RuleType with the provided name.

getConceptByBaseIdentifier

public <T extends Concept> T getConceptByBaseIdentifier(Object baseIdentifier)

getConcept

public <T extends Concept> T getConcept(ConceptId id)

Description copied from interface: GraknGraph

Get the Concept with identifier provided, if it exists.

Specified by:

getConcept in interface GraknGraph

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.

getResourcesByValue

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

Description copied from interface: GraknGraph

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

Specified by:

getResourcesByValue in interface GraknGraph

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.

getType

public <T extends Type> T getType(TypeName name)

Description copied from interface: GraknGraph

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

Specified by:

getType in interface GraknGraph

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.

getEntityType

public EntityType getEntityType(String name)

Description copied from interface: GraknGraph

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

Specified by:

getEntityType in interface GraknGraph

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

public RelationType getRelationType(String name)

Description copied from interface: GraknGraph

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

Specified by:

getRelationType in interface GraknGraph

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

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

Description copied from interface: GraknGraph

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

Specified by:

getResourceType in interface GraknGraph

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

public RoleType getRoleType(String name)

Description copied from interface: GraknGraph

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

Specified by:

getRoleType in interface GraknGraph

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

public RuleType getRuleType(String name)

Description copied from interface: GraknGraph

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

Specified by:

getRuleType in interface GraknGraph

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.

getMetaConcept

public Type getMetaConcept()

Description copied from interface: GraknAdmin

Get the root of all Types.

Specified by:

getMetaConcept in interface GraknAdmin

Returns:

The meta type -> type.

getMetaRelationType

public RelationType getMetaRelationType()

Description copied from interface: GraknAdmin

Get the root of all Relation Types.

Specified by:

getMetaRelationType in interface GraknAdmin

Returns:

The meta relation type -> relation-type.

getMetaRoleType

public RoleType getMetaRoleType()

Description copied from interface: GraknAdmin

Get the root of all the Role Types.

Specified by:

getMetaRoleType in interface GraknAdmin

Returns:

The meta role type -> role-type.

getMetaResourceType

public ResourceType getMetaResourceType()

Description copied from interface: GraknAdmin

Get the root of all the Resource Types.

Specified by:

getMetaResourceType in interface GraknAdmin

Returns:

The meta resource type -> resource-type.

getMetaEntityType

public EntityType getMetaEntityType()

Description copied from interface: GraknAdmin

Get the root of all the Entity Types.

Specified by:

getMetaEntityType in interface GraknAdmin

Returns:

The meta entity type -> entity-type.

getMetaRuleType

public RuleType getMetaRuleType()

Description copied from interface: GraknAdmin

Get the root of all Rule Types;

Specified by:

getMetaRuleType in interface GraknAdmin

Returns:

The meta rule type -> rule-type.

getMetaRuleInference

public RuleType getMetaRuleInference()

Description copied from interface: GraknAdmin

Get the root of all inference rules.

Specified by:

getMetaRuleInference in interface GraknAdmin

Returns:

The meta rule -> inference-rule.

getMetaRuleConstraint

public RuleType getMetaRuleConstraint()

Description copied from interface: GraknAdmin

Get the root of all constraint rules.

Specified by:

getMetaRuleConstraint in interface GraknAdmin

Returns:

The meta rule -> constraint-rule.

getRelation

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

Description copied from interface: GraknGraph

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.

Specified by:

getRelation in interface GraknGraph

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.

rollback

public void rollback()

Description copied from interface: GraknGraph

Resets the current transaction without committing.

Specified by:

rollback in interface GraknGraph

clear

public void clear()

Clears the graph completely.

Specified by:

clear in interface GraknGraph

clearGraph

protected void clearGraph()

close

public void close()

Closes the current graph, rendering it unusable.

Specified by:

close in interface GraknGraph

Specified by:

close in interface AutoCloseable

open

public void open()

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

Specified by:

open in interface GraknGraph

closeGraph

public void closeGraph(String closedReason)

finaliseClose

public void finaliseClose(Runnable closer,
                          String closedReason)

closePermanent

public void closePermanent()

commit

public void commit()
            throws GraknValidationException

Commits the graph

Specified by:

commit in interface GraknGraph

Throws:

GraknValidationException - when the graph does not conform to the object concept

commit

public void commit(Map<String,Set<ConceptId>> resourceCache,
                   Map<String,Set<ConceptId>> castingCache)
            throws GraknValidationException

Commits the graph and adds concepts for post processing directly to the cache

Specified by:

commit in interface GraknAdmin

Parameters:

resourceCache - The cache of resource jobs to be executed

castingCache - The cache of the casting jobs to be executed

Throws:

GraknValidationException - when the graph does not conform to the object concept

commitNoLogs

public void commitNoLogs()
                  throws GraknValidationException

Commits to the graph without submitting any commit logs.

Specified by:

commitNoLogs in interface GraknAdmin

Throws:

GraknValidationException - when the graph does not conform to the object concept

commit

public void commit(java.util.function.BiConsumer<Set<org.javatuples.Pair<String,ConceptId>>,Set<org.javatuples.Pair<String,ConceptId>>> conceptLogger)
            throws GraknValidationException

Throws:

GraknValidationException

commitTransaction

protected void commitTransaction()

validVertex

public boolean validVertex(org.apache.tinkerpop.gremlin.structure.Vertex vertex)

Specified by:

validVertex in interface GraknAdmin

Parameters:

vertex - The vertex to be checked against the underlaying graph

Returns:

true if the vertex is still valid and has not been removed

fixDuplicateCastings

public boolean fixDuplicateCastings(String index,
                                    Set<ConceptId> castingVertexIds)

Merges the provided duplicate castings.

Specified by:

fixDuplicateCastings in interface GraknAdmin

Parameters:

castingVertexIds - The vertex Ids of the duplicate castings

Returns:

if castings were merged and a commit is required.

fixDuplicateResources

public boolean fixDuplicateResources(String index,
                                     Set<ConceptId> resourceVertexIds)

Specified by:

fixDuplicateResources in interface GraknAdmin

Parameters:

resourceVertexIds - The resource vertex ids which need to be merged.

Returns:

True if a commit is required.