Package org.springframework.data.mongodb.core

Interface MongoJsonSchemaCreator

public interface MongoJsonSchemaCreator

MongoJsonSchemaCreator extracts the MongoJsonSchema for a given Class by applying the following mapping rules.

Required Properties

• Properties of primitive type

Ignored Properties

• All properties annotated with Transient

Property Type Mapping

• Object -> type : 'object'
• Arrays -> type : 'array'
• Collection -> type : 'array'
• Map -> type : 'object'
• Enum -> type : 'string', enum : [the enum values]
• Simple Types -> type : 'the corresponding bson type'
• Domain Types -> type : 'object', properties : {the types properties}

_id properties using types that can be converted into ObjectId like String will be mapped to type : 'object' unless there is more specific information available via the MongoId annotation. Encrypted properties will contain encrypt information.

Since:

2.2

Author:

Christoph Strobl

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	MongoJsonSchemaCreator.JsonSchemaPropertyContext	The context in which a specific MongoJsonSchemaCreator.JsonSchemaPropertyContext.getProperty() is encountered during schema creation.
static interface	MongoJsonSchemaCreator.PropertySpecifier

Method Summary

Modifier and Type	Method	Description
static MongoJsonSchemaCreator	create()	Creates a new MongoJsonSchemaCreator that does not consider potential extensions - suitable for testing.
static MongoJsonSchemaCreator	create(MappingContext mappingContext)	Creates a new MongoJsonSchemaCreator that is aware of type mappings and potential extensions.
static MongoJsonSchemaCreator	create(MongoConverter mongoConverter)	Creates a new MongoJsonSchemaCreator that is aware of conversions applied by the given MongoConverter.
MongoJsonSchema	createSchemaFor(Class<?> type)	Create the MongoJsonSchema for the given type.
static Predicate<MongoJsonSchemaCreator.JsonSchemaPropertyContext>	encryptedOnly()	A filter Predicate that matches encrypted properties and those having nested ones.
MongoJsonSchemaCreator	filter(Predicate<MongoJsonSchemaCreator.JsonSchemaPropertyContext> filter)	Filter matching properties.
default MongoJsonSchema	mergedSchemaFor(Class<?>... types)	Create a merged MongoJsonSchema out of the individual schemas of the given types by merging their properties into one large schema.
MongoJsonSchemaCreator.PropertySpecifier	property(String path)	Entry point to specify additional behavior for a given path.

Method Details

createSchemaFor

MongoJsonSchema createSchemaFor(Class<?> type)

Create the MongoJsonSchema for the given type.

Parameters:

type - must not be null.

Returns:

never null.

mergedSchemaFor

default MongoJsonSchema mergedSchemaFor(Class<?>... types)

Create a merged MongoJsonSchema out of the individual schemas of the given types by merging their properties into one large schema.

Parameters:

types - must not be null nor contain null.

Returns:

new instance of MongoJsonSchema.

Since:

3.4

filter

MongoJsonSchemaCreator filter(Predicate<MongoJsonSchemaCreator.JsonSchemaPropertyContext> filter)

Filter matching properties.

Parameters:

filter - the Predicate to evaluate for inclusion. Must not be null.

Returns:

new instance of MongoJsonSchemaCreator.

Since:

3.3

property

MongoJsonSchemaCreator.PropertySpecifier property(String path)

Entry point to specify additional behavior for a given path.

Parameters:

path - the path using dot '.' notation.

Returns:

new instance of MongoJsonSchemaCreator.PropertySpecifier.

Since:

3.4

encryptedOnly

static Predicate<MongoJsonSchemaCreator.JsonSchemaPropertyContext> encryptedOnly()

A filter Predicate that matches encrypted properties and those having nested ones.

Returns:

new instance of Predicate.

Since:

3.3

create

static MongoJsonSchemaCreator create(MongoConverter mongoConverter)

Creates a new MongoJsonSchemaCreator that is aware of conversions applied by the given MongoConverter.

Parameters:

mongoConverter - must not be null.

Returns:

new instance of MongoJsonSchemaCreator.

create

static MongoJsonSchemaCreator create(MappingContext mappingContext)

Creates a new MongoJsonSchemaCreator that is aware of type mappings and potential extensions.

Parameters:

mappingContext - must not be null.

Returns:

new instance of MongoJsonSchemaCreator.

Since:

3.3

create

static MongoJsonSchemaCreator create()

Creates a new MongoJsonSchemaCreator that does not consider potential extensions - suitable for testing. We recommend to use create(MappingContext).

Returns:

new instance of MongoJsonSchemaCreator.

Since:

3.3