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

Class IdentifiableJsonSchemaProperty.QueryableJsonSchemaProperty

java.lang.Object

org.springframework.data.mongodb.core.schema.IdentifiableJsonSchemaProperty.QueryableJsonSchemaProperty

All Implemented Interfaces:

JsonSchemaObject, JsonSchemaProperty

Enclosing class:

IdentifiableJsonSchemaProperty<T extends JsonSchemaObject>

public static class IdentifiableJsonSchemaProperty.QueryableJsonSchemaProperty
extends Object
implements JsonSchemaProperty

JsonSchemaProperty implementation typically wrapping an encrypted property to mark it as queryable.

Since:

4.5

Author:

Christoph Strobl

Nested Class Summary

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

Constructor Summary

Constructors

Constructor	Description
QueryableJsonSchemaProperty(JsonSchemaProperty target, QueryCharacteristics characteristics)

Method Summary

Modifier and Type	Method	Description
QueryCharacteristics	getCharacteristics()
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...).
JsonSchemaProperty	getTargetProperty()
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

Constructor Details

QueryableJsonSchemaProperty

public QueryableJsonSchemaProperty(JsonSchemaProperty target,
 QueryCharacteristics characteristics)

Method Details

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.

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.

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.

getTargetProperty

public JsonSchemaProperty getTargetProperty()

getCharacteristics

public QueryCharacteristics getCharacteristics()