X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=restconf%2Fsal-rest-docgen%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fnetconf%2Fsal%2Frest%2Fdoc%2Fimpl%2FModelGenerator.java;h=b48754136baa95e24a8113569919c802553b6248;hb=d6cc6c95d317f2c678278feb41235de8316f128f;hp=75bfe75d0cd3d5ca00c586851690dd91f031633b;hpb=e913990a55194144eb16011ce7de8a23530e6147;p=netconf.git diff --git a/restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/impl/ModelGenerator.java b/restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/impl/ModelGenerator.java index 75bfe75d0c..b48754136b 100644 --- a/restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/impl/ModelGenerator.java +++ b/restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/impl/ModelGenerator.java @@ -9,53 +9,57 @@ package org.opendaylight.netconf.sal.rest.doc.impl; import static org.opendaylight.netconf.sal.rest.doc.util.RestDocgenUtil.resolveNodesName; -import com.google.common.base.Optional; +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.node.ArrayNode; +import com.fasterxml.jackson.databind.node.JsonNodeFactory; +import com.fasterxml.jackson.databind.node.ObjectNode; +import com.fasterxml.jackson.databind.node.TextNode; +import com.google.common.collect.Range; +import com.google.common.collect.RangeSet; import com.mifmif.common.regex.Generex; import java.io.IOException; -import java.util.ArrayList; import java.util.List; +import java.util.Optional; import java.util.Set; import java.util.regex.Pattern; import javax.annotation.concurrent.NotThreadSafe; -import org.json.JSONArray; -import org.json.JSONException; -import org.json.JSONObject; import org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder; import org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.Post; import org.opendaylight.yangtools.yang.common.QName; +import org.opendaylight.yangtools.yang.model.api.AnyDataSchemaNode; import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode; import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode; -import org.opendaylight.yangtools.yang.model.api.ConstraintDefinition; import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode; import org.opendaylight.yangtools.yang.model.api.DataNodeContainer; import org.opendaylight.yangtools.yang.model.api.DataSchemaNode; +import org.opendaylight.yangtools.yang.model.api.ElementCountConstraint; import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode; import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode; import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode; import org.opendaylight.yangtools.yang.model.api.ListSchemaNode; +import org.opendaylight.yangtools.yang.model.api.MandatoryAware; import org.opendaylight.yangtools.yang.model.api.Module; import org.opendaylight.yangtools.yang.model.api.RevisionAwareXPath; import org.opendaylight.yangtools.yang.model.api.RpcDefinition; import org.opendaylight.yangtools.yang.model.api.SchemaContext; import org.opendaylight.yangtools.yang.model.api.SchemaNode; import org.opendaylight.yangtools.yang.model.api.TypeDefinition; -import org.opendaylight.yangtools.yang.model.api.TypedSchemaNode; +import org.opendaylight.yangtools.yang.model.api.TypedDataSchemaNode; import org.opendaylight.yangtools.yang.model.api.type.BinaryTypeDefinition; import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition; import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition.Bit; import org.opendaylight.yangtools.yang.model.api.type.BooleanTypeDefinition; -import org.opendaylight.yangtools.yang.model.api.type.DecimalTypeDefinition; import org.opendaylight.yangtools.yang.model.api.type.EmptyTypeDefinition; import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition; import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition.EnumPair; import org.opendaylight.yangtools.yang.model.api.type.IdentityrefTypeDefinition; -import org.opendaylight.yangtools.yang.model.api.type.IntegerTypeDefinition; import org.opendaylight.yangtools.yang.model.api.type.LeafrefTypeDefinition; import org.opendaylight.yangtools.yang.model.api.type.LengthConstraint; import org.opendaylight.yangtools.yang.model.api.type.PatternConstraint; +import org.opendaylight.yangtools.yang.model.api.type.RangeConstraint; +import org.opendaylight.yangtools.yang.model.api.type.RangeRestrictedTypeDefinition; import org.opendaylight.yangtools.yang.model.api.type.StringTypeDefinition; import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition; -import org.opendaylight.yangtools.yang.model.api.type.UnsignedIntegerTypeDefinition; import org.opendaylight.yangtools.yang.model.util.RevisionAwareXPathImpl; import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil; import org.slf4j.Logger; @@ -99,17 +103,18 @@ public class ModelGenerator { } /** - * Creates Json models from provided module according to swagger spec + * Creates Json models from provided module according to swagger spec. * * @param module - Yang module to be converted * @param schemaContext - SchemaContext of all Yang files used by Api Doc - * @return JSONObject containing data used for creating examples and models in Api Doc - * @throws IOException - * @throws JSONException + * @return ObjectNode containing data used for creating examples and models in Api Doc + * @throws IOException if I/O operation fails */ - public JSONObject convertToJsonSchema(final Module module, final SchemaContext schemaContext) throws IOException, JSONException { - final JSONObject models = new JSONObject(); - models.put(UNIQUE_EMPTY_IDENTIFIER, new JSONObject()); + public ObjectNode convertToJsonSchema(final Module module, + final SchemaContext schemaContext) throws IOException { + final ObjectNode models = JsonNodeFactory.instance.objectNode(); + final ObjectNode emptyIdentifier = JsonNodeFactory.instance.objectNode(); + models.set(UNIQUE_EMPTY_IDENTIFIER, emptyIdentifier); topLevelModule = module; processModules(module, models, schemaContext); processContainersAndLists(module, models, schemaContext); @@ -118,13 +123,14 @@ public class ModelGenerator { return models; } - private void processModules(final Module module, final JSONObject models, final SchemaContext schemaContext) throws JSONException { + private void processModules(final Module module, final ObjectNode models, + final SchemaContext schemaContext) { createConcreteModelForPost(models, module.getName() + BaseYangSwaggerGenerator.MODULE_NAME_SUFFIX, createPropertiesForPost(module, schemaContext, module.getName())); } - private void processContainersAndLists(final Module module, final JSONObject models, final SchemaContext schemaContext) - throws IOException, JSONException { + private void processContainersAndLists(final Module module, final ObjectNode models, + final SchemaContext schemaContext) throws IOException { final String moduleName = module.getName(); for (final DataSchemaNode childNode : module.getChildNodes()) { @@ -137,63 +143,65 @@ public class ModelGenerator { } /** - * Process the RPCs for a Module Spits out a file each of the name -input.json and -output.json - * for each RPC that contains input & output elements + * Process the RPCs for a Module Spits out a file each of the name + * {@code -input.json and -output.json} + * for each RPC that contains input & output elements. * - * @param module - * @throws JSONException - * @throws IOException + * @param module module + * @throws IOException if I/O operation fails */ - private void processRPCs(final Module module, final JSONObject models, final SchemaContext schemaContext) throws JSONException, - IOException { + private void processRPCs(final Module module, final ObjectNode models, + final SchemaContext schemaContext) throws IOException { final Set rpcs = module.getRpcs(); final String moduleName = module.getName(); for (final RpcDefinition rpc : rpcs) { final ContainerSchemaNode input = rpc.getInput(); if (!input.getChildNodes().isEmpty()) { - final JSONObject properties = processChildren(input.getChildNodes(), moduleName, models, true, schemaContext); + final ObjectNode properties = + processChildren(input.getChildNodes(), moduleName, models, true, schemaContext); final String filename = "(" + rpc.getQName().getLocalName() + ")input"; - final JSONObject childSchema = getSchemaTemplate(); + final ObjectNode childSchema = getSchemaTemplate(); childSchema.put(TYPE_KEY, OBJECT_TYPE); - childSchema.put(PROPERTIES_KEY, properties); + childSchema.set(PROPERTIES_KEY, properties); childSchema.put(ID_KEY, filename); - models.put(filename, childSchema); + models.set(filename, childSchema); processTopData(filename, models, input); } final ContainerSchemaNode output = rpc.getOutput(); if (!output.getChildNodes().isEmpty()) { - final JSONObject properties = processChildren(output.getChildNodes(), moduleName, models, true, schemaContext); + final ObjectNode properties = + processChildren(output.getChildNodes(), moduleName, models, true, schemaContext); final String filename = "(" + rpc.getQName().getLocalName() + ")output"; - final JSONObject childSchema = getSchemaTemplate(); + final ObjectNode childSchema = getSchemaTemplate(); childSchema.put(TYPE_KEY, OBJECT_TYPE); - childSchema.put(PROPERTIES_KEY, properties); + childSchema.set(PROPERTIES_KEY, properties); childSchema.put(ID_KEY, filename); - models.put(filename, childSchema); + models.set(filename, childSchema); processTopData(filename, models, output); } } } - private JSONObject processTopData(final String filename, final JSONObject models, final SchemaNode schemaNode) { - final JSONObject items = new JSONObject(); + private ObjectNode processTopData(final String filename, final ObjectNode models, final SchemaNode schemaNode) { + final ObjectNode items = JsonNodeFactory.instance.objectNode(); items.put(REF_KEY, filename); - final JSONObject dataNodeProperties = new JSONObject(); + final ObjectNode dataNodeProperties = JsonNodeFactory.instance.objectNode(); dataNodeProperties.put(TYPE_KEY, schemaNode instanceof ListSchemaNode ? ARRAY_TYPE : OBJECT_TYPE); - dataNodeProperties.put(ITEMS_KEY, items); + dataNodeProperties.set(ITEMS_KEY, items); - dataNodeProperties.putOpt(DESCRIPTION_KEY, schemaNode.getDescription()); - final JSONObject properties = new JSONObject(); - properties.put(topLevelModule.getName() + ":" + schemaNode.getQName().getLocalName(), dataNodeProperties); - final JSONObject finalChildSchema = getSchemaTemplate(); + putIfNonNull(dataNodeProperties, DESCRIPTION_KEY, schemaNode.getDescription().orElse(null)); + final ObjectNode properties = JsonNodeFactory.instance.objectNode(); + properties.set(topLevelModule.getName() + ":" + schemaNode.getQName().getLocalName(), dataNodeProperties); + final ObjectNode finalChildSchema = getSchemaTemplate(); finalChildSchema.put(TYPE_KEY, OBJECT_TYPE); - finalChildSchema.put(PROPERTIES_KEY, properties); + finalChildSchema.set(PROPERTIES_KEY, properties); finalChildSchema.put(ID_KEY, filename + OperationBuilder.TOP); - models.put(filename + OperationBuilder.TOP, finalChildSchema); + models.set(filename + OperationBuilder.TOP, finalChildSchema); return dataNodeProperties; } @@ -202,68 +210,69 @@ public class ModelGenerator { * Processes the 'identity' statement in a yang model and maps it to a 'model' in the Swagger JSON spec. * * @param module The module from which the identity stmt will be processed - * @param models The JSONObject in which the parsed identity will be put as a 'model' obj + * @param models The ObjectNode in which the parsed identity will be put as a 'model' obj */ - private static void processIdentities(final Module module, final JSONObject models) throws JSONException { + private static void processIdentities(final Module module, final ObjectNode models) { final String moduleName = module.getName(); final Set idNodes = module.getIdentities(); LOG.debug("Processing Identities for module {} . Found {} identity statements", moduleName, idNodes.size()); for (final IdentitySchemaNode idNode : idNodes) { - final JSONObject identityObj = new JSONObject(); + final ObjectNode identityObj = JsonNodeFactory.instance.objectNode(); final String identityName = idNode.getQName().getLocalName(); LOG.debug("Processing Identity: {}", identityName); identityObj.put(ID_KEY, identityName); - identityObj.put(DESCRIPTION_KEY, idNode.getDescription()); + putIfNonNull(identityObj, DESCRIPTION_KEY, idNode.getDescription().orElse(null)); - final JSONObject props = new JSONObject(); - final IdentitySchemaNode baseId = idNode.getBaseIdentity(); + final ObjectNode props = JsonNodeFactory.instance.objectNode(); - if (baseId == null) { - /** + if (idNode.getBaseIdentities().isEmpty()) { + /* * This is a base identity. So lets see if it has sub types. If it does, then add them to the model * definition. */ final Set derivedIds = idNode.getDerivedIdentities(); if (derivedIds != null) { - final JSONArray subTypes = new JSONArray(); + final ArrayNode subTypes = new ArrayNode(JsonNodeFactory.instance); for (final IdentitySchemaNode derivedId : derivedIds) { - subTypes.put(derivedId.getQName().getLocalName()); + subTypes.add(derivedId.getQName().getLocalName()); } - identityObj.put(SUB_TYPES_KEY, subTypes); + identityObj.set(SUB_TYPES_KEY, subTypes); } } else { - /** + /* * This is a derived entity. Add it's base type & move on. */ - props.put(TYPE_KEY, baseId.getQName().getLocalName()); + props.put(TYPE_KEY, idNode.getBaseIdentities().iterator().next().getQName().getLocalName()); } // Add the properties. For a base type, this will be an empty object as required by the Swagger spec. - identityObj.put(PROPERTIES_KEY, props); - models.put(identityName, identityObj); + identityObj.set(PROPERTIES_KEY, props); + models.set(identityName, identityObj); } } - private JSONObject processDataNodeContainer(final DataNodeContainer dataNode, final String parentName, final JSONObject models, - final boolean isConfig, final SchemaContext schemaContext) throws JSONException, IOException { + private ObjectNode processDataNodeContainer( + final DataNodeContainer dataNode, final String parentName, final ObjectNode models, final boolean isConfig, + final SchemaContext schemaContext) throws IOException { if (dataNode instanceof ListSchemaNode || dataNode instanceof ContainerSchemaNode) { final Iterable containerChildren = dataNode.getChildNodes(); final String localName = ((SchemaNode) dataNode).getQName().getLocalName(); - final JSONObject properties = processChildren(containerChildren, parentName + "/" + localName, models, isConfig, schemaContext); + final ObjectNode properties = + processChildren(containerChildren, parentName + "/" + localName, models, isConfig, schemaContext); final String nodeName = parentName + (isConfig ? OperationBuilder.CONFIG : OperationBuilder.OPERATIONAL) + localName; - final JSONObject childSchema = getSchemaTemplate(); + final ObjectNode childSchema = getSchemaTemplate(); childSchema.put(TYPE_KEY, OBJECT_TYPE); - childSchema.put(PROPERTIES_KEY, properties); + childSchema.set(PROPERTIES_KEY, properties); childSchema.put(ID_KEY, nodeName); - models.put(nodeName, childSchema); + models.set(nodeName, childSchema); if (isConfig) { createConcreteModelForPost(models, localName, @@ -275,30 +284,30 @@ public class ModelGenerator { return null; } - private static void createConcreteModelForPost(final JSONObject models, final String localName, - final JSONObject properties) throws JSONException { + private static void createConcreteModelForPost(final ObjectNode models, final String localName, + final JsonNode properties) { final String nodePostName = OperationBuilder.CONFIG + localName + Post.METHOD_NAME; - final JSONObject postSchema = getSchemaTemplate(); + final ObjectNode postSchema = getSchemaTemplate(); postSchema.put(TYPE_KEY, OBJECT_TYPE); postSchema.put(ID_KEY, nodePostName); - postSchema.put(PROPERTIES_KEY, properties); - models.put(nodePostName, postSchema); + postSchema.set(PROPERTIES_KEY, properties); + models.set(nodePostName, postSchema); } - private JSONObject createPropertiesForPost(final DataNodeContainer dataNodeContainer, final SchemaContext schemaContext, final String parentName) - throws JSONException { - final JSONObject properties = new JSONObject(); + private JsonNode createPropertiesForPost(final DataNodeContainer dataNodeContainer, + final SchemaContext schemaContext, final String parentName) { + final ObjectNode properties = JsonNodeFactory.instance.objectNode(); for (final DataSchemaNode childNode : dataNodeContainer.getChildNodes()) { if (childNode instanceof ListSchemaNode || childNode instanceof ContainerSchemaNode) { - final JSONObject items = new JSONObject(); + final ObjectNode items = JsonNodeFactory.instance.objectNode(); items.put(REF_KEY, parentName + "(config)" + childNode.getQName().getLocalName()); - final JSONObject property = new JSONObject(); + final ObjectNode property = JsonNodeFactory.instance.objectNode(); property.put(TYPE_KEY, childNode instanceof ListSchemaNode ? ARRAY_TYPE : OBJECT_TYPE); - property.put(ITEMS_KEY, items); - properties.put(childNode.getQName().getLocalName(), property); + property.set(ITEMS_KEY, items); + properties.set(childNode.getQName().getLocalName(), property); } else if (childNode instanceof LeafSchemaNode) { - final JSONObject property = processLeafNode((LeafSchemaNode) childNode, schemaContext); - properties.put(childNode.getQName().getLocalName(), property); + final ObjectNode property = processLeafNode((LeafSchemaNode) childNode, schemaContext); + properties.set(childNode.getQName().getLocalName(), property); } } return properties; @@ -307,14 +316,14 @@ public class ModelGenerator { /** * Processes the nodes. */ - private JSONObject processChildren(final Iterable nodes, final String parentName, final JSONObject models, - final boolean isConfig, final SchemaContext schemaContext) - throws JSONException, IOException { - final JSONObject properties = new JSONObject(); + private ObjectNode processChildren( + final Iterable nodes, final String parentName, final ObjectNode models, + final boolean isConfig, final SchemaContext schemaContext) throws IOException { + final ObjectNode properties = JsonNodeFactory.instance.objectNode(); for (final DataSchemaNode node : nodes) { if (node.isConfiguration() == isConfig) { final String name = resolveNodesName(node, topLevelModule, schemaContext); - final JSONObject property; + final ObjectNode property; if (node instanceof LeafSchemaNode) { property = processLeafNode((LeafSchemaNode) node, schemaContext); @@ -326,15 +335,18 @@ public class ModelGenerator { property = processLeafListNode((LeafListSchemaNode) node, schemaContext); } else if (node instanceof ChoiceSchemaNode) { - if (((ChoiceSchemaNode) node).getCases().iterator().hasNext()) { - processChoiceNode(((ChoiceSchemaNode) node).getCases().iterator().next().getChildNodes(), - parentName, models, schemaContext, isConfig, properties); + if (((ChoiceSchemaNode) node).getCases().values().iterator().hasNext()) { + processChoiceNode(((ChoiceSchemaNode) node).getCases().values().iterator().next() + .getChildNodes(), parentName, models, schemaContext, isConfig, properties); } continue; } else if (node instanceof AnyXmlSchemaNode) { property = processAnyXMLNode((AnyXmlSchemaNode) node); + } else if (node instanceof AnyDataSchemaNode) { + property = processAnydataNode((AnyDataSchemaNode) node); + } else if (node instanceof ContainerSchemaNode) { property = processDataNodeContainer((ContainerSchemaNode) node, parentName, models, isConfig, schemaContext); @@ -342,40 +354,47 @@ public class ModelGenerator { } else { throw new IllegalArgumentException("Unknown DataSchemaNode type: " + node.getClass()); } - property.putOpt(DESCRIPTION_KEY, node.getDescription()); - properties.put(topLevelModule.getName() + ":" + name, property); + putIfNonNull(property, DESCRIPTION_KEY, node.getDescription().orElse(null)); + properties.set(topLevelModule.getName() + ":" + name, property); } } return properties; } - private JSONObject processLeafListNode(final LeafListSchemaNode listNode, final SchemaContext schemaContext) throws JSONException { - final JSONObject props = new JSONObject(); + private ObjectNode processLeafListNode(final LeafListSchemaNode listNode, + final SchemaContext schemaContext) { + final ObjectNode props = JsonNodeFactory.instance.objectNode(); props.put(TYPE_KEY, ARRAY_TYPE); - final JSONObject itemsVal = new JSONObject(); - final ConstraintDefinition constraints = listNode.getConstraints(); - final Optional maxOptional = Optional.fromNullable(constraints.getMaxElements()); - if (maxOptional.or(2) >= 2) { + final ObjectNode itemsVal = JsonNodeFactory.instance.objectNode(); + final Optional optConstraint = listNode.getElementCountConstraint(); + final int max; + if (optConstraint.isPresent()) { + final Integer constraintMax = optConstraint.get().getMaxElements(); + max = constraintMax == null ? 2 : constraintMax; + processElementCount(optConstraint.get(), props); + } else { + max = 2; + } + + if (max >= 2) { processTypeDef(listNode.getType(), listNode, itemsVal, schemaContext); processTypeDef(listNode.getType(), listNode, itemsVal, schemaContext); } else { processTypeDef(listNode.getType(), listNode, itemsVal, schemaContext); } - props.put(ITEMS_KEY, itemsVal); - - - processConstraints(constraints, props); + props.set(ITEMS_KEY, itemsVal); return props; } - private void processChoiceNode(final Iterable nodes, final String moduleName, final JSONObject models, - final SchemaContext schemaContext, final boolean isConfig, final JSONObject properties) - throws JSONException, IOException { + private void processChoiceNode( + final Iterable nodes, final String moduleName, final ObjectNode models, + final SchemaContext schemaContext, final boolean isConfig, final ObjectNode properties) + throws IOException { for (final DataSchemaNode node : nodes) { final String name = resolveNodesName(node, topLevelModule, schemaContext); - final JSONObject property; + final ObjectNode property; if (node instanceof LeafSchemaNode) { property = processLeafNode((LeafSchemaNode) node, schemaContext); @@ -388,14 +407,18 @@ public class ModelGenerator { property = processLeafListNode((LeafListSchemaNode) node, schemaContext); } else if (node instanceof ChoiceSchemaNode) { - if (((ChoiceSchemaNode) node).getCases().iterator().hasNext()) - processChoiceNode(((ChoiceSchemaNode) node).getCases().iterator().next().getChildNodes(), + if (((ChoiceSchemaNode) node).getCases().values().iterator().hasNext()) { + processChoiceNode(((ChoiceSchemaNode) node).getCases().values().iterator().next().getChildNodes(), moduleName, models, schemaContext, isConfig, properties); + } continue; } else if (node instanceof AnyXmlSchemaNode) { property = processAnyXMLNode((AnyXmlSchemaNode) node); + } else if (node instanceof AnyDataSchemaNode) { + property = processAnydataNode((AnyDataSchemaNode) node); + } else if (node instanceof ContainerSchemaNode) { property = processDataNodeContainer((ContainerSchemaNode) node, moduleName, models, isConfig, schemaContext); @@ -404,43 +427,58 @@ public class ModelGenerator { throw new IllegalArgumentException("Unknown DataSchemaNode type: " + node.getClass()); } - property.putOpt(DESCRIPTION_KEY, node.getDescription()); - properties.put(name, property); + putIfNonNull(property, DESCRIPTION_KEY, node.getDescription().orElse(null)); + properties.set(name, property); } } - private static void processConstraints(final ConstraintDefinition constraints, final JSONObject props) throws JSONException { - final boolean isMandatory = constraints.isMandatory(); - props.put(REQUIRED_KEY, isMandatory); - - final Integer minElements = constraints.getMinElements(); - final Integer maxElements = constraints.getMaxElements(); + private static void processElementCount(final ElementCountConstraint constraint, final ObjectNode props) { + final Integer minElements = constraint.getMinElements(); if (minElements != null) { props.put(MIN_ITEMS, minElements); } + final Integer maxElements = constraint.getMaxElements(); if (maxElements != null) { props.put(MAX_ITEMS, maxElements); } } - private JSONObject processLeafNode(final LeafSchemaNode leafNode, final SchemaContext schemaContext) throws JSONException { - final JSONObject property = new JSONObject(); + private static void processMandatory(final MandatoryAware node, final ObjectNode props) { + props.put(REQUIRED_KEY, node.isMandatory()); + } + + private ObjectNode processLeafNode(final LeafSchemaNode leafNode, + final SchemaContext schemaContext) { + final ObjectNode property = JsonNodeFactory.instance.objectNode(); - final String leafDescription = leafNode.getDescription(); - property.put(DESCRIPTION_KEY, leafDescription); - processConstraints(leafNode.getConstraints(), property); + final String leafDescription = leafNode.getDescription().orElse(null); + putIfNonNull(property, DESCRIPTION_KEY, leafDescription); + processMandatory(leafNode, property); processTypeDef(leafNode.getType(), leafNode, property, schemaContext); return property; } - private static JSONObject processAnyXMLNode(final AnyXmlSchemaNode leafNode) throws JSONException { - final JSONObject property = new JSONObject(); + private static ObjectNode processAnydataNode(final AnyDataSchemaNode leafNode) { + final ObjectNode property = JsonNodeFactory.instance.objectNode(); + + final String leafDescription = leafNode.getDescription().orElse(null); + putIfNonNull(property, DESCRIPTION_KEY, leafDescription); + + processMandatory(leafNode, property); + final String localName = leafNode.getQName().getLocalName(); + property.put(TYPE_KEY, "example of anydata " + localName); + + return property; + } + + private static ObjectNode processAnyXMLNode(final AnyXmlSchemaNode leafNode) { + final ObjectNode property = JsonNodeFactory.instance.objectNode(); - final String leafDescription = leafNode.getDescription(); - property.put(DESCRIPTION_KEY, leafDescription); + final String leafDescription = leafNode.getDescription().orElse(null); + putIfNonNull(property, DESCRIPTION_KEY, leafDescription); - processConstraints(leafNode.getConstraints(), property); + processMandatory(leafNode, property); final String localName = leafNode.getQName().getLocalName(); property.put(TYPE_KEY, "example of anyxml " + localName); @@ -448,7 +486,7 @@ public class ModelGenerator { } private String processTypeDef(final TypeDefinition leafTypeDef, final DataSchemaNode node, - final JSONObject property, final SchemaContext schemaContext) throws JSONException { + final ObjectNode property, final SchemaContext schemaContext) { final String jsonType; if (leafTypeDef.getDefaultValue() == null) { if (leafTypeDef instanceof BinaryTypeDefinition) { @@ -462,7 +500,8 @@ public class ModelGenerator { } else if (leafTypeDef instanceof IdentityrefTypeDefinition) { final String name = topLevelModule.getName(); - jsonType = name + ":" + ((IdentityrefTypeDefinition) leafTypeDef).getIdentity().getQName().getLocalName(); + jsonType = name + ":" + ((IdentityrefTypeDefinition) leafTypeDef).getIdentities().iterator().next() + .getQName().getLocalName(); } else if (leafTypeDef instanceof StringTypeDefinition) { jsonType = processStringType(leafTypeDef, property, node.getQName().getLocalName()); @@ -479,17 +518,11 @@ public class ModelGenerator { } else if (leafTypeDef instanceof BooleanTypeDefinition) { jsonType = "true"; - } else if (leafTypeDef instanceof DecimalTypeDefinition) { - jsonType = String.valueOf(((DecimalTypeDefinition) leafTypeDef).getRangeConstraints() - .iterator().next().getMin()); - - } else if (leafTypeDef instanceof IntegerTypeDefinition) { - jsonType = String.valueOf(((IntegerTypeDefinition) leafTypeDef).getRangeConstraints() - .iterator().next().getMin()); - - } else if (leafTypeDef instanceof UnsignedIntegerTypeDefinition) { - jsonType = String.valueOf(((UnsignedIntegerTypeDefinition) leafTypeDef).getRangeConstraints() - .iterator().next().getMin()); + } else if (leafTypeDef instanceof RangeRestrictedTypeDefinition) { + final Number maybeLower = ((RangeRestrictedTypeDefinition) leafTypeDef).getRangeConstraint() + .map(RangeConstraint::getAllowedRanges).map(RangeSet::span).map(Range::lowerEndpoint) + .orElse(null); + jsonType = String.valueOf(maybeLower); } else { jsonType = OBJECT_TYPE; @@ -498,85 +531,86 @@ public class ModelGenerator { } else { jsonType = String.valueOf(leafTypeDef.getDefaultValue()); } - property.putOpt(TYPE_KEY, jsonType); + putIfNonNull(property, TYPE_KEY, jsonType); return jsonType; } - private String processLeafRef(final DataSchemaNode node, final JSONObject property, final SchemaContext schemaContext, - final TypeDefinition leafTypeDef) { - RevisionAwareXPath xPath = ((LeafrefTypeDefinition) leafTypeDef).getPathStatement(); + private String processLeafRef(final DataSchemaNode node, final ObjectNode property, + final SchemaContext schemaContext, final TypeDefinition leafTypeDef) { + RevisionAwareXPath xpath = ((LeafrefTypeDefinition) leafTypeDef).getPathStatement(); final SchemaNode schemaNode; - final String xPathString = STRIP_PATTERN.matcher(xPath.toString()).replaceAll(""); - xPath = new RevisionAwareXPathImpl(xPathString, xPath.isAbsolute()); + final String xPathString = STRIP_PATTERN.matcher(xpath.toString()).replaceAll(""); + xpath = new RevisionAwareXPathImpl(xPathString, xpath.isAbsolute()); final Module module; - if (xPath.isAbsolute()) { + if (xpath.isAbsolute()) { module = findModule(schemaContext, leafTypeDef.getQName()); - schemaNode = SchemaContextUtil.findDataSchemaNode(schemaContext, module, xPath); + schemaNode = SchemaContextUtil.findDataSchemaNode(schemaContext, module, xpath); } else { module = findModule(schemaContext, node.getQName()); - schemaNode = SchemaContextUtil.findDataSchemaNodeForRelativeXPath(schemaContext, module, node, xPath); + schemaNode = SchemaContextUtil.findDataSchemaNodeForRelativeXPath(schemaContext, module, node, xpath); } - return processTypeDef(((TypedSchemaNode) schemaNode).getType(), (DataSchemaNode) schemaNode, property, schemaContext); + return processTypeDef(((TypedDataSchemaNode) schemaNode).getType(), (DataSchemaNode) schemaNode, + property, schemaContext); } - private static Module findModule(final SchemaContext schemaContext, final QName qName) { - return schemaContext.findModuleByNamespaceAndRevision(qName.getNamespace(), qName.getRevision()); + private static Module findModule(final SchemaContext schemaContext, final QName qualifiedName) { + return schemaContext.findModule(qualifiedName.getNamespace(), qualifiedName.getRevision()).orElse(null); } - private static String processBinaryType(final JSONObject property) throws JSONException { - final JSONObject media = new JSONObject(); + private static String processBinaryType(final ObjectNode property) { + final ObjectNode media = JsonNodeFactory.instance.objectNode(); media.put(BINARY_ENCODING_KEY, BASE_64); - property.put(MEDIA_KEY, media); + property.set(MEDIA_KEY, media); return "bin1 bin2"; } - private static String processEnumType(final EnumTypeDefinition enumLeafType, final JSONObject property) throws JSONException { + private static String processEnumType(final EnumTypeDefinition enumLeafType, + final ObjectNode property) { final List enumPairs = enumLeafType.getValues(); - final List enumNames = new ArrayList<>(); + ArrayNode enumNames = new ArrayNode(JsonNodeFactory.instance); for (final EnumPair enumPair : enumPairs) { - enumNames.add(enumPair.getName()); + enumNames.add(new TextNode(enumPair.getName())); } - property.putOpt(ENUM, new JSONArray(enumNames)); + property.set(ENUM, enumNames); return enumLeafType.getValues().iterator().next().getName(); } - private static String processBitsType(final BitsTypeDefinition bitsType, final JSONObject property) throws JSONException { + private static String processBitsType(final BitsTypeDefinition bitsType, + final ObjectNode property) { property.put(MIN_ITEMS, 0); property.put(UNIQUE_ITEMS_KEY, true); - final List enumNames = new ArrayList<>(); + ArrayNode enumNames = new ArrayNode(JsonNodeFactory.instance); final List bits = bitsType.getBits(); for (final Bit bit : bits) { - enumNames.add(bit.getName()); + enumNames.add(new TextNode(bit.getName())); } - property.put(ENUM, new JSONArray(enumNames)); + property.set(ENUM, enumNames); return enumNames.iterator().next() + " " + enumNames.get(enumNames.size() - 1); } - private static String processStringType(final TypeDefinition stringType, final JSONObject property, final String nodeName) - throws JSONException { + private static String processStringType(final TypeDefinition stringType, + final ObjectNode property, final String nodeName) { StringTypeDefinition type = (StringTypeDefinition) stringType; - List lengthConstraints = ((StringTypeDefinition) stringType).getLengthConstraints(); - while (lengthConstraints.isEmpty() && type.getBaseType() != null) { + Optional lengthConstraints = ((StringTypeDefinition) stringType).getLengthConstraint(); + while (!lengthConstraints.isPresent() && type.getBaseType() != null) { type = type.getBaseType(); - lengthConstraints = type.getLengthConstraints(); + lengthConstraints = type.getLengthConstraint(); } - // FIXME: json-schema is not expressive enough to capture min/max laternatives. We should find the true minimum - // and true maximum implied by the constraints and use that. - for (final LengthConstraint lengthConstraint : lengthConstraints) { - final Number min = lengthConstraint.getMin(); - final Number max = lengthConstraint.getMax(); - property.putOpt(MIN_LENGTH_KEY, min); - property.putOpt(MAX_LENGTH_KEY, max); + if (lengthConstraints.isPresent()) { + final Range range = lengthConstraints.get().getAllowedRanges().span(); + putIfNonNull(property, MIN_LENGTH_KEY, range.lowerEndpoint()); + putIfNonNull(property, MAX_LENGTH_KEY, range.upperEndpoint()); } + if (type.getPatternConstraints().iterator().hasNext()) { final PatternConstraint pattern = type.getPatternConstraints().iterator().next(); - String regex = pattern.getRegularExpression(); + String regex = pattern.getJavaPatternString(); regex = regex.substring(1, regex.length() - 1); final Generex generex = new Generex(regex); return generex.random(); @@ -585,25 +619,46 @@ public class ModelGenerator { } } - private String processUnionType(final UnionTypeDefinition unionType, final JSONObject property, - final SchemaContext schemaContext, final DataSchemaNode node) - throws JSONException { - final List unionNames = new ArrayList<>(); + private String processUnionType(final UnionTypeDefinition unionType, final ObjectNode property, + final SchemaContext schemaContext, final DataSchemaNode node) { + final ArrayNode unionNames = new ArrayNode(JsonNodeFactory.instance); for (final TypeDefinition typeDef : unionType.getTypes()) { unionNames.add(processTypeDef(typeDef, node, property, schemaContext)); } - property.put(ENUM, new JSONArray(unionNames)); - return unionNames.iterator().next(); + property.set(ENUM, unionNames); + return unionNames.iterator().next().asText(); } /** * Helper method to generate a pre-filled JSON schema object. */ - private static JSONObject getSchemaTemplate() throws JSONException { - final JSONObject schemaJSON = new JSONObject(); + private static ObjectNode getSchemaTemplate() { + final ObjectNode schemaJSON = JsonNodeFactory.instance.objectNode(); schemaJSON.put(SCHEMA_KEY, SCHEMA_URL); return schemaJSON; } + private static void putIfNonNull(final ObjectNode property, final String key, final Number number) { + if (key != null && number != null) { + if (number instanceof Double) { + property.put(key, (Double) number); + } else if (number instanceof Float) { + property.put(key, (Float) number); + } else if (number instanceof Integer) { + property.put(key, (Integer) number); + } else if (number instanceof Short) { + property.put(key, (Short) number); + } else if (number instanceof Long) { + property.put(key, (Long) number); + } + } + } + + private static void putIfNonNull(final ObjectNode property, final String key, final String value) { + if (key != null && value != null) { + property.put(key, value); + } + } + } \ No newline at end of file