Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Json Schema - Add support for mapping styles #93

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Json Schema - Add support for mapping styles #93

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a698b02
deliver mappingStyle capability
Jun 1, 2020
e00701d
deliver mappingStyle capability
scodeman Jun 1, 2020
8eeb076
Merge branch 'mappingStyle' of github.com:scodeman/jsonix-schema-comp…
scodeman Jun 1, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
208 changes: 107 additions & 101 deletions ...iler/src/main/java/org/hisrc/jsonix/compilation/jsonschema/JsonSchemaMappingCompiler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,105 +23,111 @@

public class JsonSchemaMappingCompiler<T, C extends T> {

private final Modules<T, C> modules;
private final Module<T, C> module;
private final Mapping<T, C> mapping;
private final JsonBuilderFactory jsonBuilderFactory;

public JsonSchemaMappingCompiler(JsonBuilderFactory jsonBuilderFactory, Modules<T, C> modules, Module<T, C> module,
Mapping<T, C> mapping) {
Validate.notNull(jsonBuilderFactory);
Validate.notNull(modules);
Validate.notNull(module);
Validate.notNull(mapping);
this.jsonBuilderFactory = jsonBuilderFactory;
this.modules = modules;
this.module = module;
this.mapping = mapping;
}

public Modules<T, C> getModules() {
return modules;
}

public Module<T, C> getModule() {
return module;
}

public Mapping<T, C> getMapping() {
return mapping;
}

public JsonBuilderFactory getJsonBuilderFactory() {
return jsonBuilderFactory;
}

public JsonSchemaBuilder compile() {
final JsonSchemaBuilder schema = new JsonSchemaBuilder();
final String schemaId = mapping.getSchemaId();
schema.addId(schemaId);
addElementInfos(schema);
addClassInfoSchemas(schema);
addEnumLeafInfoSchemas(schema);
return schema;
}

private void addElementInfos(final JsonSchemaBuilder schema) {
for (MElementInfo<T, C> elementInfo : mapping.getElementInfos()) {
final QName elementName = elementInfo.getElementName();
final MTypeInfo<T, C> typeInfo = elementInfo.getTypeInfo();
final MClassInfo<T, C> scope = elementInfo.getScope();

final JsonSchemaBuilder elementInfoSchema = new JsonSchemaBuilder();
elementInfoSchema.addType(JsonSchemaConstants.OBJECT_TYPE);
final JsonSchemaBuilder qNameRef = new JsonSchemaBuilder()
.addRef(XmlSchemaJsonSchemaConstants.QNAME_TYPE_INFO_SCHEMA_REF);
final JsonSchemaBuilder nameConstant = new JsonSchemaBuilder();
nameConstant.addType(JsonSchemaConstants.OBJECT_TYPE);
nameConstant.addProperty(JsonixJsonSchemaConstants.LOCAL_PART_PROPERTY_NAME,
new JsonSchemaBuilder().addEnum(elementName.getLocalPart()));
nameConstant.addProperty(JsonixJsonSchemaConstants.NAMESPACE_URI_PROPERTY_NAME,
new JsonSchemaBuilder().addEnum(elementName.getNamespaceURI()));

elementInfoSchema.addProperty(JsonixConstants.NAME_PROPERTY_NAME,
new JsonSchemaBuilder().addAllOf(qNameRef).addAllOf(nameConstant));

elementInfoSchema.addProperty(JsonixConstants.VALUE_PROPERTY_NAME,
typeInfo.acceptTypeInfoVisitor(new CreateTypeInfoSchema<T, C, MElementInfo<T, C>, MElementInfoOrigin>(this, elementInfo)));

elementInfoSchema.add(JsonixJsonSchemaConstants.ELEMENT_NAME_PROPERTY_NAME,
new JsonSchemaBuilder()
.add(JsonixJsonSchemaConstants.LOCAL_PART_PROPERTY_NAME, elementName.getLocalPart()).add(
JsonixJsonSchemaConstants.NAMESPACE_URI_PROPERTY_NAME,
elementName.getNamespaceURI()));
if (scope != null) {
elementInfoSchema.add(JsonixJsonSchemaConstants.SCOPE_PROPERTY_NAME,
getTypeInfoProducer(elementInfo, typeInfo).createTypeInfoSchemaRef(this));
}
schema.addAnyOf(elementInfoSchema);
}
}

private void addEnumLeafInfoSchemas(final JsonSchemaBuilder schema) {
for (MEnumLeafInfo<T, C> enumLeafInfo : mapping.getEnumLeafInfos()) {
final EnumLeafInfoProducer<T, C> enumLeafInfoCompiler = new EnumLeafInfoProducer<T, C>(enumLeafInfo);
final JsonSchemaBuilder enumLeafInfoSchema = enumLeafInfoCompiler.compile(this);
schema.addDefinition(enumLeafInfo.getContainerLocalName(JsonixConstants.DEFAULT_SCOPED_NAME_DELIMITER),
enumLeafInfoSchema);
}
}

private void addClassInfoSchemas(final JsonSchemaBuilder schema) {
for (MClassInfo<T, C> classInfo : mapping.getClassInfos()) {
final ClassInfoProducer<T, C> classInfoCompiler = new ClassInfoProducer<T, C>(classInfo);
final JsonSchemaBuilder classInfoSchema = classInfoCompiler.compile(this);
schema.addDefinition(classInfo.getContainerLocalName(JsonixConstants.DEFAULT_SCOPED_NAME_DELIMITER),
classInfoSchema);
}
}

public <M extends MOriginated<O>, O> TypeInfoProducer<T, C> getTypeInfoProducer(M originated,
MTypeInfo<T, C> typeInfo) {
return typeInfo.acceptTypeInfoVisitor(new CreateTypeInfoProducer<T, C, O>(originated));
}
private final Modules<T, C> modules;
private final Module<T, C> module;
private final Mapping<T, C> mapping;
private final JsonBuilderFactory jsonBuilderFactory;

public JsonSchemaMappingCompiler(JsonBuilderFactory jsonBuilderFactory, Modules<T, C> modules, Module<T, C> module,
Mapping<T, C> mapping) {
Validate.notNull(jsonBuilderFactory);
Validate.notNull(modules);
Validate.notNull(module);
Validate.notNull(mapping);
this.jsonBuilderFactory = jsonBuilderFactory;
this.modules = modules;
this.module = module;
this.mapping = mapping;
}

public Modules<T, C> getModules() {
return modules;
}

public Module<T, C> getModule() {
return module;
}

public Mapping<T, C> getMapping() {
return mapping;
}

public JsonBuilderFactory getJsonBuilderFactory() {
return jsonBuilderFactory;
}

public JsonSchemaBuilder compile() {
final JsonSchemaBuilder schema = new JsonSchemaBuilder();
final String schemaId = mapping.getSchemaId();
schema.addId(schemaId);
addElementInfos(schema);
addClassInfoSchemas(schema);
addEnumLeafInfoSchemas(schema);
return schema;
}

private void addElementInfos(final JsonSchemaBuilder schema) {
for (MElementInfo<T, C> elementInfo : mapping.getElementInfos()) {
final QName elementName = elementInfo.getElementName();
final MTypeInfo<T, C> typeInfo = elementInfo.getTypeInfo();
final MClassInfo<T, C> scope = elementInfo.getScope();

final JsonSchemaBuilder elementInfoSchema;

if (mapping.getMappingStyle().equals("simplified")) {
elementInfoSchema = typeInfo.acceptTypeInfoVisitor(new CreateTypeInfoSchema<T, C, MElementInfo<T, C>, MElementInfoOrigin>(this, elementInfo));
} else {
elementInfoSchema = new JsonSchemaBuilder();
elementInfoSchema.addType(JsonSchemaConstants.OBJECT_TYPE);
final JsonSchemaBuilder qNameRef = new JsonSchemaBuilder()
.addRef(XmlSchemaJsonSchemaConstants.QNAME_TYPE_INFO_SCHEMA_REF);
final JsonSchemaBuilder nameConstant = new JsonSchemaBuilder();
nameConstant.addType(JsonSchemaConstants.OBJECT_TYPE);
nameConstant.addProperty(JsonixJsonSchemaConstants.LOCAL_PART_PROPERTY_NAME,
new JsonSchemaBuilder().addEnum(elementName.getLocalPart()));
nameConstant.addProperty(JsonixJsonSchemaConstants.NAMESPACE_URI_PROPERTY_NAME,
new JsonSchemaBuilder().addEnum(elementName.getNamespaceURI()));

elementInfoSchema.addProperty(JsonixConstants.NAME_PROPERTY_NAME,
new JsonSchemaBuilder().addAllOf(qNameRef).addAllOf(nameConstant));

elementInfoSchema.addProperty(JsonixConstants.VALUE_PROPERTY_NAME,
typeInfo.acceptTypeInfoVisitor(new CreateTypeInfoSchema<T, C, MElementInfo<T, C>, MElementInfoOrigin>(this, elementInfo)));

elementInfoSchema.add(JsonixJsonSchemaConstants.ELEMENT_NAME_PROPERTY_NAME,
new JsonSchemaBuilder()
.add(JsonixJsonSchemaConstants.LOCAL_PART_PROPERTY_NAME, elementName.getLocalPart()).add(
JsonixJsonSchemaConstants.NAMESPACE_URI_PROPERTY_NAME,
elementName.getNamespaceURI()));
if (scope != null) {
elementInfoSchema.add(JsonixJsonSchemaConstants.SCOPE_PROPERTY_NAME,
getTypeInfoProducer(elementInfo, typeInfo).createTypeInfoSchemaRef(this));
}
}
schema.addAnyOf(elementInfoSchema);
}
}

private void addEnumLeafInfoSchemas(final JsonSchemaBuilder schema) {
for (MEnumLeafInfo<T, C> enumLeafInfo : mapping.getEnumLeafInfos()) {
final EnumLeafInfoProducer<T, C> enumLeafInfoCompiler = new EnumLeafInfoProducer<T, C>(enumLeafInfo);
final JsonSchemaBuilder enumLeafInfoSchema = enumLeafInfoCompiler.compile(this);
schema.addDefinition(enumLeafInfo.getContainerLocalName(JsonixConstants.DEFAULT_SCOPED_NAME_DELIMITER),
enumLeafInfoSchema);
}
}

private void addClassInfoSchemas(final JsonSchemaBuilder schema) {
for (MClassInfo<T, C> classInfo : mapping.getClassInfos()) {
final ClassInfoProducer<T, C> classInfoCompiler = new ClassInfoProducer<T, C>(classInfo);
final JsonSchemaBuilder classInfoSchema = classInfoCompiler.compile(this);
schema.addDefinition(classInfo.getContainerLocalName(JsonixConstants.DEFAULT_SCOPED_NAME_DELIMITER),
classInfoSchema);
}
}

public <M extends MOriginated<O>, O> TypeInfoProducer<T, C> getTypeInfoProducer(M originated,
MTypeInfo<T, C> typeInfo) {
return typeInfo.acceptTypeInfoVisitor(new CreateTypeInfoProducer<T, C, O>(originated));
}
}
32 changes: 21 additions & 11 deletions ...n/java/org/hisrc/jsonix/compilation/jsonschema/JsonSchemaPropertyInfoProducerVisitor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,10 +155,15 @@ public JsonSchemaBuilder visitAnyElementPropertyInfo(MAnyElementPropertyInfo<T,
itemTypeSchemas.add(new JsonSchemaBuilder().addRef(JsonixJsonSchemaConstants.DOM_TYPE_INFO_SCHEMA_REF));
}
if (info.isTypedObjectAllowed()) {
final JsonSchemaBuilder anyElementSchema = new JsonSchemaBuilder().addType(JsonSchemaConstants.OBJECT_TYPE)
.addProperty(JsonixConstants.NAME_PROPERTY_NAME,
new JsonSchemaBuilder().addRef(XmlSchemaJsonSchemaConstants.QNAME_TYPE_INFO_SCHEMA_REF))
.addProperty(JsonixConstants.VALUE_PROPERTY_NAME, new JsonSchemaBuilder());
final JsonSchemaBuilder anyElementSchema;
if (mappingCompiler.getMapping().getMappingStyle().equals("simplified")) {
anyElementSchema = new JsonSchemaBuilder();
} else {
anyElementSchema = new JsonSchemaBuilder().addType(JsonSchemaConstants.OBJECT_TYPE)
.addProperty(JsonixConstants.NAME_PROPERTY_NAME,
new JsonSchemaBuilder().addRef(XmlSchemaJsonSchemaConstants.QNAME_TYPE_INFO_SCHEMA_REF))
.addProperty(JsonixConstants.VALUE_PROPERTY_NAME, new JsonSchemaBuilder());
}
itemTypeSchemas.add(anyElementSchema);
}
final JsonSchemaBuilder typeSchema = createPossiblyCollectionTypeSchema(info,
Expand Down Expand Up @@ -259,13 +264,18 @@ private List<JsonSchemaBuilder> createElementRefsSchema(
}

private <M extends MElementTypeInfo<T, C, O>, O> JsonSchemaBuilder createElementRefSchema(M elementTypeInfo) {
final JsonSchemaBuilder schema = new JsonSchemaBuilder();
addElementNameSchema(elementTypeInfo.getElementName(), schema);
schema.addType(JsonSchemaConstants.OBJECT_TYPE);
schema.addProperty(JsonixConstants.NAME_PROPERTY_NAME,
new JsonSchemaBuilder().addRef(XmlSchemaJsonSchemaConstants.QNAME_TYPE_INFO_SCHEMA_REF));
schema.addProperty(JsonixConstants.VALUE_PROPERTY_NAME,
createTypeSchema(elementTypeInfo, elementTypeInfo.getTypeInfo()));
final JsonSchemaBuilder schema;
if (mappingCompiler.getMapping().getMappingStyle().equals("simplified")) {
schema = createTypeSchema(elementTypeInfo, elementTypeInfo.getTypeInfo());
} else {
schema = new JsonSchemaBuilder();
addElementNameSchema(elementTypeInfo.getElementName(), schema);
schema.addType(JsonSchemaConstants.OBJECT_TYPE);
schema.addProperty(JsonixConstants.NAME_PROPERTY_NAME,
new JsonSchemaBuilder().addRef(XmlSchemaJsonSchemaConstants.QNAME_TYPE_INFO_SCHEMA_REF));
schema.addProperty(JsonixConstants.VALUE_PROPERTY_NAME,
createTypeSchema(elementTypeInfo, elementTypeInfo.getTypeInfo()));
}
return schema;
}

Expand Down
23 changes: 22 additions & 1 deletion compiler/src/main/java/org/hisrc/jsonix/configuration/MappingConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,14 @@ public class MappingConfiguration {
public static final String MAPPING_NAME_PROPERTY = "${mapping.name}";
public static final String MAPPING_TARGET_NAMESPACE_URI_PROPERTY = "${mapping.targetNamespace}";
public static final String LOCAL_ELEMENT_NAME = "mapping";
public static final String DEFAULT_MAPPING_STYLE = "default";

private ModuleConfiguration moduleConfiguration;
private String id;
private String name;
private String _package;
private String schemaId = MappingConfiguration.MAPPING_TARGET_NAMESPACE_URI_PROPERTY + "#";
private String mappingStyle;
private String targetNamespaceURI;
private String defaultElementNamespaceURI;
private String defaultAttributeNamespaceURI;
Expand Down Expand Up @@ -82,6 +84,15 @@ public void setSchemaId(String schemaId) {
this.schemaId = schemaId;
}

@XmlAttribute(name = "mappingStyle")
public String getMappingStyle() {
return mappingStyle;
}

public void setMappingStyle(String mappingStyle) {
this.mappingStyle = mappingStyle;
}

@XmlAttribute(name = "targetNamespace")
public String getTargetNamespaceURI() {
return targetNamespaceURI;
Expand Down Expand Up @@ -198,8 +209,18 @@ public <T, C extends T> Mapping<T, C> build(JsonixContext context,
.replace(MappingConfiguration.MAPPING_NAME_PROPERTY, getName())
.replace(MappingConfiguration.MAPPING_TARGET_NAMESPACE_URI_PROPERTY, targetNamespaceURI);

final String mappingStyle;
if (this.mappingStyle != null) {
mappingStyle = this.mappingStyle;
} else {
logger.debug(MessageFormat
.format("Mapping [{0}] will use Standard Mapping Style in the package [{2}].",
mappingName, packageName));
mappingStyle = MappingConfiguration.DEFAULT_MAPPING_STYLE;
}

final Mapping<T, C> mapping = new Mapping<T, C>(context, analyzer,
packageInfo, mappingName, mappingSchemaId, targetNamespaceURI,
packageInfo, mappingName, mappingSchemaId, mappingStyle, targetNamespaceURI,
defaultElementNamespaceURI, defaultAttributeNamespaceURI);

if (getExcludesConfiguration() != null) {
Expand Down
9 changes: 8 additions & 1 deletion compiler/src/main/java/org/hisrc/jsonix/definition/Mapping.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,14 +47,15 @@ public class Mapping<T, C extends T> {
private final String packageName;
private final String mappingName;
private final String schemaId;
private final String mappingStyle;
private final String targetNamespaceURI;
private final String defaultElementNamespaceURI;
private final String defaultAttributeNamespaceURI;
private final Map<InfoVertex<T, C>, ContainmentType> verticesContainmentMap = new HashMap<InfoVertex<T, C>, ContainmentType>();

public Mapping(JsonixContext context,
ModelInfoGraphAnalyzer<T, C> analyzer, MPackageInfo packageInfo,
String mappingName, String schemaId, String targetNamespaceURI,
String mappingName, String schemaId, String mappingStyle, String targetNamespaceURI,
String defaultElementNamespaceURI,
String defaultAttributeNamespaceURI) {
this.logger = Validate.notNull(context).getLoggerFactory()
Expand All @@ -63,13 +64,15 @@ public Mapping(JsonixContext context,
Validate.notNull(packageInfo);
Validate.notNull(mappingName);
Validate.notNull(schemaId);
Validate.notNull(mappingStyle);
Validate.notNull(defaultElementNamespaceURI);
Validate.notNull(defaultAttributeNamespaceURI);
this.analyzer = analyzer;
this.packageInfo = packageInfo;
this.packageName = packageInfo.getPackageName();
this.mappingName = mappingName;
this.schemaId = schemaId;
this.mappingStyle = mappingStyle;
this.targetNamespaceURI = targetNamespaceURI;
this.defaultElementNamespaceURI = defaultElementNamespaceURI;
this.defaultAttributeNamespaceURI = defaultAttributeNamespaceURI;
Expand Down Expand Up @@ -452,6 +455,10 @@ public String getSchemaId() {
return this.schemaId;
}

public String getMappingStyle() {
return this.mappingStyle;
}

public String getTargetNamespaceURI() {
return targetNamespaceURI;
}
Expand Down