package OWL2generator;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.ListIterator;
/**
* SharedUtils class offers a collection of utility methods
* for OWL/XML ontology generation within the framework. It doesn't directly
* belong to any specific class but functions as a helper.
* SharedUtils acts as a utility class, providing reusable
* functionalities for building the OWL ontology structure. It
* helps in creating declarations for classes, individuals, properties,
* and their relationships within the ontology based on text file
* configurations.
*
* Key Functionalities:
*
* Generates OWL code snippets for various ontology elements:
*
*
* - Classes (
declareClass, declareSubClass)
* - Individuals (
genIndividual) with their declarations, class
* assertions, and annotations
* - Object properties (
genObjPropDecl) with potential
* super-properties and annotations
* - Sub-object property relationships (
genSubObjProp)
* - Inverse object properties (
genInverseObjProps)
* - OWL class individual triplets (
genTriplet)
*
*
* Formats class names with a project-wide IRI prefix (formatClassName)
*
* Generates annotation assertions (genAnnotationAssertion)
*
* Defines constants like IRI (Internationalized Resource Identifier)
*
* Additional Notes:
*
* The class utilizes a constant IRI (Internationalized Resource Identifier)
* to serve as a prefix for all identifiers within the generated ontology.
*
* A boolean flag GENERATE_HEADER controls whether comments are included in
* the generated XML for better human readability during development
* (currently disabled).
*
* Some methods (like genObjPropDomainAndRange) are currently not used,
* suggesting potential future extensibility for associating domain and
* range OWL classes with object properties.
*
* Environment:
*
* - IDE: Eclipse IDE for Java Developers
*
- Version: 2021-12 (4.22.0)
*
- Build id: 20211202-1639
*
- HW Model Name: iMac, MacOS Monterey, 12.5.1
*
- Processor Name: Quad-Core Intel Core i5
*
- Processor Speed: 3.2 GHz
*
- Memory: 32 GB 1867 MHz DDR3
*
- Disk: APPLE SSD SM0256G
*
- Serial: DGKRC080GG7V
*
* @version 1-001
* @since 2024/05/24
* @author Edit Hlaszny (https://www.edithlaszny.eu/ edithlaszny@gmail.com)
*/
public class SharedUtils
{
/**
* W3C-defined separator between IRI and unique variable name
*/
private final String SEPARATOR = "#" ;
SharedUtils()
{
;
} // end of constructor()
public String getCurrTime()
{
String format = "yyyy-MM-dd HH:mm:ss.SSS" ;
return new SimpleDateFormat(format).format(new Date()) ;
} // end of method getCurrTime()
public String assertClassAnnotation(String class_IRI,
String annotation_type_IRI,
String language,
String annotation
)
{
return " \n" +
" \n" +
" " + this.SEPARATOR + class_IRI + "\n" +
" " + annotation + "\n" +
" \n" ;
} // end of method assertClassAnnotation()
/**
* Declares OWL subclass according to OWL2 XML Syntax
*
* @param superClass Name of the OWL superclass
* @param subClass Name of the OWL subclass
*
* @return XML code snippet
*/
public String declareSubClass(String superClass,
String subClass
)
{
/**
* compensating the Protege's displaying error
*/
if (superClass.equals("owl:Thing"))
{
/*
System.out.println(" Superclass (" + superClass + ") is \"owl:Thing\" at Sociology" +
" - NOT GENERATED...");
*/
return "" ;
}
return " \n" +
" \n" +
" \n" +
" \n" ;
} // end of method declareSubClass()
/**
* Declares BFO subclass according to OWL2 XML Syntax
*
* @param superClass Name of the OWL superclass
* @param subClass Name of the OWL subclass
*
* @return XML code snippet
*/
public String declareBFOsubClass(String superClass,
String subClass
)
{
/**
* compensating the Protege's displaying error
*/
if (superClass.equals("owl:Thing"))
{
/*
System.out.println(" Superclass (" + superClass + ") is \"owl:Thing\" at BFO" +
" - NOT GENERATED...");
*/
return "" ;
}
return " \n" +
" \n" +
" \n" +
" \n" ;
} // end of method declareBFOsubClass()
public String declareClass(String class_IRI)
{
return " \n" +
" \n" +
" \n" ;
} // end of method declareClass()
public String addHdrAnnotation(String iri,
String literal
)
{
return " \n" +
" \n" +
" " + literal + "\n" +
" \n" ;
} // end of addHdrAnnotation()
public String declareIAOannotation(String abbreviated_IRI)
{
return " \n" +
" \n" +
" \n" ;
} // end of method declareIAOannotation()
public String addSKOSannotation(String skos_annotation)
{
return " \n" +
" \n" +
" \n" ;
} // end of method addIAOannotation()
public String declareObjectproperty(String objectProperty)
{
return
" \n" +
" \n" +
" \n" ;
} // end of method declareObjectproperty()
public String setSubObjectPropertyOf(String objectProperty,
String superObjectProperty
)
{
if (superObjectProperty.equals("owl:topObjectProperty") == false)
{
/**
* if the superObjectProperty is NOT the 'owl:topObjectProperty' than
* must be prefixed with the SEPARATOR
*/
superObjectProperty = this.SEPARATOR + superObjectProperty ;
}
return
" \n" +
" \n" +
" \n" +
" \n" ;
} // end of method setSubObjectPropertyOf()
public String annotateObjectProperty(String object_property_IRI,
String annotation_type_IRI,
String language ,
String annotation
)
{
return
" \n" +
" \n" +
" " + this.SEPARATOR + object_property_IRI + "\n" +
" \"" + annotation + "\"\n" +
" \n" +
" \n" ;
} // end of method annotateObjectProperty()
public String setInverseObjectProperties(String objProp_IRI_1,
String objProp_IRI_2
)
{
return
" \n" +
" \n" +
" \n" +
" " ;
} // end of method setInverseObjectProperties()
public String declareIndividual(String namedIndividual)
{
return
" \n" +
" \n" +
" \n" ;
} // end of method declareIndividual()
public String assertIndividual(String classIRI,
String namedIndividual)
{
return
" \n" +
" \n" +
" \n" +
" \n" ;
} // end of method assertIndividual()
public String classAssertion(String namedIndividual,
String annotation)
{
return
" \n" +
" \n" +
" " + this.SEPARATOR + namedIndividual + "\n" +
" " + annotation + "\n" +
" \n" ;
} // end of method classAssertion()
public String assertObjectProperty(String objectProperty,
String subjectIndividual,
String objectIndividual)
{
// 2x if inverse obj prop does exist !
return
" \n" +
" \n" +
" \n" +
" \n" +
" \n" ;
} // end of method assertObjectProperty()
public String declareDataProperty(String dataProperty)
{
return
" \n" +
" \n" +
" \n" ;
} // end of method declareDataProperty()
public String declareDataSubProperty(String dataProperty,
String superDataProperty
)
{
return
" \n" +
" \n" +
" \n" +
" \n" ;
} // end of method declareDataSubProperty()
public String annotateDataProperty(String dataProperty,
String annotation,
String annotationType,
String language
)
{
return
" \n" +
" \n" +
" " + this.SEPARATOR + dataProperty + "\n" +
" " + annotation + "\n" +
" \n" ;
} // end of method annotateDataProperty()
public String assertDataProperty(String dataProperty,
String namedIndividual,
String dataType,
String dataValue
)
{ // call it AFTER a triplet definition !
return
" \n" +
" \n" +
" \n" +
" " + dataValue + "\n" +
" \n" ;
} // end of method assertDataProperty()
// ------------------------- object property handling methods ------------------------
public String declareObjectPropertyData(TypeOf_ObjectProperty op)
{
String OWLcommand =
"\n \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" #" + op.object_property_IRI + "\n" +
" \"" + op.annotation + "\"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" ;
String supObjProp_IRI = op.super_object_property_IRI ;
// # prefix is conditional
if (supObjProp_IRI.compareTo("owl:topObjectProperty") != 0)
supObjProp_IRI = "#" + supObjProp_IRI ;
OWLcommand +=
" \n" +
" \n" +
" \n" +
" \n" ;
if (op.opc.ch_functional )
{
OWLcommand +=
" \n" +
" \n" +
" \n" ;
}
if (op.opc.ch_inverseFunctional )
{
OWLcommand +=
" \n" +
" \n" +
" \n" ;
}
if (op.opc.ch_symmetric )
{
OWLcommand +=
" \n" +
" \n" +
" \n" ;
}
if (op.opc.ch_asymmetric )
{
OWLcommand +=
" \n" +
" \n" +
" \n" ;
}
if (op.opc.ch_transitive )
{
OWLcommand +=
" \n" +
" \n" +
" \n" ;
}
if (op.opc.ch_transitive )
{
OWLcommand +=
" \n" +
" \n" +
" \n" ;
}
if (op.opc.ch_irReflexive )
{
OWLcommand +=
" \n" +
" \n" +
" \n" ;
}
return OWLcommand ;
/** triplet defs
**/
} // end of method declareObjectPropertyData()
// ------------------------- data property handling methods --------------------------
public String declareDataPropertyData(TypeOf_DataProperty dp)
{
String OWLcommand =
"\n \n" +
" " + "\n" +
" " + "\n" +
" " + "\n" +
" " + "\n" +
" " + "\n" +
" " + "\n" +
" " + "\n" +
" " + "\n" +
" " + "\n" +
" #" + dp.data_property_IRI + "" + "\n" +
" \"" + dp.data_property_annotationtype + "\"" + "\n" +
" " + "\n" +
" " + "\n" +
" " + "\n" +
" " + "\n" +
" " + "\n" ;
return OWLcommand ;
} // end of method declareDataPropertyData()
public void dsplyFatalMsgAndExit(String msg, int exitCode)
{
System.err.println(msg) ;
System.exit(exitCode);
} // end of method dsplyFatalMsgAndExit()
} // end of class SharedUtils