Question generation

.vscode/launch.json

@@ -1,5 +1,12 @@
 {
     "configurations": [
+        {
+            "type": "java",
+            "name": "Main",
+            "request": "launch",
+            "mainClass": "com.wiq.wiq.services.questionGenerator.Main",
+            "projectName": "wiq"
+        },
         {
             "type": "java",
             "name": "Spring Boot-WiqApplication<wiq>",

backend/wiq/pom.xml

@@ -15,6 +15,8 @@
 	<description>Demo project for Spring Boot</description>
 	<properties>
 		<java.version>17</java.version>
+		<slf4jVersion>1.7.10</slf4jVersion>
+    	<wikidataToolkitVersion>0.11.0</wikidataToolkitVersion>
 	</properties>
 	<dependencies>
 		<dependency>
@@ -32,6 +34,38 @@
 			<groupId>javax.servlet</groupId>
 			<artifactId>jstl</artifactId>
 		</dependency>
+
+		<dependency>
+			<groupId>org.wikidata.wdtk</groupId>
+			<artifactId>wdtk-datamodel</artifactId>
+			<version>${wikidataToolkitVersion}</version>
+		  </dependency>
+		  <dependency>
+			<groupId>org.wikidata.wdtk</groupId>
+			<artifactId>wdtk-dumpfiles</artifactId>
+			<version>${wikidataToolkitVersion}</version>
+		  </dependency>
+		  <dependency>
+			<groupId>org.wikidata.wdtk</groupId>
+			<artifactId>wdtk-rdf</artifactId>
+			<version>${wikidataToolkitVersion}</version>
+		  </dependency>
+		  <dependency>
+			<groupId>org.wikidata.wdtk</groupId>
+			<artifactId>wdtk-wikibaseapi</artifactId>
+			<version>${wikidataToolkitVersion}</version>
+		  </dependency>
+		  <dependency> 
+			<groupId>org.slf4j</groupId>
+			<artifactId>slf4j-log4j12</artifactId>
+			<version>${slf4jVersion}</version>
+		  </dependency>
+
+		  <dependency>
+			  <groupId>org.json</groupId>
+			  <artifactId>json</artifactId>
+			  <version>20230618</version>
+		  </dependency>
 	</dependencies>
 
 	<build>
@@ -40,6 +74,14 @@
 				<groupId>org.springframework.boot</groupId>
 				<artifactId>spring-boot-maven-plugin</artifactId>
 			</plugin>
+
+			<plugin>
+				<artifactId>maven-compiler-plugin</artifactId>
+				<version>3.8.1</version>
+				<configuration>
+				  <release>17</release>
+				</configuration>
+			  </plugin>
 		</plugins>
 	</build>
 

backend/wiq/src/main/java/com/wiq/wiq/services/questionGenerator/Main.java

@@ -0,0 +1,25 @@
+package com.wiq.wiq.services.questionGenerator;
+
+import com.wiq.wiq.services.questionGenerator.question.QuestionType;
+
+public class Main {
+
+	private static QuestionType[] types = {QuestionType.POPULATION, QuestionType.CAPITAL, QuestionType.SIZE,
+		QuestionType.LANGUAGE};
+
+	public static void main(String[] args) {
+		QuestionGenerator qg = new QuestionGenerator("en");
+		for(QuestionType t : types) {
+			run(qg, t);
+			System.out.println();
+		}
+
+	}
+
+	private static void run(QuestionGenerator qg, QuestionType type) {
+		for(int i=0; i<3; i++) {
+			System.out.println(qg.generateQuestion(type));
+		}
+	}
+
+}

backend/wiq/src/main/java/com/wiq/wiq/services/questionGenerator/QuestionGenerator.java

@@ -0,0 +1,74 @@
+package com.wiq.wiq.services.questionGenerator;
+
+import com.wiq.wiq.services.questionGenerator.generator.AbstractGenerator;
+import com.wiq.wiq.services.questionGenerator.generator.specificGenerators.CapitalGenerator;
+import com.wiq.wiq.services.questionGenerator.generator.specificGenerators.LanguageGenerator;
+import com.wiq.wiq.services.questionGenerator.generator.specificGenerators.PopulationGenerator;
+import com.wiq.wiq.services.questionGenerator.generator.specificGenerators.SizeGenerator;
+import com.wiq.wiq.services.questionGenerator.question.QuestionType;
+
+
+
+public class QuestionGenerator {
+
+	private AbstractGenerator generator;
+	private String id;
+	private String languageCode;
+
+	private static String[] POP_ENTITIES = {"Q14317", "Q12273", "Q14649"};
+	private static String[] CAP_ENTITIES = {"Q3934", "Q29", "Q43"};
+	private static String[] SIZE_ENTITIES = {"Q29", "Q12273", "Q3934"};
+	private static String[] LANG_ENTITIES = {"Q29", "Q43", "Q3934"};
+
+	public QuestionGenerator(String languageCode){
+		this.languageCode = languageCode;
+	}
+
+	public String generateQuestion(QuestionType type) {
+		generatorFactory(type);
+		generator.setLocalization(languageCode);
+		String answer = generator.generate(id).getJSON().toString();
+		return answer;
+	}	
+
+	private void generatorFactory(QuestionType type) {
+		switch (type) {
+			case POPULATION: {
+				id = POP_ENTITIES[0];
+				generator = new PopulationGenerator();
+				moveUp(POP_ENTITIES);
+				POP_ENTITIES[POP_ENTITIES.length-1] = id;
+				break;
+			}
+			case CAPITAL: {
+				id = CAP_ENTITIES[0];
+				generator = new CapitalGenerator();
+				moveUp(CAP_ENTITIES);
+				CAP_ENTITIES[CAP_ENTITIES.length-1] = id;
+				break;
+
+			}
+			case SIZE: {
+				id = SIZE_ENTITIES[0];
+				generator = new SizeGenerator();
+				moveUp(SIZE_ENTITIES);
+				SIZE_ENTITIES[SIZE_ENTITIES.length-1] = id;
+				break;
+			}
+			case LANGUAGE: {
+				id = LANG_ENTITIES[0];
+				generator = new LanguageGenerator();
+				moveUp(LANG_ENTITIES);
+				LANG_ENTITIES[LANG_ENTITIES.length-1] = id;
+				break;
+			}
+		}
+	}
+
+	private void moveUp(String[] list) {
+		for(int i=0; i<list.length-1; i++) {
+			list[i] = list[i+1];
+		}
+	}
+
+}

backend/wiq/src/main/java/com/wiq/wiq/services/questionGenerator/generator/AbstractGenerator.java

@@ -0,0 +1,131 @@
+package com.wiq.wiq.services.questionGenerator.generator;
+
+import java.io.IOException;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Locale;
+import java.util.Map;
+import java.util.ResourceBundle;
+
+import org.wikidata.wdtk.datamodel.implementation.ItemDocumentImpl;
+import org.wikidata.wdtk.datamodel.interfaces.MonolingualTextValue;
+import org.wikidata.wdtk.datamodel.interfaces.Statement;
+import org.wikidata.wdtk.wikibaseapi.WikibaseDataFetcher;
+import org.wikidata.wdtk.wikibaseapi.apierrors.MediaWikiApiErrorException;
+
+import com.wiq.wiq.services.questionGenerator.question.Question;
+
+public abstract class AbstractGenerator {
+
+	protected static final WikibaseDataFetcher wbdf = WikibaseDataFetcher.getWikidataDataFetcher();
+	private String language = "en";
+
+	private Locale localization = Locale.getDefault();
+	private ResourceBundle messages;
+
+	private static Map<String, ItemDocumentImpl> alreadyProcessedEntities = new HashMap<>();
+
+	private String propertyId = "";
+
+	private static final String MESSAGES_PATH = "com/wiq/wiq/services/questionGenerator/"+
+				"generator/rsc/messages";
+
+	public AbstractGenerator(String propertyId) {
+		this.propertyId = propertyId;
+	}
+
+	/**
+	 * 
+	 * @param id
+	 * @return question generated or null if wikidata gives an error
+	 */
+	public Question generate(String id)  {
+		//get the wikidata entity using the id
+		ItemDocumentImpl idi = alreadyProcessedEntities.get(id);
+
+		if(idi==null) {
+			try {
+				idi = (ItemDocumentImpl) wbdf.getEntityDocument(id);
+				alreadyProcessedEntities.put(id, idi);
+			} catch (MediaWikiApiErrorException | IOException e) {
+				/*
+				 * * @throws MediaWikiApiErrorException
+				 *             if the API returns an error
+				 * @throws IOException
+				 * 			   if we encounter network issues or HTTP 500 errors from Wikibase
+				 */
+				return null;
+			}
+		}
+
+
+		String name = getName(idi.getLabels());
+
+		//get the question
+		String question = getQuestion(name);
+
+		//get the right answer
+		String rightAnswer = getRightAnswer(idi.getJsonClaims());
+
+		//get the wrong answers
+		List<String> answers = getWrongAnswers(rightAnswer);
+
+		answers.add(0, rightAnswer);
+		//create and return the question
+
+		return new Question(question, answers);
+	}
+
+	protected String getName(Map<String, MonolingualTextValue> names) {
+		MonolingualTextValue mtv = names.get(language);
+		return mtv.getText();
+	}
+
+	protected abstract String getQuestion(String name);
+	protected abstract String getRightAnswer(Map<String, List<Statement>> claims);
+	protected abstract List<String> getWrongAnswers(String rightAnswer);
+
+	public String getPropertyId() {
+		return propertyId;
+	}
+
+	public static Map<String, ItemDocumentImpl> getAlreadyProcessedEntities() {
+		return new HashMap<>(alreadyProcessedEntities);
+	}
+
+	public static void addItem(String entity, ItemDocumentImpl item) {
+		alreadyProcessedEntities.put(entity, item);
+	}
+
+	public ResourceBundle getMessages() {
+		return messages;
+	}
+
+	public void setLocalization(String languageCode) {
+		if(languageCode==null)
+			languageCode = "en";
+		else
+			languageCode = languageCode.toLowerCase();
+		switch (languageCode) {
+			case "en":{
+				localize(languageCode);
+				break;
+			}
+			case "es":{
+				localize(languageCode);
+				break;
+			}
+			default:{
+				localize("en");
+				break;
+			}
+		}
+	}
+
+	private void localize(String languageCode) {
+		this.language = languageCode;
+		this.localization = new Locale(languageCode);
+		this.messages = ResourceBundle.getBundle(MESSAGES_PATH, localization);
+	}
+
+}

backend/wiq/src/main/java/com/wiq/wiq/services/questionGenerator/generator/RightAnswerIsEntity.java

@@ -0,0 +1,44 @@
+package com.wiq.wiq.services.questionGenerator.generator;
+
+import java.io.IOException;
+import java.util.List;
+import java.util.Map;
+
+import org.wikidata.wdtk.datamodel.implementation.ItemDocumentImpl;
+import org.wikidata.wdtk.datamodel.interfaces.Statement;
+import org.wikidata.wdtk.datamodel.interfaces.Value;
+import org.wikidata.wdtk.wikibaseapi.apierrors.MediaWikiApiErrorException;
+
+public abstract class RightAnswerIsEntity extends AbstractGenerator {
+
+	public RightAnswerIsEntity(String propertyId) {
+		super(propertyId);
+	}
+
+	@Override
+	protected String getRightAnswer(Map<String, List<Statement>> claims) {
+		Value v = claims.get(super.getPropertyId()).get(0).getValue();
+		String entity = getRightAnswerEntity(v.toString());
+		String answer = "";
+		try {
+			ItemDocumentImpl idi = getAlreadyProcessedEntities().get(entity);
+			if(idi==null) {
+				idi = (ItemDocumentImpl) wbdf.getEntityDocument(entity);
+				answer = getName(idi.getLabels());
+				addItem(entity, idi);
+			}
+			else
+				answer = getName(idi.getLabels());
+		} catch (MediaWikiApiErrorException | IOException e) {
+			return null;
+		}
+		return answer;
+	}
+
+	private String getRightAnswerEntity(String url) {
+		String[] split1 = url.split(" ");
+		String[] split2 = split1[0].split("/");
+		return split2[split2.length-1];
+	}
+
+}

backend/wiq/src/main/java/com/wiq/wiq/services/questionGenerator/generator/rsc/messages.properties

@@ -0,0 +1,4 @@
+question.population = What's the population of %s?
+question.language = What's the official language of %s?
+question.capital = What's the capital of %s?
+question.size = What's the size of %s?

backend/wiq/src/main/java/com/wiq/wiq/services/questionGenerator/generator/rsc/messages_en.properties

@@ -0,0 +1,4 @@
+question.population = What's the population of %s?
+question.language = What's the official language of %s?
+question.capital = What's the capital of %s?
+question.size = What's the size of %s?

backend/wiq/src/main/java/com/wiq/wiq/services/questionGenerator/generator/rsc/messages_es.properties

@@ -0,0 +1,4 @@
+question.population = �Cu�l es la poblaci�n de %s?
+question.language = �Cu�l es el idioma oficial de %s?
+question.capital = �Cu�l es la capital de %s?
+question.size = �Cu�l es el �rea (km cuadrados) de %s?