eu.trentorise.opendata.semantics.IntegrityChecker Maven / Gradle / Ivy
/*
* Copyright 2013-2015 Trento Rise trentorise.eu
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package eu.trentorise.opendata.semantics;
import eu.trentorise.opendata.semantics.model.entity.IAttribute;
import eu.trentorise.opendata.semantics.model.entity.IAttributeDef;
import eu.trentorise.opendata.semantics.model.entity.IEntity;
import eu.trentorise.opendata.semantics.model.entity.IEntityType;
import eu.trentorise.opendata.semantics.model.entity.IStructure;
import eu.trentorise.opendata.semantics.model.entity.IValue;
import eu.trentorise.opendata.semantics.model.knowledge.IConcept;
import eu.trentorise.opendata.semantics.model.knowledge.IDict;
import eu.trentorise.opendata.semantics.model.knowledge.IMeaning;
import eu.trentorise.opendata.semantics.model.knowledge.ISemanticText;
import eu.trentorise.opendata.semantics.model.knowledge.ISentence;
import eu.trentorise.opendata.semantics.model.knowledge.IWord;
import eu.trentorise.opendata.semantics.services.IEkb;
import eu.trentorise.opendata.semantics.services.model.AssignmentResult;
import eu.trentorise.opendata.semantics.services.model.DataTypes;
import eu.trentorise.opendata.semantics.services.model.IAttributeCorrespondence;
import eu.trentorise.opendata.semantics.services.model.IIDResult;
import eu.trentorise.opendata.semantics.services.model.ISchemaCorrespondence;
import java.util.List;
import java.util.Locale;
/**
* Class to collect checkers for implementations of Open Entity API interfaces.
*
* @author David Leoni
*/
public final class IntegrityChecker {
public static void checkSentence(ISentence s) {
if (s.getWords() == null) {
throw new IntegrityException("Found null words in sentence!");
}
for (IWord w : s.getWords()) {
checkWord(w);
}
}
public static void checkWord(IWord w) {
checkSpan(w.getStartOffset(), w.getEndOffset());
if (w.getMeaningStatus() == null) {
throw new IntegrityException("Found null meaning status in a word!");
}
if (w.getSelectedMeaning() != null) {
checkURL(w.getSelectedMeaning().getURL());
checkMeaning(w.getSelectedMeaning());
}
if (w.getMeanings() == null) {
throw new IntegrityException("Found null meanings in a word!");
}
for (IMeaning m : w.getMeanings()) {
checkMeaning(m);
}
}
private static void checkMeaning(IMeaning m) {
checkScore(m.getProbability());
checkDict(m.getName());
}
public static void checkScore(double score) {
double prec = ISchemaCorrespondence.SCORE_TOLERANCE;
if (score < -prec || score > 1.0 + prec) {
throw new IntegrityException("Score " + score + " exceeds bounds [" + (-prec) + ", " + 1.0 + prec + "].");
}
}
public static void checkSpan(int startOffset, int endOffset) {
if (endOffset < 0
|| startOffset < 0
|| endOffset < startOffset) {
throw new IntegrityException("Found invalid span! [" + startOffset + "," + endOffset + "]");
}
}
private IntegrityChecker() {
}
private static void checkScore(Float score) {
if (score == null) {
throw new IntegrityException("Found null score!");
}
checkScore(score.doubleValue());
}
/**
* Checks if provided schema correspondence complies with open entity specs.
*
* @param schemaCor to check
* @throws IntegrityException if provided correspondence is not conformant
* to OpenEntity specs.
*/
public static void checkSchemaCorrespondence(ISchemaCorrespondence schemaCor) {
if (schemaCor == null) {
throw new IntegrityException("Schema correspondence is null!");
}
try {
checkEntityType(schemaCor.getEtype());
} catch (Exception ex) {
throw new IntegrityException("Invalid etype in schema correspondence!", ex);
}
if (schemaCor.getAttributeCorrespondences() == null) {
throw new IntegrityException("Schema Correrespondence has null correspondences!");
}
for (IAttributeCorrespondence attrCor : schemaCor.getAttributeCorrespondences()) {
checkURL(attrCor.getHeaderConceptURL());
try {
checkScore(attrCor.getScore());
} catch (Exception ex) {
throw new IntegrityException("Invalid score for attribute correspondence " + attrCor.getScore() + " Found score: " + attrCor.getScore(), ex);
}
if (attrCor.getColumnIndex() < 0) {
throw new IntegrityException("Attribute correspondence column index is lesss than zero. Found index: " + attrCor.getColumnIndex());
}
checkAttributeDef(attrCor.getAttrDef());
if (attrCor.getAttrMap() == null) {
throw new IntegrityException("Found null attr map in IAttributeCorrespondence for etype " + schemaCor.getEtype().getURL());
}
for (IAttributeDef ad : attrCor.getAttrMap().keySet()) {
try {
checkScore(attrCor.getAttrMap().get(ad));
} catch (Exception ex) {
throw new IntegrityException("Found invalid score in attribute correspondence map for attribute " + ad.getURL(), ex);
}
}
}
}
/**
* Checks if provided dictionary complies with open entity specs.
*
* @param dict the dictionary to check
* @throws IntegrityException if provided dict is not conformant to
* OpenEntity specs.
*/
public static void checkDict(IDict dict) {
if (dict == null) {
throw new IntegrityException("Dict is null!");
}
if (dict.getLocales() == null) {
throw new IntegrityException("Dict has null locales!");
}
for (Locale loc : dict.getLocales()) {
if (loc == null){
throw new IntegrityException("Found null locale in IDict!");
}
List tr = dict.getStrings(loc);
if (tr == null) {
throw new IntegrityException("IDict has null translations for locale " + loc);
}
for (String t : tr) {
if (t == null) {
throw new IntegrityException("Found null translation fot locale " + loc);
}
}
}
}
/**
* Checks if provided URL complies with open entity specs.
*
* @param URL the URL to check
* @throws IntegrityException if provided URL is not conformant to
* OpenEntity specs.
*/
public static void checkURL(String URL) {
if (URL == null) {
throw new IntegrityException("Found null URL!");
}
if (URL.length() == 0) {
throw new IntegrityException("Found empty URL!");
}
if (URL.equals("null")) {
throw new IntegrityException("Found URL with string \"null\" as content!");
}
// todo delete this is a too radical checker...
if (URL.endsWith("/null")) {
throw new IntegrityException("Found URL ending with /\"null\"!");
}
}
/**
* Checks if provided entity type complies with open entity specs.
*
* @param etype the entity type to check
* @throws IntegrityException if provided etype is not conformant to
* OpenEntity specs.
*/
public static void checkEntityType(IEntityType etype) {
if (etype == null) {
throw new IntegrityException("Found null etype!");
}
try {
checkURL(etype.getURL());
} catch (IntegrityException ex) {
throw new IntegrityException("Invalid etype URL!", ex);
}
try {
checkDict(etype.getName());
} catch (Exception ex) {
throw new IntegrityException("Invalid etype name!", ex);
}
try {
checkURL(etype.getConceptURL());
} catch (Exception ex) {
throw new IntegrityException("Found invalid concept for etype " + etype.getURL(), ex);
}
/**
* not supported for now if (etype.getUniqueIndexes() == null){ throw
* new IntegrityException("Found null unique indexes for etype " +
* etype.getURL()); }
*/
for (IAttributeDef attrDef : etype.getAttributeDefs()) {
try {
checkAttributeDef(attrDef);
} catch (Exception ex) {
throw new IntegrityException("Found invalid attr def in etype " + etype.getURL(), ex);
}
}
try {
etype.getNameAttrDef();
} catch (Exception ex) {
throw new IntegrityException("Found problem in getNameAttrDef() for etype with URL " + etype.getURL(), ex);
}
try {
etype.getDescriptionAttrDef();
} catch (Exception ex) {
throw new IntegrityException("Found problem in getNameAttrDef() for etype with URL " + etype.getURL(), ex);
}
}
/**
* Checks if provided attribute def complies with open entity specs.
*
* @param attrDef the attribute definition to check
* @throws IntegrityException if provided attrDef is not conformant to
* OpenEntity specs.
*/
public static void checkAttributeDef(IAttributeDef attrDef) {
if (attrDef == null) {
throw new IntegrityException("Found null attribute def!");
}
if (attrDef.getURL() == null) {
throw new IntegrityException("Found null URL for attribute def " + attrDef.getName());
}
if (attrDef.getURL().length() == 0) {
throw new IntegrityException("Found empty URL for attribute def " + attrDef.getName());
}
if (attrDef.getName() == null) {
throw new IntegrityException("Found null name dict for attribute def " + attrDef.getURL());
}
try {
checkURL(attrDef.getEtypeURL());
} catch (Exception ex) {
throw new IntegrityException("Found invalid etype URL for attribute def " + attrDef.getURL(), ex);
}
if (attrDef.getDataType() == null) {
throw new IntegrityException("Found null datatype for attribute def " + attrDef.getURL());
}
if ((attrDef.getDataType().equals(DataTypes.STRUCTURE) || attrDef.getDataType().equals(DataTypes.ENTITY))) {
try {
checkURL(attrDef.getRangeEtypeURL());
} catch (Exception ex) {
throw new IntegrityException("Attribute def " + attrDef.getURL() + " with parent etype " + attrDef.getEtypeURL() + " is of datatype " + attrDef.getDataType() + ", but is has invalid getRangeEtypeURL()", ex);
}
}
try {
checkConcept(attrDef.getConcept());
} catch (Exception ex) {
throw new IntegrityException("Found invalid concept for attr def " + attrDef.getURL(), ex);
}
}
/**
* Checks if provided ekb complies with open entity specs.
*
* @param ekb the entity knowledge base to check
* @throws IntegrityException if provided ekb is not conformant to
* OpenEntity specs.
*/
public static void checkEkbQuick(IEkb ekb) {
if (ekb == null) {
throw new IntegrityException("Found null ekb!");
}
if (ekb.getDefaultLocales() == null) {
throw new IntegrityException("Found null locales list in ekb " + ekb.getClass().getCanonicalName());
}
if (ekb.getDefaultLocales().get(0) == null) {
throw new IntegrityException("Found null first locale in ekb " + ekb.getClass().getCanonicalName());
}
}
public static void checkIDResult(IIDResult idResult) {
if (idResult == null) {
throw new IntegrityException("Found null idResult!");
}
if (idResult.getAssignmentResult() == null) {
throw new IntegrityException("Found null assignment result in idResult: " + idResult);
}
if (idResult.getEntities() == null) {
throw new IntegrityException("Found null result entities! idResult is " + idResult);
}
if (AssignmentResult.REUSE.equals(idResult.getAssignmentResult())
|| AssignmentResult.NEW.equals(idResult.getAssignmentResult())) {
try {
checkURL(idResult.getURL());
} catch (IntegrityException ex) {
throw new IntegrityException("Found invalid URL in idResult! AssignmentResult is " + idResult.getAssignmentResult() + " in idResult " + idResult, ex);
}
for (IEntity entity : idResult.getEntities()) {
try {
checkEntity(entity);
} catch (Exception ex) {
throw new IntegrityException("Failed integrity check on entity " + entity + " in idResult " + idResult, ex);
}
}
}
if (AssignmentResult.REUSE.equals(idResult.getAssignmentResult())) {
checkEntity(idResult.getResultEntity());
if (idResult.getEntities().isEmpty()) {
throw new IntegrityException("Found empty entities in idResult with REUSE. idResult is " + idResult);
}
}
if (AssignmentResult.NEW.equals(idResult.getAssignmentResult())) {
checkEntity(idResult.getResultEntity(), true);
if (!idResult.getEntities().isEmpty()) {
throw new IntegrityException("Found non-empty entities in idResult with NEW. idResult is " + idResult);
}
}
}
/**
* Checks if provided entity complies with open entity specs.
*
* @param entity to check
* @throws IntegrityException if provided entity is not conformant to
* OpenEntity specs.
*/
public static void checkEntity(IEntity entity) {
checkEntity(entity, false);
}
/**
* Checks if provided entity complies with open entity specs. For synthetic
* entities some checks will be skipped.
*
* @param entity to check
* @param synthetic if true URL and local ids of attributes and values will
* not be checked
* @throws IntegrityException if provided entity is not conformant to
* OpenEntity specs.
*/
public static void checkEntity(IEntity entity, boolean synthetic) {
if (entity == null) {
throw new IntegrityException("Found null entity!");
}
try {
checkStructure(entity, synthetic);
} catch (Exception ex) {
throw new IntegrityException("Found invalid structural properties of entity " + entity.getURL(), ex);
}
if (!synthetic) {
try {
checkURL(entity.getURL());
} catch (Exception ex) {
throw new IntegrityException("Found invalid URL in entity " + entity, ex);
}
}
try {
checkDict(entity.getName());
} catch (Exception ex) {
throw new IntegrityException("Found invalid name in entity " + entity.getURL(), ex);
}
try {
checkDict(entity.getDescription());
} catch (Exception ex) {
throw new IntegrityException("Found invalid description in entity " + entity.getURL(), ex);
}
}
/**
* Checks if provided structure complies with open entity specs.
*
* @param structure to check
* @throws IntegrityException if provided structure is not conformant to
* OpenEntity specs.
*/
public static void checkStructure(IStructure structure) {
checkStructure(structure, false);
}
/**
* Checks if provided structure complies with open entity specs. For
* synthetic structures some checks will be skipped.
*
* @param structure the structure to check
* @param synthetic if true URLs and local ids of attributes and values will
* not be checked. The URL of the structure is not checked anyway.
*/
public static void checkStructure(IStructure structure, boolean synthetic) {
if (structure == null) {
throw new IntegrityException("Found null structure!");
}
try {
checkURL(structure.getEtypeURL());
} catch (Exception ex) {
throw new IntegrityException("Found invalid entity type URL in structure " + structure.getURL(), ex);
}
if (structure.getStructureAttributes() == null) {
throw new IntegrityException("Found null attributes in structure " + structure.getURL());
}
for (IAttribute attr : structure.getStructureAttributes()) {
try {
checkAttribute(attr, synthetic);
} catch (Exception ex) {
throw new IntegrityException("Found invalid attribute in structure " + structure.getURL(), ex);
}
}
}
/**
* Checks if provided attribute complies with open entity specs.
*
* @param attribute to check
* @param synthetic if true URL and local ids of attributes and values will
* not be checked
* @throws IntegrityException if provided attribute is not conformant to
* OpenEntity specs.
*/
public static void checkAttribute(IAttribute attribute, boolean synthetic) {
if (attribute == null) {
throw new IntegrityException("Found null attribute!");
}
IAttributeDef attrDef = attribute.getAttrDef();
if (!synthetic && attribute.getLocalID() == null) {
throw new IntegrityException("Found null local ID in attribute " + attribute);
}
if (attrDef == null) {
throw new IntegrityException("Found null attribute definition in attribute " + attribute.getLocalID());
}
if (attribute.getValues() == null) {
throw new IntegrityException("Found null values list in attribute " + attribute.getLocalID());
}
if (attribute.getValuesCount() != attribute.getValues().size()) {
throw new IntegrityException("Found inconsistent values count in attribute " + attribute.getLocalID() + ". ValuesCount = " + attribute.getValuesCount() + ". attr.getValues.().size() = " + attribute.getValues().size());
}
for (IValue val : attribute.getValues()) {
try {
checkValue(val, attrDef, synthetic);
} catch (Exception ex) {
throw new IntegrityException("Found invalid value in attribute " + attribute.getLocalID(), ex);
}
}
}
/**
* Checks if provided attribute complies with open entity specs.
*
* @param attribute to check
* @throws IntegrityException if provided attribute is not conformant to
* OpenEntity specs.
*/
public static void checkAttribute(IAttribute attribute) {
checkAttribute(attribute, false);
}
/**
* Checks if provided value complies with open entity specs.
*
* @param value to check
* @throws IntegrityException if provided value is not conformant to
* OpenEntity specs.
*/
public static void checkValue(IValue value, IAttributeDef attrDef) {
checkValue(value, attrDef, false);
}
/**
* Checks if provided value complies with open entity specs.
*
* @param value to check
* @throws IntegrityException if provided value is not conformant to
* OpenEntity specs.
*/
public static void checkValue(IValue value, IAttributeDef attrDef, boolean synthetic) {
String datatype = attrDef.getDataType();
if (value == null) {
throw new IntegrityException("Found null value!");
}
if (!synthetic && value.getLocalID() == null) {
throw new IntegrityException("Found null local ID in value " + value);
}
if (value.getValue() == null) {
throw new IntegrityException("Found null object in value " + value.getLocalID());
}
//here
if (DataTypes.getDataTypes().get(datatype) == null){
throw new IntegrityException("Found unsupported datatype " + datatype + " in value " + value.getValue() + ". Its class is " + value.getValue().getClass().getName());
}
if (!(DataTypes.getDataTypes().get(datatype).isInstance(value.getValue()))) {
throw new IntegrityException("Found value not corresponding to its datatype " + datatype + ". Value is " + value.getValue() + ". Its class is " + value.getValue().getClass().getName());
}
if (DataTypes.STRUCTURE.equals(datatype)) { // for structures we do deep check
IStructure s = (IStructure) value.getValue();
if (!attrDef.getRangeEtypeURL().equals(s.getEtypeURL())){
throw new IntegrityException("Found structure value with value ID " + value.getLocalID() + " having etype URL different from its attribute rangeEtypeURL! "
+ "\nStructure etype URL: " + s.getEtypeURL() + "\nAttribute rangeEtypeURL: " + attrDef.getRangeEtypeURL());
}
checkStructure(s, synthetic);
}
if (DataTypes.ENTITY.equals(datatype)) { // for entities we only check URL and name
IEntity entity = (IEntity) value.getValue();
if (!synthetic) {
try {
checkURL(entity.getURL());
} catch (IntegrityException ex) {
throw new IntegrityException("Found invalid URL in entity inside value with local ID: " + value.getLocalID());
}
}
try {
checkDict(entity.getName());
} catch (IntegrityException ex) {
throw new IntegrityException("Found invalid name in entity with URL " + entity.getURL() + " inside value with local ID: " + value.getLocalID());
}
}
}
/**
* Checks if provided concept complies with open entity specs.
*
* @param concept to check
* @throws IntegrityException if provided concept is not conformant to
* OpenEntity specs.
*/
public static void checkConcept(IConcept concept) {
if (concept == null) {
throw new IntegrityException("Found null concept!");
}
try {
checkURL(concept.getURL());
} catch (Exception ex) {
throw new IntegrityException("Found invalid URL in concept " + concept, ex);
}
try {
checkDict(concept.getDescription());
} catch (Exception ex) {
throw new IntegrityException("Found invalid description in concept " + concept.getURL(), ex);
}
try {
checkDict(concept.getName());
} catch (Exception ex) {
throw new IntegrityException("Found invalid name in concept " + concept.getURL(), ex);
}
}
/**
* Checks if provided semantic text complies with open entity specs.
*
* @param semanticText to check
* @throws IntegrityException if provided semantic text is not conformant to
* OpenEntity specs.
*/
public static void checkSemanticText(ISemanticText semanticText) {
if (semanticText == null) {
throw new IntegrityException("Found null semantic text!");
}
if (semanticText.getText() == null) {
throw new IntegrityException("Found semantic text containing null text!");
}
if (semanticText.getSentences() == null) {
throw new IntegrityException("Found semantic text with null sentences! Text is '" + semanticText.getText() + "'");
}
for (ISentence s : semanticText.getSentences()) {
checkSentence(s);
}
// todo write the rest...
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy