org.neo4j.graphdb.schema

Interface ConstraintCreator

All Known Implementing Classes:

BaseConstraintCreator, PropertyConstraintCreator, PropertyUniqueConstraintCreator

public interface ConstraintCreator

A builder for entering details about a constraint to create. After all details have been entered create() must be called for the constraint to actually be created. A constraint creator knows which label it is to be created for. All methods except create() will return an ConstraintCreator which should be used for further interaction.

See Also:

Schema

Method Summary

Methods

Modifier and Type	Method and Description
ConstraintDefinition	create() Creates a constraint with the details specified by the other methods in this interface.
ConstraintCreator	on(String propertyKey) Specifies that this constraint will be for the given property key.
ConstraintCreator	unique() Imposes a uniqueness constraint for the given property, such that there can be at most one node, having the given label, for any set value of that property key.

Method Detail

on

ConstraintCreator on(String propertyKey)

Specifies that this constraint will be for the given property key. Specifying a property key requires further details to be given, such as uniqueness.

Parameters:

propertyKey - the property key this constraint is about.

Returns:

a ConstraintCreator instance to be used for further interaction.

unique

ConstraintCreator unique()

Imposes a uniqueness constraint for the given property, such that there can be at most one node, having the given label, for any set value of that property key.

Returns:

a ConstraintCreator instance to be used for further interaction.

create

ConstraintDefinition create()
                            throws ConstraintViolationException

Creates a constraint with the details specified by the other methods in this interface.

Returns:

the created constraint.

Throws:

ConstraintViolationException - if creating this constraint would violate any existing constraints.