SemanticMake

Project developed to assist the development of web applications that aim to store semantic content. This framework was developed in Java a with the help of the JENA framework to get more facilitates in the the manipulation of semantic content.

Content

Requisites
Use
ClientApi
Documentation
- Javadoc

Requisites

Java 8+
Fuseki 3+: Must be running and have a dataset called SemanticContent.
Intellij Lombok Plugin: Version: 0.14.16
Spring Framework: Boot starter version: 1.5.7
Maven 3+: This dependency manager is responsible for all dependencies of this project

Use

To use this framework it is necessary to import the * .jar created by this project and to use its available classes as required. New classes and objects can be added furthermore to those provided by SemanticMake. If there is interest in using the API it's necessary import client library into JavaScript that is directed to this API. There are methods to add vocabularies (addVocabulary), triples (addTriple) and save the contents of the resource (saveResource), As well as those available in the framework. In this API there are four representation of property in a resource (ontology):

A property like triple that guards subject, predicate and literal

    <foaf:familyName>Brickley</foaf:familyName>
    [{
        "propertyName":"familyName",
        "value":"Brickley",
        "asResouce":false,
        "subPropertyOf":"",
        "prefix":"foaf"
    }]

A property like triple that holds subject, predicate and URI of another resource

    <foaf:openid rdf:resource="http://danbri.org/" />
    [{
        "propertyName":"openid",
        "value":"http://danbri.org/",
        "asResouce":true,
        "subPropertyOf":"",
        "prefix":"foaf"
    }]

A subpropriety as triple that guards subject, predicate and literal

   <vcard:hasAddred>
       <vcard:country-name>Brazil</vcard:country-name>
   </vcard:hasAddred>
   [
       {
           "propertyName":"hasAddress",
           "value":"",
           "asResouce":true,
           "subPropertyOf":"",
           "prefix":"vcard"
       },
       {
           "propertyName":"country-name",
           "value":"Brazil",
           "asResouce":false,
           "subPropertyOf":"hasAddress",
           "prefix":"vcard"
       }
   ]

A subpropriety as a triple that holds subject, predicate and URI of another resource

   <vacard:hasEmail>
       <vcard:hasValue rdf:resource="eudesdionatas@gmail.com" />
   </vacard:hasEmail>
   [
       {
           "propertyName":"hasEmail",
           "value":"",
           "asResouce":true,
           "subPropertyOf":"",
           "prefix":"vcard"
       },
       {
           "propertyName":"hasValue",
           "value":"eudesdionatas@gmail.com",
           "asResouce":true,
           "subPropertyOf":"hasEmail",
           "prefix":"vcard"
       }
   ]

To clarify how the data should be passed, an interface has been developed that shows the structure of the data as they are formed and in parallel are presented the arguments that must be passed to form the structure in question.

Client API

As well as the classes and objects provided by SemanticMake, the API has classes and objects for its operation: a constructor method, "SemanticAPI", which receives the base url that has the address of where the api is. To create a new resource (ontology instance) you must use the constructor method of the "Resource" class. To add new vocabularies to a resource you must use the "addVocabulary" method of Resource, to add new triples you must use the "addTriple" method of "Resource". At the end of this document there is a section showing an example of using the client side for API. Such methods are useful for facilitating the creation of the resource in an atomic operation.

Resource Format (Ontology instance)

{
    "prefix": "resourcePrefix",
    "name": "resourceName",
    "uri": "resourceURI",
    "vocabularies": [
        { "uri": "vocabURI",
          "prefix": "vocabPrefix",
          "pairs": [
            { "propertyName": "propertyName",
              "value": "propertyValue"
              "asResource": true
              "subPropetyOf": "anotherProperty"  
            }
          ]
        }
    ] 
}

Sample of use

   const config = { 
     baseURL: 'http://localhost:8080/'
     workspace: 'workspace-123456'
   }
   const api = new SemanticAPI(config)
   const resource = new Resource('contactData', 'contact', 'http://contactmail.com#Person')
   resource.addVocabulary('schema', 'http://schema.org/')
   resource.addTriple('schema', 'email', 'emailValue')
   resource.addTriple('schema', 'name', 'nameValue')
   const resourceToSend = resource.getResourceToSend()
   api.saveResource(resourceToSend)
     .then(...)
     .catch(...)

Documentation

The framework presentation application has the documentation of both the framework as well as the API.

(Framework): The documentation of the framework was made by the automatic generation of documentation in the Javadoc style by Intellij, based on comments from the source code.
(API): The API documentation is shown in the framework presentation application

Swagger UI (API testing application)

To test the operation of all API methods, Swagger provides an interface with input field, use and output examples to test the tool. This was the alternative used for documentation of REST methods. To open the Swagger the application SemanticApi need be running.

Support and development

Developed by Eudes Souza with Intellij IDEA 2016.3.5

WiserUFBA / SemanticMake-2.0