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:

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
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
<T extends Concept> T	buildConcept(org.apache.tinkerpop.gremlin.structure.Vertex vertex)
void	clear() Clears the graph completely.
void	clear(ConceptCache conceptCache) Clears the graph and empties the provided cache.
protected void	clearGraph()
void	close() Closes the current transaction.
void	commit() Commits any changes to the graph and closes the transaction.
void	commit(java.util.function.BiConsumer<Set<org.javatuples.Pair<String,ConceptId>>,Set<org.javatuples.Pair<String,ConceptId>>> conceptLogger)
void	commit(ConceptCache conceptCache) Commits the graph and adds concepts for post processing directly to the cache bypassing the REST API.
void	commitNoLogs() Commits to the graph without submitting any commit logs.
boolean	fixDuplicateCastings(String index, Set<ConceptId> castingVertexIds) Merges the provided duplicate castings.
boolean	fixDuplicateResources(String index, Set<ConceptId> resourceVertexIds) Merges the provided duplicate resources
<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	getConceptRawId(Object id) Looks up concept by using id against vertex ids.
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.
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;
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.
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(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	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)
abstract boolean	isConnectionClosed()
boolean	isReadOnly() Utility function used to check if the current transaction on the graph is a read only transaction
abstract int	numOpenTx()
void	openTransaction(GraknTxType txType) Opens the thread bound 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.
void	updateTypeCounts(Map<TypeLabel,Long> typeCounts) Updates the counts of all the types
void	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

numOpenTx

public abstract int numOpenTx()

Returns:

The number of open transactions currently.

openTransaction

public void openTransaction(GraknTxType txType)

Opens the thread bound 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

isConnectionClosed

public abstract boolean isConnectionClosed()

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.

isReadOnly

public boolean isReadOnly()

Description copied from interface: GraknGraph

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

Specified by:

isReadOnly in interface GraknGraph

Returns:

true if the current transaction is read only

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

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

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 label)

Description copied from interface: GraknGraph

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

Specified by:

putEntityType in interface GraknGraph

Parameters:

label - A unique label for the EntityType

Returns:

A new or existing EntityType with the provided label

putEntityType

public EntityType putEntityType(TypeLabel label)

Description copied from interface: GraknGraph

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

Specified by:

putEntityType in interface GraknGraph

Parameters:

label - A unique label for the EntityType

Returns:

A new or existing EntityType with the provided label

putRelationType

public RelationType putRelationType(String label)

Description copied from interface: GraknGraph

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

Specified by:

putRelationType in interface GraknGraph

Parameters:

label - A unique label for the RelationType

Returns:

A new or existing RelationType with the provided label.

putRelationType

public RelationType putRelationType(TypeLabel label)

Description copied from interface: GraknGraph

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

Specified by:

putRelationType in interface GraknGraph

Parameters:

label - A unique label for the RelationType

Returns:

A new or existing RelationType with the provided label.

putRoleType

public RoleType putRoleType(String label)

Description copied from interface: GraknGraph

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

Specified by:

putRoleType in interface GraknGraph

Parameters:

label - A unique label for the RoleType

Returns:

new or existing RoleType with the provided Id.

putRoleType

public RoleType putRoleType(TypeLabel label)

Description copied from interface: GraknGraph

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

Specified by:

putRoleType in interface GraknGraph

Parameters:

label - A unique label for the RoleType

Returns:

new or existing RoleType with the provided Id.

putResourceType

public <V> ResourceType<V> putResourceType(String label,
                                           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 label 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:

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.

putResourceType

public <V> ResourceType<V> putResourceType(TypeLabel label,
                                           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 label 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:

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.

putRuleType

public RuleType putRuleType(String label)

Description copied from interface: GraknGraph

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

Specified by:

putRuleType in interface GraknGraph

Parameters:

label - A unique label for the RuleType

Returns:

new or existing RuleType with the provided label.

putRuleType

public RuleType putRuleType(TypeLabel label)

Description copied from interface: GraknGraph

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

Specified by:

putRuleType in interface GraknGraph

Parameters:

label - A unique label for the RuleType

Returns:

new or existing RuleType with the provided label.

getConceptRawId

public <T extends Concept> T getConceptRawId(Object id)

Looks up concept by using id against vertex ids. Does not use the index. This is primarily used to fix duplicates when indicies cannot be relied on.

Parameters:

id - The id of the concept which should match the vertex id

Returns:

The concept if it exists.

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

Description copied from interface: GraknGraph

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

Specified by:

getType in interface GraknGraph

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.

getEntityType

public EntityType getEntityType(String label)

Description copied from interface: GraknGraph

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

Specified by:

getEntityType in interface GraknGraph

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.

getRelationType

public RelationType getRelationType(String label)

Description copied from interface: GraknGraph

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

Specified by:

getRelationType in interface GraknGraph

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.

getResourceType

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

Description copied from interface: GraknGraph

Get the Resource Type with the label 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:

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.

getRoleType

public RoleType getRoleType(String label)

Description copied from interface: GraknGraph

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

Specified by:

getRoleType in interface GraknGraph

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.

getRuleType

public RuleType getRuleType(String label)

Description copied from interface: GraknGraph

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

Specified by:

getRuleType in interface GraknGraph

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.

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.

clear

public void clear()

Clears the graph completely.

Specified by:

clear in interface GraknGraph

clear

public void clear(ConceptCache conceptCache)

Description copied from interface: GraknAdmin

Clears the graph and empties the provided cache.

Specified by:

clear in interface GraknAdmin

Parameters:

conceptCache - The concept Cache to store concepts in for processing later

clearGraph

protected void clearGraph()

close

public void close()

Description copied from interface: GraknGraph

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

Specified by:

close in interface GraknGraph

Specified by:

close in interface AutoCloseable

abort

public void abort()

Description copied from interface: GraknGraph

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

Specified by:

abort in interface GraknGraph

commit

public void commit()
            throws GraknValidationException

Description copied from interface: GraknGraph

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

Specified by:

commit in interface GraknGraph

Throws:

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

commit

public void commit(ConceptCache conceptCache)
            throws GraknValidationException

Commits the graph and adds concepts for post processing directly to the cache bypassing the REST API.

Specified by:

commit in interface GraknAdmin

Parameters:

conceptCache - The concept Cache to store concepts in for processing later

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

validVertex

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

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)

Description copied from interface: GraknAdmin

Merges the provided duplicate resources

Specified by:

fixDuplicateResources in interface GraknAdmin

Parameters:

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

Returns:

True if a commit is required.

updateTypeCounts

public void updateTypeCounts(Map<TypeLabel,Long> typeCounts)

Description copied from interface: GraknAdmin

Updates the counts of all the types

Specified by:

updateTypeCounts in interface GraknAdmin

Parameters:

typeCounts - The types and the changes to put on their counts