ai.grakn.kb.internal

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

java.lang.Object

ai.grakn.kb.internal.GraknTxAbstract<G>

Type Parameters:

G - A vendor specific implementation of a Tinkerpop Graph.

All Implemented Interfaces:

GraknTx, GraknAdmin, AutoCloseable

Direct Known Subclasses:

GraknTxTinker

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

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

Constructor Summary

Constructors

Constructor and Description
GraknTxAbstract(G graph, Keyspace keyspace, String engineUri, Properties properties)

Method Summary

Modifier and Type	Method and Description
void	abort()
VertexElement	addVertexElement(Schema.BaseType baseType, ConceptId... conceptIds)
GraknAdmin	admin()
<T extends Concept> Optional<T>	buildConcept(org.apache.tinkerpop.gremlin.structure.Edge edge)
<T extends Concept> Optional<T>	buildConcept(org.apache.tinkerpop.gremlin.structure.Vertex vertex)
void	checkMutationAllowed()
void	checkSchemaMutationAllowed()
protected void	clearGraph()
void	close()
void	closeSession()
void	commit()
CommitLog	commitLog()
Optional<String>	commitNoLogs()
LabelId	convertToId(Label label)
void	delete()
boolean	duplicateResourcesExist(String index, Set<ConceptId> resourceVertexIds) Check if the given index has duplicates to merge
ElementFactory	factory()
boolean	fixDuplicateResources(String index, Set<ConceptId> resourceVertexIds)
<V> Collection<Attribute<V>>	getAttributesByValue(V value)
<V> AttributeType<V>	getAttributeType(String label)
<T extends Concept> T	getConcept(ConceptId id)
<T extends Concept> Optional<T>	getConcept(Schema.VertexProperty key, Object value)
String	getEngineUrl()
EntityType	getEntityType(String label)
Keyspace	getKeyspace()
Type	getMetaConcept()
EntityType	getMetaEntityType()
RelationshipType	getMetaRelationType()
AttributeType	getMetaResourceType()
Role	getMetaRole()
Rule	getMetaRule()
RelationshipType	getRelationshipType(String label)
Role	getRole(String label)
Rule	getRule(String label)
<T extends SchemaConcept> T	getSchemaConcept(Label label)
<T extends SchemaConcept> T	getSchemaConcept(LabelId id)
G	getTinkerPopGraph()
org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource	getTinkerTraversal()
<T extends Type> T	getType(Label label)
QueryBuilder	graql()
boolean	isBatchTx()
boolean	isClosed()
abstract boolean	isConceptModified(Concept concept)
boolean	isReadOnly()
abstract boolean	isSessionClosed()
abstract int	numOpenTx()
void	openTransaction(GraknTxType txType) Opens the thread bound transaction
<V> AttributeType<V>	putAttributeType(Label label, AttributeType.DataType<V> dataType)
<V> AttributeType<V>	putAttributeType(String label, AttributeType.DataType<V> dataType)
EntityType	putEntityType(Label label)
EntityType	putEntityType(String label)
RelationshipType	putRelationshipType(Label label)
RelationshipType	putRelationshipType(String label)
RelationshipType	putRelationTypeImplicit(Label label)
Role	putRole(Label label)
Role	putRole(String label)
Role	putRoleTypeImplicit(Label label)
Rule	putRule(Label label, Pattern when, Pattern then)
Rule	putRule(String label, Pattern when, Pattern then)
void	putShortcutEdge(Thing toThing, RelationshipReified fromRelation, Role roleType)
void	shard(ConceptId conceptId)
TxCache	txCache()
void	updateConceptCounts(Map<ConceptId,Long> typeCounts)
boolean	validElement(org.apache.tinkerpop.gremlin.structure.Element element)

Methods inherited from class java.lang.Object

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

Field Detail

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

GraknTxAbstract

public GraknTxAbstract(G graph,
                       Keyspace keyspace,
                       String engineUri,
                       Properties properties)

Method Detail

convertToId

public LabelId convertToId(Label label)

Specified by:

convertToId in interface GraknAdmin

isConceptModified

public abstract boolean isConceptModified(Concept 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

commitLog

public CommitLog commitLog()

getEngineUrl

public String getEngineUrl()

Specified by:

getEngineUrl in interface GraknAdmin

getKeyspace

public Keyspace getKeyspace()

Specified by:

getKeyspace in interface GraknTx

txCache

public TxCache txCache()

isClosed

public boolean isClosed()

Specified by:

isClosed in interface GraknTx

isSessionClosed

public abstract boolean isSessionClosed()

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface GraknTx

admin

public GraknAdmin admin()

Specified by:

admin in interface GraknTx

buildConcept

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

Specified by:

buildConcept in interface GraknAdmin

buildConcept

public <T extends Concept> Optional<T> buildConcept(org.apache.tinkerpop.gremlin.structure.Edge edge)

Specified by:

buildConcept in interface GraknAdmin

isBatchTx

public boolean isBatchTx()

Specified by:

isBatchTx in interface GraknAdmin

getTinkerPopGraph

public G getTinkerPopGraph()

getTinkerTraversal

public org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource getTinkerTraversal()

Specified by:

getTinkerTraversal in interface GraknAdmin

graql

public QueryBuilder graql()

Specified by:

graql in interface GraknTx

factory

public ElementFactory factory()

getConcept

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

Specified by:

getConcept in interface GraknAdmin

checkSchemaMutationAllowed

public void checkSchemaMutationAllowed()

checkMutationAllowed

public void checkMutationAllowed()

addVertexElement

public VertexElement addVertexElement(Schema.BaseType baseType,
                                      ConceptId... conceptIds)

putEntityType

public EntityType putEntityType(String label)

Specified by:

putEntityType in interface GraknTx

putEntityType

public EntityType putEntityType(Label label)

Specified by:

putEntityType in interface GraknTx

putRelationshipType

public RelationshipType putRelationshipType(String label)

Specified by:

putRelationshipType in interface GraknTx

putRelationshipType

public RelationshipType putRelationshipType(Label label)

Specified by:

putRelationshipType in interface GraknTx

putRelationTypeImplicit

public RelationshipType putRelationTypeImplicit(Label label)

putRole

public Role putRole(String label)

Specified by:

putRole in interface GraknTx

putRole

public Role putRole(Label label)

Specified by:

putRole in interface GraknTx

putRoleTypeImplicit

public Role putRoleTypeImplicit(Label label)

putAttributeType

public <V> AttributeType<V> putAttributeType(String label,
                                             AttributeType.DataType<V> dataType)

Specified by:

putAttributeType in interface GraknTx

putAttributeType

public <V> AttributeType<V> putAttributeType(Label label,
                                             AttributeType.DataType<V> dataType)

Specified by:

putAttributeType in interface GraknTx

putRule

public Rule putRule(String label,
                    Pattern when,
                    Pattern then)

Specified by:

putRule in interface GraknTx

putRule

public Rule putRule(Label label,
                    Pattern when,
                    Pattern then)

Specified by:

putRule in interface GraknTx

getConcept

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

Specified by:

getConcept in interface GraknTx

getSchemaConcept

@Nullable
public <T extends SchemaConcept> T getSchemaConcept(LabelId id)

getAttributesByValue

public <V> Collection<Attribute<V>> getAttributesByValue(V value)

Specified by:

getAttributesByValue in interface GraknTx

getSchemaConcept

public <T extends SchemaConcept> T getSchemaConcept(Label label)

Specified by:

getSchemaConcept in interface GraknTx

getType

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

Specified by:

getType in interface GraknTx

getEntityType

public EntityType getEntityType(String label)

Specified by:

getEntityType in interface GraknTx

getRelationshipType

public RelationshipType getRelationshipType(String label)

Specified by:

getRelationshipType in interface GraknTx

getAttributeType

public <V> AttributeType<V> getAttributeType(String label)

Specified by:

getAttributeType in interface GraknTx

getRole

public Role getRole(String label)

Specified by:

getRole in interface GraknTx

getRule

public Rule getRule(String label)

Specified by:

getRule in interface GraknTx

getMetaConcept

public Type getMetaConcept()

Specified by:

getMetaConcept in interface GraknAdmin

getMetaRelationType

public RelationshipType getMetaRelationType()

Specified by:

getMetaRelationType in interface GraknAdmin

getMetaRole

public Role getMetaRole()

Specified by:

getMetaRole in interface GraknAdmin

getMetaResourceType

public AttributeType getMetaResourceType()

Specified by:

getMetaResourceType in interface GraknAdmin

getMetaEntityType

public EntityType getMetaEntityType()

Specified by:

getMetaEntityType in interface GraknAdmin

getMetaRule

public Rule getMetaRule()

Specified by:

getMetaRule in interface GraknAdmin

putShortcutEdge

public void putShortcutEdge(Thing toThing,
                            RelationshipReified fromRelation,
                            Role roleType)

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 GraknTx

Specified by:

close in interface AutoCloseable

abort

public void abort()

Specified by:

abort in interface GraknTx

commit

public void commit()
            throws InvalidKBException

Specified by:

commit in interface GraknTx

Throws:

InvalidKBException

commitNoLogs

public Optional<String> commitNoLogs()
                              throws InvalidKBException

Specified by:

commitNoLogs in interface GraknAdmin

Throws:

InvalidKBException

validElement

public boolean validElement(org.apache.tinkerpop.gremlin.structure.Element element)

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