Rename JsonMetaSchema to Dialect

Author: justin-tay

src/main/java/com/networknt/schema/DefaultJsonMetaSchemaFactory.java

@@ -26,7 +26,7 @@
  */
 public class DefaultJsonMetaSchemaFactory implements JsonMetaSchemaFactory {
     @Override
-    public JsonMetaSchema getMetaSchema(String iri, JsonSchemaFactory schemaFactory, SchemaValidatorsConfig config) {
+    public Dialect getMetaSchema(String iri, JsonSchemaFactory schemaFactory, SchemaValidatorsConfig config) {
         // Is it a well-known dialect?
         return Specification.Version.fromDialectId(iri)
                 .map(JsonSchemaFactory::checkVersion)
@@ -37,10 +37,10 @@ public JsonMetaSchema getMetaSchema(String iri, JsonSchemaFactory schemaFactory,
                 });
     }
 
-    protected JsonMetaSchema loadMetaSchema(String iri, JsonSchemaFactory schemaFactory,
+    protected Dialect loadMetaSchema(String iri, JsonSchemaFactory schemaFactory,
             SchemaValidatorsConfig config) {
         try {
-            JsonMetaSchema result = loadMetaSchemaBuilder(iri, schemaFactory, config).build();
+            Dialect result = loadMetaSchemaBuilder(iri, schemaFactory, config).build();
             return result;
         } catch (InvalidSchemaException e) {
             throw e;
@@ -51,10 +51,10 @@ protected JsonMetaSchema loadMetaSchema(String iri, JsonSchemaFactory schemaFact
         }
     }
 
-    protected JsonMetaSchema.Builder loadMetaSchemaBuilder(String iri, JsonSchemaFactory schemaFactory,
+    protected Dialect.Builder loadMetaSchemaBuilder(String iri, JsonSchemaFactory schemaFactory,
             SchemaValidatorsConfig config) {
         JsonSchema schema = schemaFactory.getSchema(SchemaLocation.of(iri), config);
-        JsonMetaSchema.Builder builder = JsonMetaSchema.builder(iri, schema.getValidationContext().getMetaSchema());
+        Dialect.Builder builder = Dialect.builder(iri, schema.getValidationContext().getMetaSchema());
         Version specification = schema.getValidationContext().getMetaSchema().getSpecification();
         if (specification != null) {
             if (specification.getOrder() >= Version.DRAFT_2019_09.getOrder()) {

…com/networknt/schema/JsonMetaSchema.java …n/java/com/networknt/schema/Dialect.javasrc/main/java/com/networknt/schema/JsonMetaSchema.java renamed to src/main/java/com/networknt/schema/Dialect.java src/main/java/com/networknt/schema/JsonMetaSchema.java renamed to src/main/java/com/networknt/schema/Dialect.java

@@ -37,10 +37,13 @@
 import java.util.function.Consumer;
 
 /**
- * Represents a meta-schema which is uniquely identified by its IRI.
+ * A dialect represents the set of keywords and semantics that can be used to
+ * evaluate a schema. The dialect can be uniquely identified by its IRI which
+ * points to the meta-schema used to validate schemas written for that dialect.
+ * The dialect for a particular schema is indicated using the $schema keyword.
  */
-public class JsonMetaSchema {
-    private static final Logger logger = LoggerFactory.getLogger(JsonMetaSchema.class);
+public class Dialect {
+    private static final Logger logger = LoggerFactory.getLogger(Dialect.class);
 
     /**
      * Factory for creating a format keyword.
@@ -56,7 +59,7 @@ public interface FormatKeywordFactory {
     }
 
     /**
-     * Builder for {@link JsonMetaSchema}. 
+     * Builder for {@link Dialect}. 
      */
     public static class Builder {
         private String iri;
@@ -269,7 +272,7 @@ public Builder idKeyword(String idKeyword) {
             return this;
         }
 
-        public JsonMetaSchema build() {
+        public Dialect build() {
             // create builtin keywords with (custom) formats.
             Map<String, Keyword> keywords = this.keywords;
             if (this.specification != null) {
@@ -298,7 +301,7 @@ public JsonMetaSchema build() {
                 }
             }
             Map<String, Keyword> result = createKeywordsMap(keywords, this.formats);
-            return new JsonMetaSchema(this.iri, this.idKeyword, result, this.vocabularies, this.specification, this);
+            return new Dialect(this.iri, this.idKeyword, result, this.vocabularies, this.specification, this);
         }
 
         @Deprecated
@@ -330,7 +333,7 @@ public Builder addFormats(Collection<? extends Format> formats) {
 
     private final Builder builder;
 
-    JsonMetaSchema(String iri, String idKeyword, Map<String, Keyword> keywords, Map<String, Boolean> vocabularies, Version specification, Builder builder) {
+    Dialect(String iri, String idKeyword, Map<String, Keyword> keywords, Map<String, Boolean> vocabularies, Version specification, Builder builder) {
         if (StringUtils.isBlank(iri)) {
             throw new IllegalArgumentException("iri must not be null or blank");
         }
@@ -349,23 +352,23 @@ public Builder addFormats(Collection<? extends Format> formats) {
         this.builder = builder;
     }
 
-    public static JsonMetaSchema getV4() {
+    public static Dialect getV4() {
         return new Version4().getInstance();
     }
 
-    public static JsonMetaSchema getV6() {
+    public static Dialect getV6() {
         return new Version6().getInstance();
     }
 
-    public static JsonMetaSchema getV7() {
+    public static Dialect getV7() {
         return new Version7().getInstance();
     }
 
-    public static JsonMetaSchema getV201909() {
+    public static Dialect getV201909() {
         return new Version201909().getInstance();
     }
 
-    public static JsonMetaSchema getV202012() {
+    public static Dialect getV202012() {
         return new Version202012().getInstance();
     }
 
@@ -394,7 +397,7 @@ public static Builder builder(String iri) {
      * @return a builder instance preconfigured to be the same as blueprint, but
      *         with a different uri.
      */
-    public static Builder builder(String iri, JsonMetaSchema blueprint) {
+    public static Builder builder(String iri, Dialect blueprint) {
         Builder builder = builder(blueprint);
         builder.iri = iri;
         return builder;
@@ -406,7 +409,7 @@ public static Builder builder(String iri, JsonMetaSchema blueprint) {
      * @param blueprint the JsonMetaSchema to base your custom JsonMetaSchema on.
      * @return a builder instance preconfigured to be the same as blueprint
      */
-    public static Builder builder(JsonMetaSchema blueprint) {
+    public static Builder builder(Dialect blueprint) {
         Map<String, Boolean> vocabularies = new HashMap<>(blueprint.getVocabularies());
         return builder(blueprint.getIri())
                 .idKeyword(blueprint.idKeyword)
@@ -533,7 +536,7 @@ public boolean equals(Object obj) {
             return false;
         if (getClass() != obj.getClass())
             return false;
-        JsonMetaSchema other = (JsonMetaSchema) obj;
+        Dialect other = (Dialect) obj;
         return Objects.equals(iri, other.iri);
     }
 }

src/main/java/com/networknt/schema/DisallowUnknownJsonMetaSchemaFactory.java

@@ -21,7 +21,7 @@
  */
 public class DisallowUnknownJsonMetaSchemaFactory implements JsonMetaSchemaFactory {
     @Override
-    public JsonMetaSchema getMetaSchema(String iri, JsonSchemaFactory schemaFactory, SchemaValidatorsConfig config) {
+    public Dialect getMetaSchema(String iri, JsonSchemaFactory schemaFactory, SchemaValidatorsConfig config) {
         throw new InvalidSchemaException(Error.builder()
                 .message("Unknown meta-schema ''{0}''. Only meta-schemas that are explicitly configured can be used.")
                 .arguments(iri).build());

src/main/java/com/networknt/schema/JsonMetaSchemaFactory.java

@@ -16,7 +16,7 @@
 package com.networknt.schema;
 
 /**
- * Factory for {@link JsonMetaSchema}.
+ * Factory for {@link Dialect}.
  */
 @FunctionalInterface
 public interface JsonMetaSchemaFactory {
@@ -28,5 +28,5 @@ public interface JsonMetaSchemaFactory {
      * @param config the config
      * @return the meta-schema
      */
-    JsonMetaSchema getMetaSchema(String iri, JsonSchemaFactory schemaFactory, SchemaValidatorsConfig config);
+    Dialect getMetaSchema(String iri, JsonSchemaFactory schemaFactory, SchemaValidatorsConfig config);
 }

src/main/java/com/networknt/schema/JsonSchemaFactory.java

@@ -57,7 +57,7 @@ public static class Builder {
         private ObjectMapper yamlMapper = null;
         private JsonNodeReader jsonNodeReader = null;
         private String defaultMetaSchemaIri;
-        private final ConcurrentMap<String, JsonMetaSchema> metaSchemas = new ConcurrentHashMap<>();
+        private final ConcurrentMap<String, Dialect> metaSchemas = new ConcurrentHashMap<>();
         private SchemaLoaders.Builder schemaLoadersBuilder = null;
         private SchemaMappers.Builder schemaMappersBuilder = null;
         private boolean enableSchemaCache = true;
@@ -120,19 +120,19 @@ public Builder metaSchemaFactory(final JsonMetaSchemaFactory jsonMetaSchemaFacto
             return this;
         }
 
-        public Builder metaSchema(final JsonMetaSchema jsonMetaSchema) {
+        public Builder metaSchema(final Dialect jsonMetaSchema) {
             this.metaSchemas.put(normalizeMetaSchemaUri(jsonMetaSchema.getIri()), jsonMetaSchema);
             return this;
         }
 
-        public Builder metaSchemas(final Collection<? extends JsonMetaSchema> jsonMetaSchemas) {
-            for (JsonMetaSchema jsonMetaSchema : jsonMetaSchemas) {
+        public Builder metaSchemas(final Collection<? extends Dialect> jsonMetaSchemas) {
+            for (Dialect jsonMetaSchema : jsonMetaSchemas) {
                 metaSchema(jsonMetaSchema);
             }
             return this;
         }
 
-        public Builder metaSchemas(Consumer<Map<String, JsonMetaSchema>> customizer) {
+        public Builder metaSchemas(Consumer<Map<String, Dialect>> customizer) {
             customizer.accept(this.metaSchemas);
             return this;
         }
@@ -159,12 +159,12 @@ public Builder schemaMappers(Consumer<SchemaMappers.Builder> schemaMappersBuilde
         }
 
         @Deprecated
-        public Builder addMetaSchema(final JsonMetaSchema jsonMetaSchema) {
+        public Builder addMetaSchema(final Dialect jsonMetaSchema) {
             return metaSchema(jsonMetaSchema);
         }
 
         @Deprecated
-        public Builder addMetaSchemas(final Collection<? extends JsonMetaSchema> jsonMetaSchemas) {
+        public Builder addMetaSchemas(final Collection<? extends Dialect> jsonMetaSchemas) {
             return metaSchemas(jsonMetaSchemas);
         }
 
@@ -190,7 +190,7 @@ public JsonSchemaFactory build() {
     private final SchemaLoaders.Builder schemaLoadersBuilder;
     private final SchemaMappers.Builder schemaMappersBuilder;
     private final SchemaLoader schemaLoader;
-    private final ConcurrentMap<String, JsonMetaSchema> metaSchemas;
+    private final ConcurrentMap<String, Dialect> metaSchemas;
     private final ConcurrentMap<SchemaLocation, JsonSchema> schemaCache = new ConcurrentHashMap<>();
     private final boolean enableSchemaCache;
     private final JsonMetaSchemaFactory metaSchemaFactory;
@@ -205,7 +205,7 @@ private JsonSchemaFactory(
             String defaultMetaSchemaIri,
             SchemaLoaders.Builder schemaLoadersBuilder,
             SchemaMappers.Builder schemaMappersBuilder,
-            ConcurrentMap<String, JsonMetaSchema> metaSchemas,
+            ConcurrentMap<String, Dialect> metaSchemas,
             boolean enableSchemaCache,
             JsonMetaSchemaFactory metaSchemaFactory) {
         this.metaSchemas = metaSchemas;
@@ -266,7 +266,7 @@ public static JsonSchemaFactory getInstance(Specification.Version versionFlag) {
     public static JsonSchemaFactory getInstance(Specification.Version versionFlag,
             Consumer<JsonSchemaFactory.Builder> customizer) {
         JsonSchemaVersion jsonSchemaVersion = checkVersion(versionFlag);
-        JsonMetaSchema metaSchema = jsonSchemaVersion.getInstance();
+        Dialect metaSchema = jsonSchemaVersion.getInstance();
         JsonSchemaFactory.Builder builder = builder().defaultMetaSchemaIri(metaSchema.getIri())
                 .metaSchema(metaSchema);
         if (customizer != null) {
@@ -384,7 +384,7 @@ private JsonSchema doCreate(ValidationContext validationContext, SchemaLocation
      * @return the validation context to use
      */
     private ValidationContext withMetaSchema(ValidationContext validationContext, JsonNode schemaNode) {
-        JsonMetaSchema metaSchema = getMetaSchema(schemaNode, validationContext.getConfig());
+        Dialect metaSchema = getMetaSchema(schemaNode, validationContext.getConfig());
         if (metaSchema != null && !metaSchema.getIri().equals(validationContext.getMetaSchema().getIri())) {
             SchemaValidatorsConfig config = validationContext.getConfig();
             if (metaSchema.getKeywords().containsKey("discriminator") && !config.isDiscriminatorKeywordEnabled()) {
@@ -415,7 +415,7 @@ protected SchemaLocation getSchemaLocation(SchemaLocation schemaLocation) {
     }
 
     protected ValidationContext createValidationContext(final JsonNode schemaNode, SchemaValidatorsConfig config) {
-        final JsonMetaSchema jsonMetaSchema = getMetaSchemaOrDefault(schemaNode, config);
+        final Dialect jsonMetaSchema = getMetaSchemaOrDefault(schemaNode, config);
         SchemaValidatorsConfig configResult = config;
         if (jsonMetaSchema.getKeywords().containsKey("discriminator") && !config.isDiscriminatorKeywordEnabled()) {
             configResult = SchemaValidatorsConfig.builder(config)
@@ -426,17 +426,17 @@ protected ValidationContext createValidationContext(final JsonNode schemaNode, S
         return new ValidationContext(jsonMetaSchema, this, configResult);
     }
 
-    private JsonMetaSchema getMetaSchema(final JsonNode schemaNode, SchemaValidatorsConfig config) {
+    private Dialect getMetaSchema(final JsonNode schemaNode, SchemaValidatorsConfig config) {
         final JsonNode iriNode = schemaNode.get("$schema");
         if (iriNode != null && iriNode.isTextual()) {
-            JsonMetaSchema result = metaSchemas.computeIfAbsent(normalizeMetaSchemaUri(iriNode.textValue()),
+            Dialect result = metaSchemas.computeIfAbsent(normalizeMetaSchemaUri(iriNode.textValue()),
                     id -> loadMetaSchema(id, config));
             return result;
         }
         return null;
     }
 
-    private JsonMetaSchema getMetaSchemaOrDefault(final JsonNode schemaNode, SchemaValidatorsConfig config) {
+    private Dialect getMetaSchemaOrDefault(final JsonNode schemaNode, SchemaValidatorsConfig config) {
         final JsonNode iriNode = schemaNode.get("$schema");
         if (iriNode != null && !iriNode.isNull() && !iriNode.isTextual()) {
             throw new JsonSchemaException("Unknown MetaSchema: " + iriNode);
@@ -452,9 +452,9 @@ private JsonMetaSchema getMetaSchemaOrDefault(final JsonNode schemaNode, SchemaV
      * @param config the schema validators config
      * @return the meta-schema
      */
-    public JsonMetaSchema getMetaSchema(String iri, SchemaValidatorsConfig config) {
+    public Dialect getMetaSchema(String iri, SchemaValidatorsConfig config) {
         String key = normalizeMetaSchemaUri(iri);
-        JsonMetaSchema result =  metaSchemas.computeIfAbsent(key, id -> loadMetaSchema(id, config));
+        Dialect result =  metaSchemas.computeIfAbsent(key, id -> loadMetaSchema(id, config));
         return result;
     }
 
@@ -465,7 +465,7 @@ public JsonMetaSchema getMetaSchema(String iri, SchemaValidatorsConfig config) {
      * @param config the schema validators config
      * @return the meta-schema
      */
-    protected JsonMetaSchema loadMetaSchema(String iri, SchemaValidatorsConfig config) {
+    protected Dialect loadMetaSchema(String iri, SchemaValidatorsConfig config) {
         return this.metaSchemaFactory != null ? this.metaSchemaFactory.getMetaSchema(iri, this, config)
                 : DefaultJsonMetaSchemaFactory.getInstance().getMetaSchema(iri, this, config);
     }
@@ -678,7 +678,7 @@ protected JsonSchema getMappedSchema(final SchemaLocation schemaUri, SchemaValid
                 schemaNode = readTree(inputStream, InputFormat.JSON);
             }
 
-            final JsonMetaSchema jsonMetaSchema = getMetaSchemaOrDefault(schemaNode, config);
+            final Dialect jsonMetaSchema = getMetaSchemaOrDefault(schemaNode, config);
             JsonNodePath evaluationPath = new JsonNodePath(config.getPathType());
             if (schemaUri.getFragment() == null
                     || schemaUri.getFragment().getNameCount() == 0) {

src/main/java/com/networknt/schema/JsonSchemaVersion.java

@@ -24,5 +24,5 @@ public interface JsonSchemaVersion {
      * 
      * @return the instance
      */
-    JsonMetaSchema getInstance();
+    Dialect getInstance();
 }

src/main/java/com/networknt/schema/ValidationContext.java

@@ -25,19 +25,19 @@
 import com.networknt.schema.keyword.KeywordValidator;
 
 public class ValidationContext {
-    private final JsonMetaSchema metaSchema;
+    private final Dialect metaSchema;
     private final JsonSchemaFactory jsonSchemaFactory;
     private final SchemaValidatorsConfig config;
     private final ConcurrentMap<String, JsonSchema> schemaReferences;
     private final ConcurrentMap<String, JsonSchema> schemaResources;
     private final ConcurrentMap<String, JsonSchema> dynamicAnchors;
 
-    public ValidationContext(JsonMetaSchema metaSchema,
+    public ValidationContext(Dialect metaSchema,
                              JsonSchemaFactory jsonSchemaFactory, SchemaValidatorsConfig config) {
         this(metaSchema, jsonSchemaFactory, config, new ConcurrentHashMap<>(), new ConcurrentHashMap<>(), new ConcurrentHashMap<>());
     }
 
-    public ValidationContext(JsonMetaSchema metaSchema, JsonSchemaFactory jsonSchemaFactory,
+    public ValidationContext(Dialect metaSchema, JsonSchemaFactory jsonSchemaFactory,
             SchemaValidatorsConfig config, ConcurrentMap<String, JsonSchema> schemaReferences,
             ConcurrentMap<String, JsonSchema> schemaResources, ConcurrentMap<String, JsonSchema> dynamicAnchors) {
         if (metaSchema == null) {
@@ -103,7 +103,7 @@ public ConcurrentMap<String, JsonSchema> getDynamicAnchors() {
         return this.dynamicAnchors;
     }
 
-    public JsonMetaSchema getMetaSchema() {
+    public Dialect getMetaSchema() {
         return this.metaSchema;
     }
 

src/main/java/com/networknt/schema/Version201909.java

@@ -27,9 +27,9 @@ public class Version201909 implements JsonSchemaVersion {
     }
 
     private static class Holder {
-        private static final JsonMetaSchema INSTANCE;
+        private static final Dialect INSTANCE;
         static {
-            INSTANCE = JsonMetaSchema.builder(IRI)
+            INSTANCE = Dialect.builder(IRI)
                     .specification(Specification.Version.DRAFT_2019_09)
                     .idKeyword(ID)
                     .formats(Formats.DEFAULT)
@@ -44,7 +44,7 @@ private static class Holder {
     }
 
     @Override
-    public JsonMetaSchema getInstance() {
+    public Dialect getInstance() {
         return Holder.INSTANCE;
     }
 }

src/main/java/com/networknt/schema/Version202012.java

@@ -28,9 +28,9 @@ public class Version202012 implements JsonSchemaVersion {
     }
 
     private static class Holder {
-        private static final JsonMetaSchema INSTANCE;
+        private static final Dialect INSTANCE;
         static {
-            INSTANCE = JsonMetaSchema.builder(IRI)
+            INSTANCE = Dialect.builder(IRI)
                     .specification(Specification.Version.DRAFT_2020_12)
                     .idKeyword(ID)
                     .formats(Formats.DEFAULT)
@@ -45,7 +45,7 @@ private static class Holder {
     }
 
     @Override
-    public JsonMetaSchema getInstance() {
+    public Dialect getInstance() {
         return Holder.INSTANCE;
     }
 }