Skip to content

Use owl:equivalentClass when available #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 31, 2017
Merged

Use owl:equivalentClass when available #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
120 changes: 71 additions & 49 deletions src/hydra/parseHydraDocumentation.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,40 @@ function removeTrailingSlash(url) {
return url
}

/**
*
* @param {object} docs
* @param {object} property
* @return {string|null}
*/
function findRelatedClass(docs, property) {
// Use the entrypoint property's owl:equivalentClass if available
if (property['http://www.w3.org/2000/01/rdf-schema#range']) {
for (const range of property['http://www.w3.org/2000/01/rdf-schema#range']) {
const equivalentClass = range['http://www.w3.org/2002/07/owl#equivalentClass'];
if (equivalentClass && 'http://www.w3.org/ns/hydra/core#member' === equivalentClass[0]['http://www.w3.org/2002/07/owl#onProperty'][0]['@id']) {
//console.log('==>'+equivalentClass[0]['http://www.w3.org/2002/07/owl#allValuesFrom'][0]['@id']);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you kept the console.logs?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I noticed, I'm working on a follow up PR.

return findSupportedClass(docs, equivalentClass[0]['http://www.w3.org/2002/07/owl#allValuesFrom'][0]['@id']);
}
}
}

// As a fallback, find an operation available on the property of the entrypoint returning the searched type (usually POST)
for (const entrypointSupportedOperation of property['http://www.w3.org/ns/hydra/core#supportedOperation']) {
if (!entrypointSupportedOperation['http://www.w3.org/ns/hydra/core#returns']) {
continue;
}

const returns = entrypointSupportedOperation['http://www.w3.org/ns/hydra/core#returns'][0]['@id'];
if (0 !== returns.indexOf('http://www.w3.org/ns/hydra/core')) {
//console.log(returns);
return findSupportedClass(docs, returns);
}
}

return null;
}

/**
* Parses a Hydra documentation and converts it to an intermediate representation.
*
Expand All @@ -110,61 +144,49 @@ export default function parseHydraDocumentation(entrypointUrl, options = {}) {
const readableFields = [], resourceFields = [], writableFields = [];

// Add fields
for (const entrypointSupportedOperation of property['http://www.w3.org/ns/hydra/core#supportedOperation']) {
const returns = entrypointSupportedOperation['http://www.w3.org/ns/hydra/core#returns'];
const relatedClass = findRelatedClass(docs, property);
if (null === relatedClass) {
continue;
}

// Skip operations not having a return type
if (!returns) {
continue;
}
for (const supportedProperties of relatedClass['http://www.w3.org/ns/hydra/core#supportedProperty']) {
const supportedProperty = supportedProperties['http://www.w3.org/ns/hydra/core#property'][0];
const range = supportedProperty['http://www.w3.org/2000/01/rdf-schema#range'] ? supportedProperty['http://www.w3.org/2000/01/rdf-schema#range'][0]['@id'] : null;

const className = returns[0]['@id'];
if (0 === className.indexOf('http://www.w3.org/ns/hydra/core')) {
continue;
const field = new Field(
supportedProperty['http://www.w3.org/2000/01/rdf-schema#label'][0]['@value'],
{
id: supportedProperty['@id'],
range,
reference: 'http://www.w3.org/ns/hydra/core#Link' === property['@type'][0] ? range : null, // Will be updated in a subsequent pass
required: supportedProperties['http://www.w3.org/ns/hydra/core#required'] ? supportedProperties['http://www.w3.org/ns/hydra/core#required'][0]['@value'] : false,
description: supportedProperties['http://www.w3.org/ns/hydra/core#description'] ? supportedProperties['http://www.w3.org/ns/hydra/core#description'][0]['@value'] : ''
},
);

fields.push(field);
resourceFields.push(field);

if (supportedProperties['http://www.w3.org/ns/hydra/core#readable'][0]['@value']) {
readableFields.push(field);
}

const supportedClass = findSupportedClass(docs, className);
for (const supportedProperties of supportedClass['http://www.w3.org/ns/hydra/core#supportedProperty']) {
const supportedProperty = supportedProperties['http://www.w3.org/ns/hydra/core#property'][0];
const range = supportedProperty['http://www.w3.org/2000/01/rdf-schema#range'] ? supportedProperty['http://www.w3.org/2000/01/rdf-schema#range'][0]['@id'] : null;

const field = new Field(
supportedProperty['http://www.w3.org/2000/01/rdf-schema#label'][0]['@value'],
{
id: supportedProperty['@id'],
range,
reference: 'http://www.w3.org/ns/hydra/core#Link' === property['@type'][0] ? range : null, // Will be updated in a subsequent pass
required: supportedProperties['http://www.w3.org/ns/hydra/core#required'] ? supportedProperties['http://www.w3.org/ns/hydra/core#required'][0]['@value'] : false,
description: supportedProperties['http://www.w3.org/ns/hydra/core#description'] ? supportedProperties['http://www.w3.org/ns/hydra/core#description'][0]['@value'] : ''
},
);

fields.push(field);
resourceFields.push(field);

if (supportedProperties['http://www.w3.org/ns/hydra/core#readable'][0]['@value']) {
readableFields.push(field);
}

if (supportedProperties['http://www.w3.org/ns/hydra/core#writable'][0]['@value']) {
writableFields.push(field);
}
if (supportedProperties['http://www.w3.org/ns/hydra/core#writable'][0]['@value']) {
writableFields.push(field);
}

resources.push(new Resource(
guessNameFromUrl(entrypoint[0][property['@id']][0]['@id'], entrypointUrl),
entrypoint[0][property['@id']][0]['@id'],
{
id: supportedClass['@id'],
title: supportedClass['http://www.w3.org/ns/hydra/core#title'][0]['@value'],
fields: resourceFields,
readableFields,
writableFields
}
));

break;
}

resources.push(new Resource(
guessNameFromUrl(entrypoint[0][property['@id']][0]['@id'], entrypointUrl),
entrypoint[0][property['@id']][0]['@id'],
{
id: relatedClass['@id'],
title: relatedClass['http://www.w3.org/ns/hydra/core#title'][0]['@value'],
fields: resourceFields,
readableFields,
writableFields
}
));
}

// Resolve references
Expand Down
25 changes: 8 additions & 17 deletions src/hydra/parseHydraDocumentation.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -324,23 +324,14 @@ const docs = `{
"@type": "hydra:Link",
"domain": "#Entrypoint",
"rdfs:label": "The collection of Book resources",
"range": "hydra:PagedCollection",
"hydra:supportedOperation": [
{
"@type": "hydra:Operation",
"hydra:method": "GET",
"hydra:title": "Retrieves the collection of Book resources.",
"rdfs:label": "Retrieves the collection of Book resources.",
"returns": "hydra:PagedCollection"
},
{
"@type": "hydra:CreateResourceOperation",
"expects": "http://schema.org/Book",
"hydra:method": "POST",
"hydra:title": "Creates a Book resource.",
"rdfs:label": "Creates a Book resource.",
"returns": "http://schema.org/Book"
}
"rdfs:range": [
{"@id": "hydra:PagedCollection"},
{
"owl:equivalentClass": {
"owl:onProperty": {"@id": "hydra:member"},
"owl:allValuesFrom": {"@id": "http://schema.org/Book"}
}
}
]
},
"hydra:title": "The collection of Book resources",
Expand Down