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.

Since:

2.2

Author:

Christoph Strobl

Method Summary

Modifier and Type	Method and Description
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.

Method Detail

createSchemaFor

MongoJsonSchema createSchemaFor(Class<?> type)

Create the MongoJsonSchema for the given type.

Parameters:

type - must not be null.

Returns:

never null.

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.