package com.fasterxml.jackson.module.jsonSchema.factories;
import com.fasterxml.jackson.databind.JavaType;
import com.fasterxml.jackson.databind.JsonMappingException;
import com.fasterxml.jackson.databind.SerializerProvider;
import com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitable;
import com.fasterxml.jackson.databind.jsonFormatVisitors.JsonMapFormatVisitor;
import com.fasterxml.jackson.module.jsonSchema.JsonSchema;
import com.fasterxml.jackson.module.jsonSchema.types.ObjectSchema;
import com.fasterxml.jackson.module.jsonSchema.types.ReferenceSchema;
/**
* While JSON Schema does not have notion of "Map" type (unlimited property
* names), Jackson has, so the distinction is exposed. We will need
* to handle it here, produce JSON Schema Object type.
*/
public class MapVisitor extends JsonMapFormatVisitor.Base
implements JsonSchemaProducer, Visitor
{
protected final ObjectSchema schema;
protected SerializerProvider provider;
private WrapperFactory wrapperFactory;
private VisitorContext visitorContext;
public MapVisitor(SerializerProvider provider, ObjectSchema schema) {
this(provider, schema, new WrapperFactory());
}
public MapVisitor(SerializerProvider provider, ObjectSchema schema, WrapperFactory wrapperFactory) {
this.provider = provider;
this.schema = schema;
this.wrapperFactory = wrapperFactory;
}
/*
/*********************************************************************
/* JsonSchemaProducer
/*********************************************************************
*/
@Override
public ObjectSchema getSchema() {
return schema;
}
/*
/*********************************************************************
/* JsonMapFormatVisitor
/*********************************************************************
*/
@Override
public SerializerProvider getProvider() {
return provider;
}
@Override
public void setProvider(SerializerProvider p) {
provider = p;
}
@Override
public void keyFormat(JsonFormatVisitable handler, JavaType keyType)
throws JsonMappingException {
// JSON Schema only allows String types so let's not bother too much
}
@Override
public void valueFormat(JsonFormatVisitable handler, JavaType valueType)
throws JsonMappingException {
// ISSUE #24: https://github.com/FasterXML/jackson-module-jsonSchema/issues/24
JsonSchema valueSchema = propertySchema(handler, valueType);
ObjectSchema.AdditionalProperties ap = new ObjectSchema.SchemaAdditionalProperties(valueSchema.asSimpleTypeSchema());
this.schema.setAdditionalProperties(ap);
}
protected JsonSchema propertySchema(JsonFormatVisitable handler, JavaType propertyTypeHint)
throws JsonMappingException {
// check if we've seen this sub-schema already and return a reference-schema if we have
if (visitorContext != null) {
String seenSchemaUri = visitorContext.getSeenSchemaUri(propertyTypeHint);
if (seenSchemaUri != null) {
return new ReferenceSchema(seenSchemaUri);
}
}
SchemaFactoryWrapper visitor = wrapperFactory.getWrapper(getProvider(), visitorContext);
handler.acceptJsonFormatVisitor(visitor, propertyTypeHint);
return visitor.finalSchema();
}
@Override
public Visitor setVisitorContext(VisitorContext rvc) {
visitorContext = rvc;
return this;
}
}