org.janusgraph.core.schema

Interface SchemaManager

All Superinterfaces:

SchemaInspector

All Known Subinterfaces:

JanusGraph, JanusGraphManagement, JanusGraphTransaction, Transaction

All Known Implementing Classes:

JanusGraphBlueprintsGraph, JanusGraphBlueprintsTransaction, ManagementSystem, StandardJanusGraph, StandardJanusGraphTx

public interface SchemaManager
extends SchemaInspector

Author:

Matthias Broecheler (me@matthiasb.com)

Method Summary

Modifier and Type	Method and Description
EdgeLabel	addConnection(EdgeLabel edgeLabel, VertexLabel outVLabel, VertexLabel inVLabel) Add a constraint on which vertices the given edge label can connect.
EdgeLabel	addProperties(EdgeLabel edgeLabel, PropertyKey... keys) Add property constraints for a given edge label.
VertexLabel	addProperties(VertexLabel vertexLabel, PropertyKey... keys) Add property constraints for a given vertex label.
EdgeLabelMaker	makeEdgeLabel(String name) Returns a EdgeLabelMaker instance to define a new EdgeLabel with the given name.
PropertyKeyMaker	makePropertyKey(String name) Returns a PropertyKeyMaker instance to define a new PropertyKey with the given name.
VertexLabelMaker	makeVertexLabel(String name) Returns a VertexLabelMaker to define a new vertex label with the given name.

Methods inherited from interface org.janusgraph.core.schema.SchemaInspector

containsEdgeLabel, containsPropertyKey, containsRelationType, containsVertexLabel, getEdgeLabel, getOrCreateEdgeLabel, getOrCreatePropertyKey, getOrCreatePropertyKey, getOrCreatePropertyKey, getOrCreateVertexLabel, getPropertyKey, getRelationType, getVertexLabel

Method Detail

makePropertyKey

PropertyKeyMaker makePropertyKey(String name)

Returns a PropertyKeyMaker instance to define a new PropertyKey with the given name. By defining types explicitly (rather than implicitly through usage) one can control various aspects of the key and associated consistency constraints.

The key constructed with this maker will be created in the context of this transaction.

Returns:

a PropertyKeyMaker linked to this transaction.

See Also:

PropertyKeyMaker, PropertyKey

makeEdgeLabel

EdgeLabelMaker makeEdgeLabel(String name)

Returns a EdgeLabelMaker instance to define a new EdgeLabel with the given name. By defining types explicitly (rather than implicitly through usage) one can control various aspects of the label and associated consistency constraints.

The label constructed with this maker will be created in the context of this transaction.

Returns:

a EdgeLabelMaker linked to this transaction.

See Also:

EdgeLabelMaker, EdgeLabel

makeVertexLabel

VertexLabelMaker makeVertexLabel(String name)

Returns a VertexLabelMaker to define a new vertex label with the given name. Note, that the name must be unique.

Parameters:

name -

Returns:

addProperties

VertexLabel addProperties(VertexLabel vertexLabel,
                          PropertyKey... keys)

Add property constraints for a given vertex label.

Parameters:

vertexLabel - to which the constraints applies.

keys - defines the properties which should be added to the VertexLabel as constraints.

Returns:

a VertexLabel edited which contains the added constraints.

addProperties

EdgeLabel addProperties(EdgeLabel edgeLabel,
                        PropertyKey... keys)

Add property constraints for a given edge label.

Parameters:

edgeLabel - to which the constraints applies.

keys - defines the properties which should be added to the EdgeLabel as constraints.

Returns:

a EdgeLabel edited which contains the added constraints.

addConnection

EdgeLabel addConnection(EdgeLabel edgeLabel,
                        VertexLabel outVLabel,
                        VertexLabel inVLabel)

Add a constraint on which vertices the given edge label can connect.

Parameters:

edgeLabel - to which the constraint applies.

outVLabel - specifies the outgoing vertex for this connection.

inVLabel - specifies the incoming vertex for this connection.

Returns:

a EdgeLabel edited which contains the added constraint.