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

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
static String	NORMAL_CACHE_TIMEOUT_MS
static String	SHARDING_THRESHOLD

Constructor Summary

Constructors

Constructor and Description
AbstractGraknGraph(G graph, String keyspace, String engine, Properties properties)

Method Summary

Modifier and Type	Method and Description
void	abort()
GraknAdmin	admin()
<T extends Concept> T	buildConcept(org.apache.tinkerpop.gremlin.structure.Vertex vertex)
protected void	clearGraph()
void	close()
void	closeSession()
void	commit()
Optional<String>	commitNoLogs() Commits to the graph without submitting any commit logs.
TypeId	convertToId(TypeLabel label)
void	delete()
boolean	duplicateCastingsExist(String index, Set<ConceptId> castingVertexIds)
boolean	duplicateResourcesExist(String index, Set<ConceptId> resourceVertexIds) Check if the given index has duplicates to merge
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)
<T extends Concept> T	getConcept(Schema.ConceptProperty key, Object value)
EntityType	getEntityType(String label)
String	getKeyspace()
Type	getMetaConcept()
EntityType	getMetaEntityType()
RelationType	getMetaRelationType()
ResourceType	getMetaResourceType()
RoleType	getMetaRoleType()
RuleType	getMetaRuleConstraint()
RuleType	getMetaRuleInference()
RuleType	getMetaRuleType()
RelationType	getRelationType(String label)
<V> Collection<Resource<V>>	getResourcesByValue(V value)
<V> ResourceType<V>	getResourceType(String label)
RoleType	getRoleType(String label)
RuleType	getRuleType(String label)
G	getTinkerPopGraph()
org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal<org.apache.tinkerpop.gremlin.structure.Vertex,org.apache.tinkerpop.gremlin.structure.Vertex>	getTinkerTraversal()
<T extends Type> T	getType(TypeLabel label)
QueryBuilder	graql()
boolean	implicitConceptsVisible()
boolean	isBatchGraph()
boolean	isClosed()
abstract boolean	isConceptModified(ai.grakn.graph.internal.ConceptImpl concept)
boolean	isReadOnly()
abstract boolean	isSessionClosed()
abstract int	numOpenTx()
void	openTransaction(GraknTxType txType) Opens the thread bound transaction
EntityType	putEntityType(String label)
EntityType	putEntityType(TypeLabel label)
RelationType	putRelationType(String label)
RelationType	putRelationType(TypeLabel label)
<V> ResourceType<V>	putResourceType(String label, ResourceType.DataType<V> dataType)
<V> ResourceType<V>	putResourceType(TypeLabel label, ResourceType.DataType<V> dataType)
RoleType	putRoleType(String label)
RoleType	putRoleType(TypeLabel label)
RuleType	putRuleType(String label)
RuleType	putRuleType(TypeLabel label)
void	shard(ConceptId conceptId)
void	showImplicitConcepts(boolean flag)
void	updateConceptCounts(Map<ConceptId,Long> typeCounts)
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

SHARDING_THRESHOLD

public static final String SHARDING_THRESHOLD

See Also:

Constant Field Values

NORMAL_CACHE_TIMEOUT_MS

public static final String NORMAL_CACHE_TIMEOUT_MS

See Also:

Constant Field Values

Constructor Detail

AbstractGraknGraph

public AbstractGraknGraph(G graph,
                          String keyspace,
                          String engine,
                          Properties properties)

Method Detail

convertToId

public TypeId convertToId(TypeLabel label)

Specified by:

convertToId in interface GraknAdmin

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

Specified by:

getKeyspace in interface GraknGraph

isClosed

public boolean isClosed()

Specified by:

isClosed in interface GraknGraph

isSessionClosed

public abstract boolean isSessionClosed()

implicitConceptsVisible

public boolean implicitConceptsVisible()

Specified by:

implicitConceptsVisible in interface GraknGraph

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface GraknGraph

showImplicitConcepts

public void showImplicitConcepts(boolean flag)

Specified by:

showImplicitConcepts in interface GraknGraph

admin

public GraknAdmin admin()

Specified by:

admin in interface GraknGraph

buildConcept

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

Specified by:

buildConcept in interface GraknAdmin

isBatchGraph

public boolean isBatchGraph()

Specified by:

isBatchGraph in interface GraknAdmin

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

Specified by:

getTinkerTraversal in interface GraknAdmin

graql

public QueryBuilder graql()

Specified by:

graql in interface GraknGraph

getConcept

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

Specified by:

getConcept in interface GraknAdmin

putEntityType

public EntityType putEntityType(String label)

Specified by:

putEntityType in interface GraknGraph

putEntityType

public EntityType putEntityType(TypeLabel label)

Specified by:

putEntityType in interface GraknGraph

putRelationType

public RelationType putRelationType(String label)

Specified by:

putRelationType in interface GraknGraph

putRelationType

public RelationType putRelationType(TypeLabel label)

Specified by:

putRelationType in interface GraknGraph

putRoleType

public RoleType putRoleType(String label)

Specified by:

putRoleType in interface GraknGraph

putRoleType

public RoleType putRoleType(TypeLabel label)

Specified by:

putRoleType in interface GraknGraph

putResourceType

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

Specified by:

putResourceType in interface GraknGraph

putResourceType

public <V> ResourceType<V> putResourceType(TypeLabel label,
                                           ResourceType.DataType<V> dataType)

Specified by:

putResourceType in interface GraknGraph

putRuleType

public RuleType putRuleType(String label)

Specified by:

putRuleType in interface GraknGraph

putRuleType

public RuleType putRuleType(TypeLabel label)

Specified by:

putRuleType in interface GraknGraph

getConcept

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

Specified by:

getConcept in interface GraknGraph

getResourcesByValue

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

Specified by:

getResourcesByValue in interface GraknGraph

getType

public <T extends Type> T getType(TypeLabel label)

Specified by:

getType in interface GraknGraph

getEntityType

public EntityType getEntityType(String label)

Specified by:

getEntityType in interface GraknGraph

getRelationType

public RelationType getRelationType(String label)

Specified by:

getRelationType in interface GraknGraph

getResourceType

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

Specified by:

getResourceType in interface GraknGraph

getRoleType

public RoleType getRoleType(String label)

Specified by:

getRoleType in interface GraknGraph

getRuleType

public RuleType getRuleType(String label)

Specified by:

getRuleType in interface GraknGraph

getMetaConcept

public Type getMetaConcept()

Specified by:

getMetaConcept in interface GraknAdmin

getMetaRelationType

public RelationType getMetaRelationType()

Specified by:

getMetaRelationType in interface GraknAdmin

getMetaRoleType

public RoleType getMetaRoleType()

Specified by:

getMetaRoleType in interface GraknAdmin

getMetaResourceType

public ResourceType getMetaResourceType()

Specified by:

getMetaResourceType in interface GraknAdmin

getMetaEntityType

public EntityType getMetaEntityType()

Specified by:

getMetaEntityType in interface GraknAdmin

getMetaRuleType

public RuleType getMetaRuleType()

Specified by:

getMetaRuleType in interface GraknAdmin

getMetaRuleInference

public RuleType getMetaRuleInference()

Specified by:

getMetaRuleInference in interface GraknAdmin

getMetaRuleConstraint

public RuleType getMetaRuleConstraint()

Specified by:

getMetaRuleConstraint in interface GraknAdmin

delete

public void delete()

Specified by:

delete in interface GraknAdmin

clearGraph

protected void clearGraph()

closeSession

public void closeSession()

Specified by:

closeSession in interface GraknAdmin

close

public void close()

Specified by:

close in interface GraknGraph

Specified by:

close in interface AutoCloseable

abort

public void abort()

Specified by:

abort in interface GraknGraph

commit

public void commit()
            throws InvalidGraphException

Specified by:

commit in interface GraknGraph

Throws:

InvalidGraphException

commitNoLogs

public Optional<String> commitNoLogs()
                              throws InvalidGraphException

Commits to the graph without submitting any commit logs.

Specified by:

commitNoLogs in interface GraknAdmin

Throws:

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

validVertex

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

duplicateCastingsExist

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

Specified by:

duplicateCastingsExist in interface GraknAdmin

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, a commit is required and the casting index exists

duplicateResourcesExist

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

Check if the given index has duplicates to merge

Specified by:

duplicateResourcesExist in interface GraknAdmin

Parameters:

index - Index of the potentially duplicated resource

resourceVertexIds - Set of vertex ids containing potential duplicates

Returns:

true if there are duplicate resources amongst the given set and PostProcessing should proceed

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.

updateConceptCounts

public void updateConceptCounts(Map<ConceptId,Long> typeCounts)

Specified by:

updateConceptCounts in interface GraknAdmin

shard

public void shard(ConceptId conceptId)

Specified by:

shard in interface GraknAdmin