org.janusgraph.core.schema

Interface DefaultSchemaMaker

All Known Implementing Classes:

DisableDefaultSchemaMaker, IgnorePropertySchemaMaker, JanusGraphDefaultSchemaMaker, Tp3DefaultSchemaMaker

public interface DefaultSchemaMaker

When a graph is configured to automatically create vertex/edge labels and property keys when they are first used, a DefaultTypeMaker implementation is used to define them by invoking the makeVertexLabel(VertexLabelMaker), makeEdgeLabel(EdgeLabelMaker), or makePropertyKey(PropertyKeyMaker) methods respectively.
By providing a custom DefaultTypeMaker implementation, one can specify how these types should be defined by default. A DefaultTypeMaker implementation is specified in the graph configuration using the full path which means the implementation must be on the classpath.

Author:

Matthias Bröcheler (http://www.matthiasb.com)

See Also:

RelationTypeMaker

Method Summary

Modifier and Type	Method and Description
Cardinality	defaultPropertyCardinality(String key)
default void	enableLogging(Boolean enabled) Enable/Disable logging in schema maker
boolean	ignoreUndefinedQueryTypes() Whether to ignore undefined types occurring in a query.
default void	makeConnectionConstraint(EdgeLabel edgeLabel, VertexLabel outVLabel, VertexLabel inVLabel, SchemaManager manager) Add a constraint on which vertices the given edge label can connect using the schema manager.
default EdgeLabel	makeEdgeLabel(EdgeLabelMaker factory) Creates a new edge label with default settings against the provided EdgeLabelMaker.
default void	makePropertyConstraintForEdge(EdgeLabel edgeLabel, PropertyKey key, SchemaManager manager) Add property constraints for a given edge label using the schema manager.
default void	makePropertyConstraintForVertex(VertexLabel vertexLabel, PropertyKey key, SchemaManager manager) Add property constraints for a given vertex label using the schema manager.
default PropertyKey	makePropertyKey(PropertyKeyMaker factory) Creates a new property key with default settings against the provided PropertyKeyMaker.
default PropertyKey	makePropertyKey(PropertyKeyMaker factory, Object value) Creates a new property key with default settings against the provided PropertyKeyMaker and value.
default VertexLabel	makeVertexLabel(VertexLabelMaker factory) Creates a new vertex label with the default settings against the provided VertexLabelMaker.

Method Detail

enableLogging

default void enableLogging(Boolean enabled)

Enable/Disable logging in schema maker

Parameters:

enabled -

makeEdgeLabel

default EdgeLabel makeEdgeLabel(EdgeLabelMaker factory)

Creates a new edge label with default settings against the provided EdgeLabelMaker.

Parameters:

factory - EdgeLabelMaker through which the edge label is created

Returns:

A new edge label

Throws:

IllegalArgumentException - if the name is already in use or if other configured values are invalid.

defaultPropertyCardinality

Cardinality defaultPropertyCardinality(String key)

Returns:

the default cardinality of a property if created for the given key

makePropertyKey

default PropertyKey makePropertyKey(PropertyKeyMaker factory)

Creates a new property key with default settings against the provided PropertyKeyMaker.

Parameters:

factory - PropertyKeyMaker through which the property key is created

Returns:

A new property key

Throws:

IllegalArgumentException - if the name is already in use or if other configured values are invalid.

makePropertyKey

default PropertyKey makePropertyKey(PropertyKeyMaker factory,
                                    Object value)

Creates a new property key with default settings against the provided PropertyKeyMaker and value.

Parameters:

factory - PropertyKeyMaker through which the property key is created

value - the value of the property. The default implementation does not use this parameter.

Returns:

A new property key

Throws:

IllegalArgumentException - if the name is already in use or if other configured values are invalid.

makeVertexLabel

default VertexLabel makeVertexLabel(VertexLabelMaker factory)

Creates a new vertex label with the default settings against the provided VertexLabelMaker.

Parameters:

factory - VertexLabelMaker through which the vertex label is created

Returns:

A new vertex label

Throws:

IllegalArgumentException - if the name is already in use or if other configured values are invalid.

ignoreUndefinedQueryTypes

boolean ignoreUndefinedQueryTypes()

Whether to ignore undefined types occurring in a query.

If this method returns true, then undefined types referred to in a JanusGraphVertexQuery will be silently ignored and an empty result set will be returned. If this method returns false, then usage of undefined types in queries results in an IllegalArgumentException.

makePropertyConstraintForVertex

default void makePropertyConstraintForVertex(VertexLabel vertexLabel,
                                             PropertyKey key,
                                             SchemaManager manager)

Add property constraints for a given vertex label using the schema manager.

Parameters:

vertexLabel - to which the constraint applies.

key - defines the property which should be added to the vertex label as a constraint.

manager - is used to update the schema.

See Also:

SchemaManager

makePropertyConstraintForEdge

default void makePropertyConstraintForEdge(EdgeLabel edgeLabel,
                                           PropertyKey key,
                                           SchemaManager manager)

Add property constraints for a given edge label using the schema manager.

Parameters:

edgeLabel - to which the constraint applies.

key - defines the property which should be added to the edge label as a constraint.

manager - is used to update the schema.

See Also:

SchemaManager

makeConnectionConstraint

default void makeConnectionConstraint(EdgeLabel edgeLabel,
                                      VertexLabel outVLabel,
                                      VertexLabel inVLabel,
                                      SchemaManager manager)

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

Parameters:

edgeLabel - to which the constraint applies.

outVLabel - specifies the outgoing vertex for this connection.

inVLabel - specifies the incoming vertex for this connection.

manager - is used to update the schema.

See Also:

SchemaManager