org.janusgraph.core.schema

Interface SchemaInspector

All Known Subinterfaces:

JanusGraph, JanusGraphManagement, JanusGraphTransaction, SchemaManager, Transaction

All Known Implementing Classes:

JanusGraphBlueprintsGraph, JanusGraphBlueprintsTransaction, ManagementSystem, StandardJanusGraph, StandardJanusGraphTx

public interface SchemaInspector

Author:

Matthias Broecheler (me@matthiasb.com)

Method Summary

Modifier and Type	Method and Description
boolean	containsEdgeLabel(String name) Checks whether an edge label of the given name has been defined in the JanusGraph schema.
boolean	containsPropertyKey(String name) Checks whether a property key of the given name has been defined in the JanusGraph schema.
boolean	containsRelationType(String name) Checks whether a type with the specified name exists.
boolean	containsVertexLabel(String name) Whether a vertex label with the given name exists in the graph.
EdgeLabel	getEdgeLabel(String name) Returns the edge label with the given name.
EdgeLabel	getOrCreateEdgeLabel(String name) Returns the edge label with the given name.
PropertyKey	getOrCreatePropertyKey(String name) Returns the property key with the given name.
default PropertyKey	getOrCreatePropertyKey(String name, Object value) Returns the property key with the given name.
default PropertyKey	getOrCreatePropertyKey(String name, Object value, org.apache.tinkerpop.gremlin.structure.VertexProperty.Cardinality cardinality) Returns the property key with the given name.
VertexLabel	getOrCreateVertexLabel(String name) Returns the vertex label with the given name.
PropertyKey	getPropertyKey(String name) Returns the property key with the given name.
RelationType	getRelationType(String name) Returns the type with the given name.
VertexLabel	getVertexLabel(String name) Returns the vertex label with the given name.

Method Detail

containsRelationType

boolean containsRelationType(String name)

Checks whether a type with the specified name exists.

Parameters:

name - name of the type

Returns:

true, if a type with the given name exists, else false

getRelationType

RelationType getRelationType(String name)

Returns the type with the given name. Note, that type names must be unique.

Parameters:

name - name of the type to return

Returns:

The type with the given name, or null if such does not exist

See Also:

RelationType

containsPropertyKey

boolean containsPropertyKey(String name)

Checks whether a property key of the given name has been defined in the JanusGraph schema.

Parameters:

name - name of the property key

Returns:

true, if the property key exists, else false

getOrCreatePropertyKey

PropertyKey getOrCreatePropertyKey(String name)

Returns the property key with the given name. If automatic type making is enabled, it will make the property key using the configured default type maker if a key with the given name does not exist.

Parameters:

name - name of the property key to return

Returns:

the property key with the given name

Throws:

IllegalArgumentException - if a property key with the given name does not exist or if the type with the given name is not a property key

See Also:

PropertyKey

getOrCreatePropertyKey

default PropertyKey getOrCreatePropertyKey(String name,
                                           Object value)

Returns the property key with the given name. If automatic type making is enabled, it will make the property key using the configured default type maker if a key with the given name does not exist. The default implementation simply calls the getOrCreatePropertyKey method

Parameters:

name - name of the property key to return

value - the value of the property key. This param is not used by the default implementation

Returns:

the property key with the given name

Throws:

IllegalArgumentException - if a property key with the given name does not exist or if the type with the given name is not a property key

See Also:

PropertyKey

getOrCreatePropertyKey

default PropertyKey getOrCreatePropertyKey(String name,
                                           Object value,
                                           org.apache.tinkerpop.gremlin.structure.VertexProperty.Cardinality cardinality)

Returns the property key with the given name. If automatic type making is enabled, it will make the property key using the configured default type maker if a key with the given name does not exist. If automatic type making is enabled, it will make the property key using the selected cardinality, if a key with the given name does not exist. The default implementation simply calls the getOrCreatePropertyKey method

Parameters:

name - name of the property key to return

value - the value of the property key. This param is not used by the default

cardinality - the cardinality of the property key. This param is not used by the default implementation

Returns:

the property key with the given name

Throws:

IllegalArgumentException - if a property key with the given name does not exist or if the type with the given name is not a property key

See Also:

PropertyKey

getPropertyKey

PropertyKey getPropertyKey(String name)

Returns the property key with the given name. If it does not exist, NULL is returned

Parameters:

name -

Returns:

containsEdgeLabel

boolean containsEdgeLabel(String name)

Checks whether an edge label of the given name has been defined in the JanusGraph schema.

Parameters:

name - name of the edge label

Returns:

true, if the edge label exists, else false

getOrCreateEdgeLabel

EdgeLabel getOrCreateEdgeLabel(String name)

Returns the edge label with the given name. If automatic type making is enabled, it will make the edge label using the configured default type maker if a label with the given name does not exist.

Parameters:

name - name of the edge label to return

Returns:

the edge label with the given name

Throws:

IllegalArgumentException - if an edge label with the given name does not exist or if the type with the given name is not an edge label

See Also:

EdgeLabel

getEdgeLabel

EdgeLabel getEdgeLabel(String name)

Returns the edge label with the given name. If it does not exist, NULL is returned

Parameters:

name -

Returns:

containsVertexLabel

boolean containsVertexLabel(String name)

Whether a vertex label with the given name exists in the graph.

Parameters:

name -

Returns:

getVertexLabel

VertexLabel getVertexLabel(String name)

Returns the vertex label with the given name. If such does not exist, NULL is returned.

Parameters:

name -

Returns:

getOrCreateVertexLabel

VertexLabel getOrCreateVertexLabel(String name)

Returns the vertex label with the given name. If a vertex label with this name does not exist, the label is automatically created through the registered DefaultSchemaMaker.

Attempting to automatically create a vertex label might cause an exception depending on the configuration.

Parameters:

name -

Returns: