ai.grakn.kb.internal.concept

Class ElementFactory

java.lang.Object

ai.grakn.kb.internal.concept.ElementFactory

public final class ElementFactory
extends Object

Constructs Concepts And Edges

This class turns Tinkerpop Vertex and Edge into Grakn Concept and EdgeElement. Construction is only successful if the vertex and edge properties contain the needed information. A concept must include a label which is a Schema.BaseType. An edge must include a label which is a Schema.EdgeLabel.

Author:

fppt

Constructor Summary

Constructors

Constructor and Description
ElementFactory(GraknTxAbstract tx)

Method Summary

Modifier and Type	Method and Description
VertexElement	addVertexElement(Schema.BaseType baseType, ConceptId... conceptIds) Creates a new VertexElement with a ConceptId which can optionally be set.
Casting	buildCasting(EdgeElement edge)
<X extends Concept> Optional<X>	buildConcept(org.apache.tinkerpop.gremlin.structure.Edge edge) Constructors are called directly because this is only called when reading a known Edge or Concept.
<X extends Concept> Optional<X>	buildConcept(EdgeElement edgeElement)
<X extends Concept> Optional<X>	buildConcept(org.apache.tinkerpop.gremlin.structure.Vertex vertex) Constructors are called directly because this is only called when reading a known vertex or concept.
<X extends Concept> Optional<X>	buildConcept(VertexElement vertexElement)
EdgeElement	buildEdgeElement(org.apache.tinkerpop.gremlin.structure.Edge edge)
EntityTypeImpl	buildEntityType(VertexElement vertex, EntityType type)
RelationshipImpl	buildRelation(EdgeElement edge, RelationshipType type, Role owner, Role value)
RelationshipTypeImpl	buildRelationType(VertexElement vertex, RelationshipType type, Boolean isImplicit)
<V> AttributeTypeImpl<V>	buildResourceType(VertexElement vertex, AttributeType<V> type, AttributeType.DataType<V> dataType)
RoleImpl	buildRole(VertexElement vertex, Role type, Boolean isImplicit)
RuleImpl	buildRule(VertexElement vertex, Rule type, Pattern when, Pattern then)
Optional<VertexElement>	buildVertexElement(org.apache.tinkerpop.gremlin.structure.Vertex vertex) Builds a VertexElement from an already existing Vertex.

Methods inherited from class java.lang.Object

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

Constructor Detail

ElementFactory

public ElementFactory(GraknTxAbstract tx)

Method Detail

buildResourceType

public <V> AttributeTypeImpl<V> buildResourceType(VertexElement vertex,
                                                  AttributeType<V> type,
                                                  AttributeType.DataType<V> dataType)

buildRelationType

public RelationshipTypeImpl buildRelationType(VertexElement vertex,
                                              RelationshipType type,
                                              Boolean isImplicit)

buildRelation

public RelationshipImpl buildRelation(EdgeElement edge,
                                      RelationshipType type,
                                      Role owner,
                                      Role value)

buildEntityType

public EntityTypeImpl buildEntityType(VertexElement vertex,
                                      EntityType type)

buildRule

public RuleImpl buildRule(VertexElement vertex,
                          Rule type,
                          Pattern when,
                          Pattern then)

buildRole

public RoleImpl buildRole(VertexElement vertex,
                          Role type,
                          Boolean isImplicit)

buildConcept

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

Constructors are called directly because this is only called when reading a known vertex or concept. Thus tracking the concept can be skipped.

Parameters:

vertex - A vertex of an unknown type

Returns:

A concept built to the correct type

buildConcept

public <X extends Concept> Optional<X> buildConcept(VertexElement vertexElement)

buildConcept

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

Constructors are called directly because this is only called when reading a known Edge or Concept. Thus tracking the concept can be skipped.

Parameters:

edge - A Edge of an unknown type

Returns:

A concept built to the correct type

buildConcept

public <X extends Concept> Optional<X> buildConcept(EdgeElement edgeElement)

buildEdgeElement

public EdgeElement buildEdgeElement(org.apache.tinkerpop.gremlin.structure.Edge edge)

buildCasting

public Casting buildCasting(EdgeElement edge)

buildVertexElement

public Optional<VertexElement> buildVertexElement(org.apache.tinkerpop.gremlin.structure.Vertex vertex)

Builds a VertexElement from an already existing Vertex. An empty optional is returned if the passed in vertex is not valid. A vertex is not valid if it is null or has been deleted

Parameters:

vertex - A vertex which can possibly be turned into a VertexElement

Returns:

A VertexElement of

addVertexElement

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

Creates a new VertexElement with a ConceptId which can optionally be set.

Parameters:

baseType - The Schema.BaseType

conceptIds - the optional ConceptId to set as the new ConceptId

Returns:

a new VertexElement