com.mongodb.jdbc

Class MongoJsonSchema

java.lang.Object

com.mongodb.jdbc.MongoJsonSchema

public class MongoJsonSchema
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MongoJsonSchema.ScalarProperties

Field Summary

Fields

Modifier and Type	Field and Description
boolean	additionalProperties
java.util.Set<MongoJsonSchema>	anyOf
java.lang.String	bsonType
MongoJsonSchema	items
java.util.Map<java.lang.String,MongoJsonSchema>	properties
java.util.Set<java.lang.String>	required

Constructor Summary

Constructors

Constructor and Description
MongoJsonSchema()

Method Summary

Modifier and Type	Method and Description
void	addScalarKeys(MongoJsonSchema.ScalarProperties... scalarProperties) Adds scalar properties to a MongoJsonSchema.
static MongoJsonSchema	createEmptyObjectSchema()
static MongoJsonSchema	createScalarSchema(java.lang.String type)
boolean	equals(java.lang.Object obj)
BsonTypeInfo	getBsonTypeInfo() Gets the bson type for this schema as a BsonTypeInfo enum value.
int	getColumnNullability(java.lang.String columnName) Gets the nullability of a column (field) in this schemas list of properties.
int	hashCode()
boolean	isAny()
boolean	isObject()
static MongoJsonSchema	toSimplifiedMongoJsonSchema(JsonSchema baseSchema) Converts a deserialized jsonSchema into a MongoJsonSchema.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

bsonType

public java.lang.String bsonType

properties

public java.util.Map<java.lang.String,MongoJsonSchema> properties

anyOf

public java.util.Set<MongoJsonSchema> anyOf

required

public java.util.Set<java.lang.String> required

items

public MongoJsonSchema items

additionalProperties

public boolean additionalProperties

Constructor Detail

MongoJsonSchema

public MongoJsonSchema()

Method Detail

toSimplifiedMongoJsonSchema

public static MongoJsonSchema toSimplifiedMongoJsonSchema(JsonSchema baseSchema)

Converts a deserialized jsonSchema into a MongoJsonSchema. The MongoJsonSchema instance is semantically equivalent to the base jsonSchema, but bsonType has to be a single type otherwise the types will get pushed down in the anyOf list. After the conversion is done, anyOfs are flattened.

Parameters:

baseSchema - The base json schema.

Returns:

the corresponding MongoJsonSchema.

createEmptyObjectSchema

public static MongoJsonSchema createEmptyObjectSchema()

createScalarSchema

public static MongoJsonSchema createScalarSchema(java.lang.String type)

addScalarKeys

@SafeVarargs
public final void addScalarKeys(MongoJsonSchema.ScalarProperties... scalarProperties)

Adds scalar properties to a MongoJsonSchema. Below is an example for adding a scalar property:

 {
   "bsonType": "object",
   "properties": {
     "bar": { "bsonType": "int" }
   }
 }
 

will become

 {
   "bsonType": "object",
   "properties": {
     "bar": { "bsonType": "int" },
     "foo": { "bsonType": "bool" }
   },
   "required": [foo]
 }
 

Parameters:

scalarProperties - Contains the basic info (name, bsonType and required flag) for each key. Each property is converted into a scalar MongoJsonSchema and added to this parent schema.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isAny

public boolean isAny()

isObject

public boolean isObject()

getColumnNullability

public int getColumnNullability(java.lang.String columnName)
                         throws java.sql.SQLException

Gets the nullability of a column (field) in this schemas list of properties. Its nullability is determined as follows:

• If it is not present in this schema's list of properties:
  • If it is required or this schema allows additional properties, it is considered unknown nullability
  • Otherwise, an exception is thrown
• If it is a scalar schema (i.e. not Any or AnyOf):
  • If its bson type is Null, it is considered nullable
  • Otherwise, its nullability depends on whether it is required
• If it is an Any schema, it is considered nullable
• If it is an AnyOf schema, it is considered nullable if one of the component schemas in the AnyOf list is Null
  • This relies on the assumption that schemata returned by MongoSQL are simplified

Parameters:

columnName - The name of the column (or "field") for which to return nullability information

Returns:

The nullability of the argument

Throws:

java.sql.SQLException - If the argued column is not in this schema, or if this schema is invalid

getBsonTypeInfo

@BsonIgnore
public BsonTypeInfo getBsonTypeInfo()
                                         throws java.sql.SQLException

Gets the bson type for this schema as a BsonTypeInfo enum value.

Returns:

The relevant BsonTypeInfo value

Throws:

java.sql.SQLException - If this schema is invalid