[ZEN-3764] Example Data: Generate example dummy data into OpenAPI Model from single schema (DO NOT MERGE)

com.reprezen.swagedit.core/META-INF/MANIFEST.MF

@@ -30,6 +30,7 @@ Export-Package: com.github.fge.jsonschema.core.exceptions,
  com.reprezen.swagedit.core,
  com.reprezen.swagedit.core.assist,
  com.reprezen.swagedit.core.assist.contexts,
+ com.reprezen.swagedit.core.assist.exampleprovider,
  com.reprezen.swagedit.core.assist.ext,
  com.reprezen.swagedit.core.editor,
  com.reprezen.swagedit.core.editor.outline,

com.reprezen.swagedit.core/plugin.xml

@@ -1,6 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <?eclipse version="3.2"?>
 <plugin>
+	<extension-point id="com.reprezen.swagedit.exampleprovider" name="com.reprezen.swagedit.exampleprovider" schema="schema/com.reprezen.swagedit.exampleprovider.exsd"/>
    <extension-point id="com.reprezen.swagedit.validator" name="com.reprezen.swagedit.validator" schema="schema/com.reprezen.swagedit.validator.exsd"/>
    <extension-point id="com.reprezen.swagedit.preferences" name="com.reprezen.swagedit.preferences" schema="schema/com.reprezen.swagedit.preferences.exsd"/>
    <extension

com.reprezen.swagedit.core/schema/com.reprezen.swagedit.exampleprovider.exsd

@@ -0,0 +1,102 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!-- Schema file written by PDE -->
+<schema targetNamespace="com.reprezen.swagedit.core" xmlns="http://www.w3.org/2001/XMLSchema">
+<annotation>
+      <appInfo>
+         <meta.schema plugin="com.reprezen.swagedit.core" id="com.reprezen.swagedit.exampleprovider" name="com.reprezen.swagedit.exampleprovider"/>
+      </appInfo>
+      <documentation>
+         [Enter description of this extension point.]
+      </documentation>
+   </annotation>
+
+   <element name="extension">
+      <annotation>
+         <appInfo>
+            <meta.element />
+         </appInfo>
+      </annotation>
+      <complexType>
+         <sequence>
+            <element ref="exampleprovider"/>
+         </sequence>
+         <attribute name="point" type="string" use="required">
+            <annotation>
+               <documentation>
+
+               </documentation>
+            </annotation>
+         </attribute>
+         <attribute name="id" type="string">
+            <annotation>
+               <documentation>
+
+               </documentation>
+            </annotation>
+         </attribute>
+         <attribute name="name" type="string">
+            <annotation>
+               <documentation>
+
+               </documentation>
+               <appInfo>
+                  <meta.attribute translatable="true"/>
+               </appInfo>
+            </annotation>
+         </attribute>
+      </complexType>
+   </element>
+
+   <element name="exampleprovider">
+      <complexType>
+         <attribute name="class" type="string" use="required">
+            <annotation>
+               <documentation>
+
+               </documentation>
+               <appInfo>
+                  <meta.attribute kind="java" basedOn=":com.reprezen.swagedit.core.assist.exampleprovider.ExampleProvider"/>
+               </appInfo>
+            </annotation>
+         </attribute>
+      </complexType>
+   </element>
+
+   <annotation>
+      <appInfo>
+         <meta.section type="since"/>
+      </appInfo>
+      <documentation>
+         [Enter the first release in which this extension point appears.]
+      </documentation>
+   </annotation>
+
+   <annotation>
+      <appInfo>
+         <meta.section type="examples"/>
+      </appInfo>
+      <documentation>
+         [Enter extension point usage example here.]
+      </documentation>
+   </annotation>
+
+   <annotation>
+      <appInfo>
+         <meta.section type="apiinfo"/>
+      </appInfo>
+      <documentation>
+         [Enter API information here.]
+      </documentation>
+   </annotation>
+
+   <annotation>
+      <appInfo>
+         <meta.section type="implementation"/>
+      </appInfo>
+      <documentation>
+         [Enter information about supplied implementation of this extension point.]
+      </documentation>
+   </annotation>
+
+
+</schema>

com.reprezen.swagedit.core/src/com/reprezen/swagedit/core/assist/JsonContentAssistProcessor.java

@@ -67,6 +67,7 @@ public abstract class JsonContentAssistProcessor extends TemplateCompletionProce
 
    private final JsonProposalProvider proposalProvider;
    private final JsonReferenceProposalProvider referenceProposalProvider;
+   private final JsonExampleProposalProvider exampleProposalProvider;
    private final ContentAssistant contentAssistant;
 
     /**
@@ -93,15 +94,19 @@ public abstract class JsonContentAssistProcessor extends TemplateCompletionProce
 
 	public JsonContentAssistProcessor(ContentAssistant ca, String fileContentType) {
 		this(ca, new JsonProposalProvider(),
-				new JsonReferenceProposalProvider(ContextType.emptyContentTypeCollection(), fileContentType));
+				new JsonReferenceProposalProvider(ContextType.emptyContentTypeCollection(), fileContentType),
+				new JsonExampleProposalProvider(ContextType.emptyContentTypeCollection()));
+	}
+
+	public JsonContentAssistProcessor(ContentAssistant ca, JsonProposalProvider proposalProvider,
+			JsonReferenceProposalProvider referenceProposalProvider,
+			JsonExampleProposalProvider exampleProposalProvider) {
+		this.contentAssistant = ca;
+		this.proposalProvider = proposalProvider;
+		this.referenceProposalProvider = referenceProposalProvider;
+		this.exampleProposalProvider = exampleProposalProvider;
+		this.textMessages = initTextMessages();
 	}
-
-    public JsonContentAssistProcessor(ContentAssistant ca, JsonProposalProvider proposalProvider, JsonReferenceProposalProvider referenceProposalProvider) {
-        this.contentAssistant = ca;
-        this.proposalProvider = proposalProvider;
-        this.referenceProposalProvider = referenceProposalProvider;
-        this.textMessages = initTextMessages();
-    }
 
     protected abstract TemplateStore getTemplateStore();
 
@@ -145,8 +150,15 @@ public ICompletionProposal[] computeCompletionProposals(ITextViewer viewer, int
             updateStatus();
             kaizenProposals = referenceProposalProvider.getProposals(currentPath, document, currentScope);
         } else {
-            clearStatus();
-            kaizenProposals = proposalProvider.getProposals(currentPath, currentModel, prefix);
+        	final boolean isExampleCompletion = exampleProposalProvider.canProvideProposal(currentModel, currentPath);
+        	if (isExampleCompletion) {
+        		//TODO: Update or clear status ???????
+        		kaizenProposals = exampleProposalProvider.getProposals(currentPath, document);
+        	} else {
+        		clearStatus();
+        		kaizenProposals = proposalProvider.getProposals(currentPath, currentModel, prefix);
+        	}
+
         }
 
         final Collection<ICompletionProposal> proposals = getCompletionProposals(kaizenProposals, prefix, documentOffset, selection.getText());

com.reprezen.swagedit.core/src/com/reprezen/swagedit/core/assist/JsonExampleProposalProvider.java

@@ -0,0 +1,59 @@
+/*******************************************************************************
+ * Copyright (c) 2019 ModelSolv, Inc. and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *    ModelSolv, Inc. - initial API and implementation and/or initial documentation
+ *******************************************************************************/
+package com.reprezen.swagedit.core.assist;
+
+import java.net.URI;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.Set;
+
+import com.fasterxml.jackson.core.JsonPointer;
+import com.reprezen.swagedit.core.assist.contexts.ContextType;
+import com.reprezen.swagedit.core.assist.contexts.ContextTypeCollection;
+import com.reprezen.swagedit.core.assist.exampleprovider.ExampleProvider;
+import com.reprezen.swagedit.core.editor.JsonDocument;
+import com.reprezen.swagedit.core.model.Model;
+import com.reprezen.swagedit.core.utils.ExtensionUtils;
+
+/**
+ * Completion proposal provider for JSON examples.
+ */
+public class JsonExampleProposalProvider {
+
+	public static final String ID = "com.reprezen.swagedit.exampleprovider";
+	protected static final String SCHEMA_FIELD_NAME = "schema";
+	private final ContextTypeCollection contextTypes;
+
+	public JsonExampleProposalProvider(ContextTypeCollection contextTypes) {
+		this.contextTypes = contextTypes;
+	}
+
+	public boolean canProvideProposal(Model model, JsonPointer pointer) {
+		return pointer != null && contextTypes.get(model, pointer) != ContextType.UNKNOWN;
+	}
+
+	public Collection<ProposalDescriptor> getProposals(JsonPointer pointer, JsonDocument document) {
+		return Collections.emptyList();
+	}
+
+	protected ExampleProvider getExampleDataProvider() {
+		final ExampleProvider defaultExampleProvider = (JsonPointer jsonPointer, JsonDocument document,
+				URI uri) -> "example:"; 
+
+		final Set<ExampleProvider> exampleProviders = ExtensionUtils.getExampleProviders();
+		if (exampleProviders != null && !exampleProviders.isEmpty()) {
+			return exampleProviders.iterator().next();
+		} else {
+			return defaultExampleProvider;
+		}
+	}
+
+}

com.reprezen.swagedit.core/src/com/reprezen/swagedit/core/assist/exampleprovider/ExampleProvider.java

@@ -0,0 +1,21 @@
+/*******************************************************************************
+ *  Copyright (c) 2016 ModelSolv, Inc. and others.
+ *  All rights reserved. This program and the accompanying materials
+ *  are made available under the terms of the Eclipse Public License v1.0
+ *  which accompanies this distribution, and is available at
+ *  http://www.eclipse.org/legal/epl-v10.html
+ *  
+ *  Contributors:
+ *     ModelSolv, Inc. - initial API and implementation and/or initial documentation
+ *******************************************************************************/
+package com.reprezen.swagedit.core.assist.exampleprovider;
+
+import java.net.URI;
+
+import com.fasterxml.jackson.core.JsonPointer;
+import com.reprezen.swagedit.core.editor.JsonDocument;
+
+public interface ExampleProvider {
+
+	String getData(JsonPointer jsonPointer, JsonDocument document, URI baseURI);
+}

com.reprezen.swagedit.core/src/com/reprezen/swagedit/core/utils/DocumentUtils.java

@@ -49,6 +49,11 @@ public static FileEditorInput getActiveEditorInput() {
 
         return input instanceof FileEditorInput ? (FileEditorInput) input : null;
     }
+
+    public static URI getActiveEditorInputURI() {
+    	final FileEditorInput activeEditorInput = getActiveEditorInput();
+    	return activeEditorInput != null ? activeEditorInput.getURI() : null;
+    }
 
     /**
      * Returns the swagger document if exists for the given path.

com.reprezen.swagedit.core/src/com/reprezen/swagedit/core/utils/ExtensionUtils.java

@@ -1,15 +1,17 @@
 /*******************************************************************************
- *  Copyright (c) 2016 ModelSolv, Inc. and others.
- *  All rights reserved. This program and the accompanying materials
- *  are made available under the terms of the Eclipse Public License v1.0
- *  which accompanies this distribution, and is available at
- *  http://www.eclipse.org/legal/epl-v10.html
- *  
- *  Contributors:
- *     ModelSolv, Inc. - initial API and implementation and/or initial documentation
+ * Copyright (c) 2019 ModelSolv, Inc. and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *    ModelSolv, Inc. - initial API and implementation and/or initial documentation
  *******************************************************************************/
+
 package com.reprezen.swagedit.core.utils;
 
+import java.util.Collections;
 import java.util.Objects;
 import java.util.Set;
 import java.util.function.Predicate;
@@ -21,45 +23,53 @@
 import org.eclipse.core.runtime.Platform;
 
 import com.reprezen.swagedit.core.Activator;
+import com.reprezen.swagedit.core.assist.JsonExampleProposalProvider;
+import com.reprezen.swagedit.core.assist.exampleprovider.ExampleProvider;
 import com.reprezen.swagedit.core.providers.PreferenceProvider;
 import com.reprezen.swagedit.core.providers.ValidationProvider;
 
 public class ExtensionUtils {
 
-    @SuppressWarnings("unchecked")
-    private static <T> Set<T> resolveProviders(String ID, Predicate<? super IConfigurationElement> predicate) {
-        return Stream.of(Platform.getExtensionRegistry() //
-                .getConfigurationElementsFor(ID)) //
-                .filter(predicate) //
-                .map(e -> {
-                    try {
-                        return e.createExecutableExtension("class");
-                    } catch (CoreException ex) {
-                        Activator.getDefault().logError(ex.getMessage(), ex);
-                        return null;
-                    }
-                }) //
-                .map(e -> {
-                    try {
-                        return (T) e;
-                    } catch (ClassCastException ex) {
-                        return null;
-                    }
-                }) //
-                .filter(Objects::nonNull) //
-                .collect(Collectors.toSet());
-    }
+	@SuppressWarnings("unchecked")
+	private static <T> Set<T> resolveProviders(String ID, Predicate<? super IConfigurationElement> predicate) {
+		return Stream.of(Platform.getExtensionRegistry() //
+				.getConfigurationElementsFor(ID)) //
+				.filter(predicate) //
+				.map(e -> {
+					try {
+						return e.createExecutableExtension("class");
+					} catch (CoreException ex) {
+						Activator.getDefault().logError(ex.getMessage(), ex);
+						return Collections.emptySet();
+					}
+				}) //
+				.map(e -> {
+					try {
+						return (T) e;
+					} catch (ClassCastException ex) {
+						Activator.getDefault().logError(ex.getMessage(), ex);
+						return null;
+					}
+				}) //
+				.filter(Objects::nonNull) //
+				.collect(Collectors.toSet());
+	}
+
+	public static Set<ValidationProvider> getValidationProviders() {
+		return resolveProviders(ValidationProvider.ID, (e) -> true);
+	}
+
+	public static Set<PreferenceProvider> getPreferenceProviders() {
+		return resolveProviders(PreferenceProvider.ID, (e) -> true);
+	}
 
-    public static Set<ValidationProvider> getValidationProviders() {
-        return resolveProviders(ValidationProvider.ID, (e) -> true);
-    }
+	public static Set<PreferenceProvider> getPreferenceProviders(String preferencePage) {
+		return resolveProviders(PreferenceProvider.ID,
+				(e) -> preferencePage.equalsIgnoreCase(e.getAttribute("preferencePage")));
+	}
 
-    public static Set<PreferenceProvider> getPreferenceProviders() {
-        return resolveProviders(PreferenceProvider.ID, (e) -> true);
-    }
+	public static Set<ExampleProvider> getExampleProviders() {
+		return resolveProviders(JsonExampleProposalProvider.ID, (e) -> true);
+	}
 
-    public static Set<PreferenceProvider> getPreferenceProviders(String preferencePage) {
-        return resolveProviders(PreferenceProvider.ID,
-                (e) -> preferencePage.equalsIgnoreCase(e.getAttribute("preferencePage")));
-    }
 }