4268: Add WbEntityVariable class (#4311)
This commit is contained in:
Joey
GitHub
parent
fa6eb22361
commit
cd4047b53a
@ -0,0 +1,94 @@
|
|||||||
|
/*******************************************************************************
|
||||||
|
* MIT License
|
||||||
|
*
|
||||||
|
* Copyright (c) 2018 Antonin Delpeuch
|
||||||
|
*
|
||||||
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
* of this software and associated documentation files (the "Software"), to deal
|
||||||
|
* in the Software without restriction, including without limitation the rights
|
||||||
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
* copies of the Software, and to permit persons to whom the Software is
|
||||||
|
* furnished to do so, subject to the following conditions:
|
||||||
|
*
|
||||||
|
* The above copyright notice and this permission notice shall be included in all
|
||||||
|
* copies or substantial portions of the Software.
|
||||||
|
*
|
||||||
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
* SOFTWARE.
|
||||||
|
******************************************************************************/
|
||||||
|
package org.openrefine.wikidata.schema;
|
||||||
|
|
||||||
|
import org.openrefine.wikidata.qa.QAWarning;
|
||||||
|
import org.openrefine.wikidata.schema.entityvalues.ReconItemIdValue;
|
||||||
|
import org.openrefine.wikidata.schema.entityvalues.ReconMediaInfoIdValue;
|
||||||
|
import org.openrefine.wikidata.schema.entityvalues.ReconPropertyIdValue;
|
||||||
|
import org.openrefine.wikidata.schema.exceptions.SkipSchemaExpressionException;
|
||||||
|
import org.wikidata.wdtk.datamodel.implementation.EntityIdValueImpl;
|
||||||
|
import org.wikidata.wdtk.datamodel.interfaces.EntityIdValue;
|
||||||
|
import org.wikidata.wdtk.datamodel.interfaces.ItemIdValue;
|
||||||
|
import org.wikidata.wdtk.datamodel.interfaces.MediaInfoIdValue;
|
||||||
|
import org.wikidata.wdtk.datamodel.interfaces.PropertyIdValue;
|
||||||
|
|
||||||
|
import com.fasterxml.jackson.annotation.JsonCreator;
|
||||||
|
import com.google.refine.model.Cell;
|
||||||
|
import com.google.refine.model.Recon.Judgment;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An Entity that depends on a reconciled value in a column.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
public class WbEntityVariable extends WbVariableExpr<EntityIdValue> {
|
||||||
|
|
||||||
|
@JsonCreator
|
||||||
|
public WbEntityVariable() {
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructs a variable and sets the column it is bound to. Mostly used as a
|
||||||
|
* convenience method for testing.
|
||||||
|
*
|
||||||
|
* @param columnName
|
||||||
|
* the name of the column the expression should draw its value from
|
||||||
|
*/
|
||||||
|
public WbEntityVariable(String columnName) {
|
||||||
|
setColumnName(columnName);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public EntityIdValue fromCell(Cell cell, ExpressionContext ctxt)
|
||||||
|
throws SkipSchemaExpressionException {
|
||||||
|
if (cell.recon != null
|
||||||
|
&& (Judgment.Matched.equals(cell.recon.judgment) || Judgment.New.equals(cell.recon.judgment))) {
|
||||||
|
if (cell.recon.identifierSpace == null || !cell.recon.identifierSpace.equals(ctxt.getBaseIRI())) {
|
||||||
|
QAWarning warning = new QAWarning("invalid-identifier-space", null, QAWarning.Severity.INFO, 1);
|
||||||
|
warning.setProperty("example_cell", cell.value.toString());
|
||||||
|
ctxt.addWarning(warning);
|
||||||
|
throw new SkipSchemaExpressionException();
|
||||||
|
}
|
||||||
|
if (Judgment.New.equals(cell.recon.judgment)) {
|
||||||
|
return new ReconItemIdValue(cell.recon, cell.value.toString());
|
||||||
|
}
|
||||||
|
EntityIdValue entityIdValue = EntityIdValueImpl.fromId(cell.recon.match.id, cell.recon.identifierSpace);
|
||||||
|
if (entityIdValue instanceof ItemIdValue) {
|
||||||
|
return new ReconItemIdValue(cell.recon, cell.value.toString());
|
||||||
|
} else if (entityIdValue instanceof MediaInfoIdValue) {
|
||||||
|
return new ReconMediaInfoIdValue(cell.recon, cell.value.toString());
|
||||||
|
} else if (entityIdValue instanceof PropertyIdValue) {
|
||||||
|
return new ReconPropertyIdValue(cell.recon, cell.value.toString());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
throw new SkipSchemaExpressionException();
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public boolean equals(Object other) {
|
||||||
|
return equalAsVariables(other, WbEntityVariable.class);
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -40,6 +40,7 @@ import com.fasterxml.jackson.annotation.JsonTypeInfo;
|
|||||||
@Type(value = WbLocationVariable.class, name = "wblocationvariable"),
|
@Type(value = WbLocationVariable.class, name = "wblocationvariable"),
|
||||||
@Type(value = WbItemConstant.class, name = "wbitemconstant"),
|
@Type(value = WbItemConstant.class, name = "wbitemconstant"),
|
||||||
@Type(value = WbItemVariable.class, name = "wbitemvariable"),
|
@Type(value = WbItemVariable.class, name = "wbitemvariable"),
|
||||||
|
@Type(value = WbEntityVariable.class, name = "wbentityvariable"),
|
||||||
@Type(value = WbLanguageConstant.class, name = "wblanguageconstant"),
|
@Type(value = WbLanguageConstant.class, name = "wblanguageconstant"),
|
||||||
@Type(value = WbLanguageVariable.class, name = "wblanguagevariable"),
|
@Type(value = WbLanguageVariable.class, name = "wblanguagevariable"),
|
||||||
@Type(value = WbDateConstant.class, name = "wbdateconstant"),
|
@Type(value = WbDateConstant.class, name = "wbdateconstant"),
|
||||||
|
|||||||
@ -0,0 +1,127 @@
|
|||||||
|
/*******************************************************************************
|
||||||
|
* MIT License
|
||||||
|
*
|
||||||
|
* Copyright (c) 2018 Antonin Delpeuch
|
||||||
|
*
|
||||||
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
* of this software and associated documentation files (the "Software"), to deal
|
||||||
|
* in the Software without restriction, including without limitation the rights
|
||||||
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
* copies of the Software, and to permit persons to whom the Software is
|
||||||
|
* furnished to do so, subject to the following conditions:
|
||||||
|
*
|
||||||
|
* The above copyright notice and this permission notice shall be included in all
|
||||||
|
* copies or substantial portions of the Software.
|
||||||
|
*
|
||||||
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
* SOFTWARE.
|
||||||
|
******************************************************************************/
|
||||||
|
package org.openrefine.wikidata.schema;
|
||||||
|
|
||||||
|
import java.util.Collections;
|
||||||
|
|
||||||
|
import org.openrefine.wikidata.schema.entityvalues.ReconItemIdValue;
|
||||||
|
import org.openrefine.wikidata.schema.entityvalues.ReconMediaInfoIdValue;
|
||||||
|
import org.openrefine.wikidata.schema.entityvalues.ReconPropertyIdValue;
|
||||||
|
import org.openrefine.wikidata.testing.JacksonSerializationTest;
|
||||||
|
import org.testng.annotations.Test;
|
||||||
|
import org.wikidata.wdtk.datamodel.implementation.EntityIdValueImpl;
|
||||||
|
import org.wikidata.wdtk.datamodel.interfaces.EntityIdValue;
|
||||||
|
import org.wikidata.wdtk.datamodel.interfaces.ItemIdValue;
|
||||||
|
import org.wikidata.wdtk.datamodel.interfaces.MediaInfoIdValue;
|
||||||
|
import org.wikidata.wdtk.datamodel.interfaces.PropertyIdValue;
|
||||||
|
|
||||||
|
import com.google.refine.model.Cell;
|
||||||
|
import com.google.refine.model.Recon;
|
||||||
|
import com.google.refine.model.ReconCandidate;
|
||||||
|
|
||||||
|
public class WbEntityVariableTest extends WbVariableTest<EntityIdValue> {
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public WbVariableExpr<EntityIdValue> initVariableExpr() {
|
||||||
|
return new WbEntityVariable();
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
public void testReconciledItemCell() {
|
||||||
|
Recon recon = Recon.makeWikidataRecon(3782378L);
|
||||||
|
recon.judgment = Recon.Judgment.Matched;
|
||||||
|
recon.match = new ReconCandidate("Q123", "some item", null, 100.0);
|
||||||
|
Cell cell = new Cell("some value", recon);
|
||||||
|
evaluatesTo(new ReconItemIdValue(recon, "some value"), cell);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
public void testReconciledMediaInfoCell() {
|
||||||
|
Recon recon = Recon.makeWikidataRecon(3782378L);
|
||||||
|
recon.judgment = Recon.Judgment.Matched;
|
||||||
|
recon.match = new ReconCandidate("M123", "some item", null, 100.0);
|
||||||
|
Cell cell = new Cell("some value", recon);
|
||||||
|
evaluatesTo(new ReconMediaInfoIdValue(recon, "some value"), cell);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
public void testReconciledPropertyCell() {
|
||||||
|
Recon recon = Recon.makeWikidataRecon(3782378L);
|
||||||
|
recon.judgment = Recon.Judgment.Matched;
|
||||||
|
recon.match = new ReconCandidate("P123", "some item", null, 100.0);
|
||||||
|
Cell cell = new Cell("some value", recon);
|
||||||
|
evaluatesTo(new ReconPropertyIdValue(recon, "some value"), cell);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
public void testNewItemCell() {
|
||||||
|
Recon recon = Recon.makeWikidataRecon(3782378L);
|
||||||
|
recon.judgment = Recon.Judgment.New;
|
||||||
|
recon.candidates = Collections.singletonList(new ReconCandidate("Q123", "some item", null, 100.0));
|
||||||
|
Cell cell = new Cell("some value", recon);
|
||||||
|
evaluatesTo(new ReconItemIdValue(recon, "some value"), cell);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
public void testUnmatchedCell() {
|
||||||
|
Recon recon = Recon.makeWikidataRecon(3782378L);
|
||||||
|
recon.judgment = Recon.Judgment.None;
|
||||||
|
recon.candidates = Collections.singletonList(new ReconCandidate("Q123", "some item", null, 100.0));
|
||||||
|
Cell cell = new Cell("some value", recon);
|
||||||
|
isSkipped(cell);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
public void testInvalidSpace() {
|
||||||
|
Recon recon = Recon.makeWikidataRecon(34989L);
|
||||||
|
recon.identifierSpace = "http://my.own.wikiba.se/";
|
||||||
|
recon.candidates = Collections.singletonList(new ReconCandidate("Q123", "some item", null, 100.0));
|
||||||
|
recon.judgment = Recon.Judgment.Matched;
|
||||||
|
Cell cell = new Cell("some value", recon);
|
||||||
|
isSkipped(cell);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
public void testUnreconciledCell() {
|
||||||
|
isSkipped("some value");
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
public void testNullCell() {
|
||||||
|
isSkipped((Cell) null);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
public void testNullStringValue() {
|
||||||
|
isSkipped((String) null);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
public void testSerialize() {
|
||||||
|
JacksonSerializationTest.canonicalSerialization(WbExpression.class, variable,
|
||||||
|
"{\"type\":\"wbentityvariable\",\"columnName\":\"column A\"}");
|
||||||
|
}
|
||||||
|
|
||||||
|
// TODO: test with column reconciled against different identifier space
|
||||||
|
}
|
||||||
Loading…
Reference in New Issue
Block a user