org.springframework.data.mongodb.core.schema

Interface MongoJsonSchema

public interface MongoJsonSchema

Interface defining MongoDB-specific JSON schema object. New objects can be built with builder(), for example:

 MongoJsonSchema schema = MongoJsonSchema.builder().required("firstname", "lastname")
                .properties(string("firstname").possibleValues("luke", "han"),
                                object("address").properties(string("postCode").minLength(4).maxLength(5))

                ).build();
 

resulting in the following schema:

  {
  "type": "object",
  "required": [ "firstname", "lastname" ],
  "properties": {
    "firstname": {
      "type": "string", "enum": [ "luke", "han" ],
    },
    "address": {
      "type": "object",
      "properties": {
        "postCode": { "type": "string", "minLength": 4, "maxLength": 5 }
      }
    }
  }
}
 

Since:

2.1

Author:

Christoph Strobl, Mark Paluch

See Also:

UntypedJsonSchemaObject, TypedJsonSchemaObject

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	MongoJsonSchema.ConflictResolutionFunction A resolution function that is called on conflicting paths when trying to merge properties with different values into a single value.
static class	MongoJsonSchema.MongoJsonSchemaBuilder MongoJsonSchema.MongoJsonSchemaBuilder provides a fluent API for defining a MongoJsonSchema.

Method Summary

Modifier and Type	Method and Description
static MongoJsonSchema.MongoJsonSchemaBuilder	builder() Obtain a new MongoJsonSchema.MongoJsonSchemaBuilder to fluently define the schema.
static MongoJsonSchema	merge(MongoJsonSchema... sources) Create a new MongoJsonSchema merging properties from the given sources.
static MongoJsonSchema	merge(MongoJsonSchema.ConflictResolutionFunction mergeFunction, MongoJsonSchema... sources) Create a new MongoJsonSchema merging properties from the given sources.
default MongoJsonSchema	mergeWith(Collection<MongoJsonSchema> sources) Create a new MongoJsonSchema merging properties from the given sources.
default MongoJsonSchema	mergeWith(Collection<MongoJsonSchema> sources, MongoJsonSchema.ConflictResolutionFunction conflictResolutionFunction) Create a new MongoJsonSchema merging properties from the given sources.
default MongoJsonSchema	mergeWith(MongoJsonSchema... sources) Create a new MongoJsonSchema merging properties from the given sources.
static MongoJsonSchema	of(org.bson.Document document) Create a new MongoJsonSchema for a given root Document containing the schema definition.
static MongoJsonSchema	of(JsonSchemaObject root) Create a new MongoJsonSchema for a given root object.
org.bson.Document	schemaDocument() Create the Document defining the schema.
default org.bson.Document	toDocument() Create the $jsonSchema Document containing the specified schemaDocument().

Method Detail

toDocument

default org.bson.Document toDocument()

Create the $jsonSchema Document containing the specified schemaDocument().
Property and field names need to be mapped to the domain type ones by running the Document through a JsonSchemaMapper to apply field name customization.

Returns:

never null.

schemaDocument

org.bson.Document schemaDocument()

Create the Document defining the schema.
Property and field names need to be mapped to the domain type property by running the Document through a JsonSchemaMapper to apply field name customization.

Returns:

never null.

Since:

3.3

of

static MongoJsonSchema of(JsonSchemaObject root)

Create a new MongoJsonSchema for a given root object.

Parameters:

root - must not be null.

Returns:

new instance of MongoJsonSchema.

of

static MongoJsonSchema of(org.bson.Document document)

Create a new MongoJsonSchema for a given root Document containing the schema definition.

Parameters:

document - must not be null.

Returns:

new instance of MongoJsonSchema.

merge

static MongoJsonSchema merge(MongoJsonSchema... sources)

Create a new MongoJsonSchema merging properties from the given sources.

Parameters:

sources - must not be null.

Returns:

new instance of MongoJsonSchema.

Since:

3.4

merge

static MongoJsonSchema merge(MongoJsonSchema.ConflictResolutionFunction mergeFunction,
                             MongoJsonSchema... sources)

Create a new MongoJsonSchema merging properties from the given sources.

Parameters:

sources - must not be null.

Returns:

new instance of MongoJsonSchema.

Since:

3.4

mergeWith

default MongoJsonSchema mergeWith(MongoJsonSchema... sources)

Create a new MongoJsonSchema merging properties from the given sources.

Parameters:

sources - must not be null.

Returns:

new instance of MongoJsonSchema.

Since:

3.4

mergeWith

default MongoJsonSchema mergeWith(Collection<MongoJsonSchema> sources)

Create a new MongoJsonSchema merging properties from the given sources.

Parameters:

sources - must not be null.

Returns:

new instance of MongoJsonSchema.

Since:

3.4

mergeWith

default MongoJsonSchema mergeWith(Collection<MongoJsonSchema> sources,
                                  MongoJsonSchema.ConflictResolutionFunction conflictResolutionFunction)

Create a new MongoJsonSchema merging properties from the given sources.

Parameters:

sources - must not be null.

Returns:

new instance of MongoJsonSchema.

Since:

3.4

builder

static MongoJsonSchema.MongoJsonSchemaBuilder builder()

Obtain a new MongoJsonSchema.MongoJsonSchemaBuilder to fluently define the schema.

Returns:

new instance of MongoJsonSchema.MongoJsonSchemaBuilder.