Package org.springframework.data.mongodb.core.schema

Class IdentifiableJsonSchemaProperty<T extends JsonSchemaObject>

java.lang.Object

org.springframework.data.mongodb.core.schema.IdentifiableJsonSchemaProperty<T>

All Implemented Interfaces:

JsonSchemaObject, JsonSchemaProperty

Direct Known Subclasses:

IdentifiableJsonSchemaProperty.ArrayJsonSchemaProperty, IdentifiableJsonSchemaProperty.BooleanJsonSchemaProperty, IdentifiableJsonSchemaProperty.DateJsonSchemaProperty, IdentifiableJsonSchemaProperty.NullJsonSchemaProperty, IdentifiableJsonSchemaProperty.NumericJsonSchemaProperty, IdentifiableJsonSchemaProperty.ObjectJsonSchemaProperty, IdentifiableJsonSchemaProperty.StringJsonSchemaProperty, IdentifiableJsonSchemaProperty.TimestampJsonSchemaProperty, IdentifiableJsonSchemaProperty.UntypedJsonSchemaProperty

public class IdentifiableJsonSchemaProperty<T extends JsonSchemaObject>
extends Object
implements JsonSchemaProperty

JsonSchemaProperty implementation.

Since:

2.1

Author:

Christoph Strobl, Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IdentifiableJsonSchemaProperty.ArrayJsonSchemaProperty	Convenience JsonSchemaProperty implementation for a type : 'array' property.
static class	IdentifiableJsonSchemaProperty.BooleanJsonSchemaProperty	Convenience JsonSchemaProperty implementation for a type : 'boolean' property.
static class	IdentifiableJsonSchemaProperty.DateJsonSchemaProperty	Convenience JsonSchemaProperty implementation for a type : 'date' property.
static class	IdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty	JsonSchemaProperty implementation for encrypted fields.
static class	IdentifiableJsonSchemaProperty.NullJsonSchemaProperty	Convenience JsonSchemaProperty implementation for a type : 'null' property.
static class	IdentifiableJsonSchemaProperty.NumericJsonSchemaProperty	Convenience JsonSchemaProperty implementation for a type : 'number' property.
static class	IdentifiableJsonSchemaProperty.ObjectJsonSchemaProperty	Convenience JsonSchemaProperty implementation for a type : 'object' property.
static class	IdentifiableJsonSchemaProperty.QueryableJsonSchemaProperty	JsonSchemaProperty implementation typically wrapping an encrypted property to mark it as queryable.
static class	IdentifiableJsonSchemaProperty.RequiredJsonSchemaProperty	Delegating JsonSchemaProperty implementation having a required flag for evaluation during schema creation process.
static class	IdentifiableJsonSchemaProperty.StringJsonSchemaProperty	Convenience JsonSchemaProperty implementation for a type : 'string' property.
static class	IdentifiableJsonSchemaProperty.TimestampJsonSchemaProperty	Convenience JsonSchemaProperty implementation for a type : 'timestamp' property.
static class	IdentifiableJsonSchemaProperty.UntypedJsonSchemaProperty	Convenience JsonSchemaProperty implementation without a type property.

Nested classes/interfaces inherited from interface org.springframework.data.mongodb.core.schema.JsonSchemaObject

JsonSchemaObject.Type

Nested classes/interfaces inherited from interface org.springframework.data.mongodb.core.schema.JsonSchemaProperty

JsonSchemaProperty.JsonSchemaPropertyBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	identifier
protected final T	jsonSchemaObjectDelegate

Method Summary

Modifier and Type	Method	Description
String	getIdentifier()	The identifier can be either the property name or the regex expression properties have to match when used along with TypedJsonSchemaObject.ObjectJsonSchemaObject.patternProperties(JsonSchemaProperty...).
Set<JsonSchemaObject.Type>	getTypes()	Get the set of types defined for this schema element. The Set is likely to contain only one element in most cases.
org.bson.Document	toDocument()	Get the MongoDB specific representation. The Document may contain fields (eg. like bsonType) not contained in the JsonSchema specification.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.data.mongodb.core.schema.JsonSchemaProperty

isRequired

Field Details

identifier

protected final String identifier

jsonSchemaObjectDelegate

protected final T extends JsonSchemaObject jsonSchemaObjectDelegate

Method Details

getIdentifier

public String getIdentifier()

Description copied from interface: JsonSchemaProperty

The identifier can be either the property name or the regex expression properties have to match when used along with TypedJsonSchemaObject.ObjectJsonSchemaObject.patternProperties(JsonSchemaProperty...).

Specified by:

getIdentifier in interface JsonSchemaProperty

Returns:

never null.

toDocument

public org.bson.Document toDocument()

Description copied from interface: JsonSchemaObject

Get the MongoDB specific representation.
The Document may contain fields (eg. like bsonType) not contained in the JsonSchema specification. It may also contain types not directly processable by the MongoDB java driver. Make sure to run the produced Document through the mapping infrastructure.

Specified by:

toDocument in interface JsonSchemaObject

Returns:

never null.

getTypes

public Set<JsonSchemaObject.Type> getTypes()

Description copied from interface: JsonSchemaObject

Get the set of types defined for this schema element.
The Set is likely to contain only one element in most cases.

Specified by:

getTypes in interface JsonSchemaObject

Returns:

never null.