Changes for adding collector context

Author: prashanth-chaitanya

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

@@ -0,0 +1,13 @@
+package com.networknt.schema;
+
+/**
+ * Basic interface that allows the implementers to collect the information and
+ * return it.
+ *
+ * @param <E>
+ */
+public interface Collector<E> {
+
+	public E collect();
+
+}

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

@@ -0,0 +1,53 @@
+package com.networknt.schema;
+
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Map.Entry;
+
+/**
+ * A Single Context for holding the output returned by the {@link Collector} implementations.
+ *
+ */
+public enum CollectorContext {
+
+	INSTANCE;
+
+	/**
+	 * Map for holding the collector type and {@link Collector}
+	 */
+	private Map<String, Collector<?>> collectorMap = new HashMap<>();
+
+	/**
+	 * Map for holding the collector type and {@link Collector} class collect method output.
+	 */
+	private Map<String, Object> collectorLoadMap = new HashMap<>();
+
+	public <E> void add(String collectorType, Collector<E> collector) {
+		collectorMap.put(collectorType, collector);
+	}
+
+	public Object get(String collectorType) {
+		if (collectorLoadMap.get(collectorType) == null && collectorMap.get(collectorType) != null) {
+			collectorLoadMap.put(collectorType, collectorMap.get(collectorType).collect());
+		}
+		return collectorLoadMap.get(collectorType);
+	}
+
+	/**
+	 * Load all the collectors associated with the context.
+	 */
+	void load() {
+		for (Entry<String, Collector<?>> collectorEntrySet : collectorMap.entrySet()) {
+			collectorLoadMap.put(collectorEntrySet.getKey(), collectorEntrySet.getValue().collect());
+		}
+	}
+
+	/**
+	 * Reset the context
+	 */
+	void reset() {
+		this.collectorMap = new HashMap<String, Collector<?>>();
+		this.collectorLoadMap = new HashMap<String, Object>();
+	}
+
+}

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

@@ -169,14 +169,35 @@ private Map<String, JsonValidator> read(JsonNode schemaNode) {
         return validators;
     }
 
-    public Set<ValidationMessage> validate(JsonNode jsonNode, JsonNode rootNode, String at) {
-        Set<ValidationMessage> errors = new LinkedHashSet<ValidationMessage>();
-        for (JsonValidator v : validators.values()) {
-            errors.addAll(v.validate(jsonNode, rootNode, at));
-        }
-        return errors;
+	public Set<ValidationMessage> validate(JsonNode jsonNode, JsonNode rootNode, String at) {
+		Set<ValidationMessage> errors = new LinkedHashSet<ValidationMessage>();
+		for (JsonValidator v : validators.values()) {
+			errors.addAll(v.validate(jsonNode, rootNode, at));
+		}
+		return errors;
+	}
+    
+    public Set<ValidationMessage> validateAndCollect(JsonNode node) {
+        return validateAndCollect(node, node, AT_ROOT);
     }
 
+    
+	/**
+	 * 
+	 * This method both validates and collects the data in a CollectionContext
+	 * @param jsonNode
+	 * @param rootNode
+	 * @param at
+	 * @return
+	 */
+	protected Set<ValidationMessage> validateAndCollect(JsonNode jsonNode, JsonNode rootNode, String at) {
+		CollectorContext collectorContext = CollectorContext.INSTANCE;
+		collectorContext.reset();
+		Set<ValidationMessage> errors = validate(jsonNode, rootNode, at);
+		collectorContext.load();
+		return errors;
+	}
+
     @Override
     public String toString() {
         return "\"" + getSchemaPath() + "\" : " + getSchemaNode().toString();
@@ -189,4 +210,5 @@ public boolean hasRequiredValidator() {
 	public JsonValidator getRequiredValidator() {
 		return requiredValidator;
 	}
+
 }

src/test/java/com/networknt/schema/CollectorContextTest.java

@@ -0,0 +1,84 @@
+package com.networknt.schema;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Set;
+import java.util.TreeSet;
+
+import org.junit.Assert;
+import org.junit.Test;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+public class CollectorContextTest {
+
+	private static final String SAMPLE_COLLECTOR_TYPE = "sampleCollectorType";
+
+	private class ReferenceTypesKeyWord implements Keyword {
+		@Override
+		public String getValue() {
+			return "reference-content-types";
+		}
+
+		@Override
+		public JsonValidator newValidator(String schemaPath, JsonNode schemaNode, JsonSchema parentSchema,
+				ValidationContext validationContext) throws JsonSchemaException, Exception {
+			if (schemaNode != null && schemaNode.isArray()) {
+				return new ReferenceTypesValidator();
+			}
+			return null;
+		}
+	}
+
+	private class ReferenceTypesValidator implements JsonValidator {
+		@Override
+		public Set<ValidationMessage> validate(JsonNode node, JsonNode rootNode, String at) {
+			CollectorContext collectorContext = CollectorContext.INSTANCE;
+			collectorContext.add(SAMPLE_COLLECTOR_TYPE, new Collector<List<String>>() {
+				@Override
+				public List<String> collect() {
+					List<String> references = new ArrayList<String>();
+					references.add("value");
+					return references;
+				}
+			});
+			return new TreeSet<ValidationMessage>();
+		}
+
+		@Override
+		public Set<ValidationMessage> validate(JsonNode rootNode) {
+			return validate(rootNode, rootNode, BaseJsonValidator.AT_ROOT);
+		}
+
+	}
+
+	@SuppressWarnings("unchecked")
+	@Test
+	public void testCollectorContextWithKeyword() throws Exception {
+		ObjectMapper objectMapper = new ObjectMapper();
+		final JsonMetaSchema metaSchema = getJsonMetaSchema(
+				"https://github.com/networknt/json-schema-validator/tests/schemas/example01#");
+		final JsonSchemaFactory schemaFactory = JsonSchemaFactory
+				.builder(JsonSchemaFactory.getInstance(SpecVersion.VersionFlag.V201909)).addMetaSchema(metaSchema)
+				.build();
+		final JsonSchema schema = schemaFactory.getSchema(
+				"{\"$schema\": \"https://github.com/networknt/json-schema-validator/tests/schemas/example01#\","
+						+ "\"title\" : \"Sample test schema\",\n"
+						+ "\"description\" : \"Sample schema definition\",\"type\" : \"object\",\"properties\" :{\"excerpt\" : {"
+						+ "\"title\": \"Excerpt\","
+						+ "\"type\": \"string\", \"reference-content-types\":[\"x\",\"y\"]}},"
+						+ "\"required\": [\"excerpt\"]\n" + "}");
+		Set<ValidationMessage> messages = schema.validateAndCollect(objectMapper.readTree("{\"excerpt\":\"sample\" }"));
+		Assert.assertEquals(0, messages.size());
+		List<String> contextValue = (List<String>) CollectorContext.INSTANCE.get(SAMPLE_COLLECTOR_TYPE);
+		Assert.assertEquals(contextValue.get(0), "value");
+	}
+
+	protected JsonMetaSchema getJsonMetaSchema(String uri) throws Exception {
+		JsonMetaSchema jsonMetaSchema = JsonMetaSchema.builder(uri, JsonMetaSchema.getV201909())
+				.addKeyword(new ReferenceTypesKeyWord()).build();
+		return jsonMetaSchema;
+	}
+
+}