it.uniroma2.art.lime.model

Interface LIMEModel

All Superinterfaces:

it.uniroma2.art.owlart.model.ARTNodeFactory

All Known Implementing Classes:

LIMEModelImpl

public interface LIMEModel
extends it.uniroma2.art.owlart.model.ARTNodeFactory

A Java model of a LIME description. Usually, a description is about one dataset (the primary topic), but it may refer to other datasets, as well. This model accounts for the existence of multiple datasets by introducing the notion of working dataset, which is the implicit argument of any operation that operates on datasets.

Method Summary

Methods

Modifier and Type	Method and Description
void	addDataset(it.uniroma2.art.owlart.model.ARTResource dataset) Adds a dataset to this model.
void	addDatasetType(it.uniroma2.art.owlart.model.ARTURIResource datasetType) Sets the type of the working dataset.It is equivalent to the following SPARQL update executed (with inference) on the underlying OWL model: insert { ?
void	addLanguage(String language) Registers that the dataset supports the given natural language.
void	addLinguisticModel(it.uniroma2.art.owlart.model.ARTURIResource linguisticModel) Adds a linguistic model.
void	close() Closes the undelying OWL model.
void	deleteDataset(it.uniroma2.art.owlart.model.ARTResource resource) Deletes the dataset resource from this description.
it.uniroma2.art.owlart.models.OWLModel	getOWLModel() Returns the underlying OWL Model.
it.uniroma2.art.owlart.model.ARTResource	getPrimaryDataset() Returns the primary dataset of this model.
it.uniroma2.art.owlart.model.ARTResource	getWorkingDataset() Returns the dataset which this model operations implicitly work on.
boolean	hasDataset(it.uniroma2.art.owlart.model.ARTResource resource) Checks whether a given resource is a dataset described by this model.
boolean	hasGlosses() Checks whether the working dataset has glosses.
boolean	hasHumanReadableLocalNames() Checks whether the working dataset has human readable local names.
boolean	hasLanguage(String language) Checks whether the working datasets supports the given language.
boolean	hasLinguisticModel(it.uniroma2.art.owlart.model.ARTURIResource linguisticModel) Checks if the dataset adopts the given linguistic model.
boolean	hasPrimaryDataset(it.uniroma2.art.owlart.model.ARTResource resource) Checks wheter resource is the primary dataset of this description.
boolean	hasTaxonomy() Checks whether the working dataset has a taxonomy.
boolean	hasUsageExamples() Checks whether the working dataset has usage examples.
it.uniroma2.art.owlart.navigation.ARTResourceIterator	listDatasets() Lists the datasets described in this model.
it.uniroma2.art.owlart.navigation.ARTURIResourceIterator	listDatasetTypes() Lists the types of the working dataset.
Iterator<String>	listLanguages() Lists the natural languages (identified as RDF language tags) in which the working dataset is described.
it.uniroma2.art.owlart.navigation.ARTURIResourceIterator	listLinguisticModels() Lists the models adopted for the linguistic characterization of the working dataset.
void	removeDatasetType(it.uniroma2.art.owlart.model.ARTURIResource datasetType) Removes the assertion that the working dataset is of the given type.
void	removeLanguage(String language) Removes the indication that the working dataset supports a given natural language.
void	removeLinguisticModel(it.uniroma2.art.owlart.model.ARTURIResource linguisticModel) Removes the given lingusitic model from the working dataset.
void	removePrimaryDataset(it.uniroma2.art.owlart.model.ARTResource dataset) Removes the primary dataset of this model.
void	setHasGlosses(boolean glosses) Registers that the working dataset has a glosses.
void	setHasHumanReadableLocalNames(boolean humanReadable) Registers that the working dataset has usage examples.
void	setHasTaxonomy(boolean taxonomy) Registers that the working dataset has a taxonomy.
void	setHasUsageExamples(boolean usageExamples) Registers that the working dataset has usage examples.
void	setLanguageCoverage(String lang, it.uniroma2.art.owlart.model.ARTURIResource resourceType, CoverageObservation coverageObservation) Registers the extent to a given natural language covers a resource type in the working dataset.
void	setLexicalResourceCoverage(it.uniroma2.art.owlart.model.ARTURIResource lexicalResource, it.uniroma2.art.owlart.model.ARTURIResource resourceType, CoverageObservation coverageObservation) Registers the extent to a given lexical resource covers a resource type in the working dataset by means of explicit links.
void	setPrimaryDataset(it.uniroma2.art.owlart.model.ARTResource dataset) Sets the primary dataset of this model.
void	setWorkingDataset(it.uniroma2.art.owlart.model.ARTResource dataset) Sets the dataset which is implicitly passed to every operation dealing with datasets.
Iterator<ImmutablePair<it.uniroma2.art.owlart.model.ARTURIResource,CoverageObservation>>	sliceCoverageByLanguage(String lang) Slices the resource coverage by language.
Iterator<ImmutablePair<it.uniroma2.art.owlart.model.ARTURIResource,CoverageObservation>>	sliceCoverageByLexicalResource(it.uniroma2.art.owlart.model.ARTURIResource lexicalResource) Slices the resource coverage by lexical resource.
Iterator<ImmutablePair<String,CoverageObservation>>	sliceLanguageCoverageByResourceType(it.uniroma2.art.owlart.model.ARTURIResource resourceType) Slices the resource coverage by resource type.
Iterator<ImmutablePair<it.uniroma2.art.owlart.model.ARTURIResource,CoverageObservation>>	sliceLexicalResourceCoverageByResourceType(it.uniroma2.art.owlart.model.ARTURIResource resourceType) Slice the coverage of links to a lexical resource by resource type.
void	write(File outputFile, it.uniroma2.art.owlart.io.RDFFormat rdfFormat) Writes the LIME description to a file
void	write(OutputStream outputStream, it.uniroma2.art.owlart.io.RDFFormat rdfFormat) Writes the LIME description to an output stream

Methods inherited from interface it.uniroma2.art.owlart.model.ARTNodeFactory

createBNode, createBNode, createLiteral, createLiteral, createLiteral, createStatement, createURIResource

Method Detail

addDataset

void addDataset(it.uniroma2.art.owlart.model.ARTResource dataset)
                throws it.uniroma2.art.owlart.exceptions.ModelUpdateException

Adds a dataset to this model. It is equivalent to the following SPARQL update executed (with inference) on the underlying OWL model:

 prefix foaf: 
 prefix void: 
 
 insert {
    <>       foaf:topic ?dataset .
    ?dataset     a      void:Dataset .
 }
 where {
    bind([...] as ?dataset)
 }
 

Parameters:

dataset -

Throws:

it.uniroma2.art.owlart.exceptions.ModelUpdateException

listDatasets

it.uniroma2.art.owlart.navigation.ARTResourceIterator listDatasets()
                                                                   throws it.uniroma2.art.owlart.exceptions.ModelAccessException

Lists the datasets described in this model. It is equivalent to the following SPARQL query executed (with inference) on the underlying OWL model:

 prefix foaf: 
 prefix void: 
 
 select distinct ?dataset {
    <>       foaf:topic ?dataset .
    ?dataset     a      void:Dataset.
 }
 

Returns:

the datasets described by this model

Throws:

it.uniroma2.art.owlart.exceptions.ModelUpdateException

it.uniroma2.art.owlart.exceptions.ModelAccessException

hasDataset

boolean hasDataset(it.uniroma2.art.owlart.model.ARTResource resource)
                   throws it.uniroma2.art.owlart.exceptions.ModelAccessException

Checks whether a given resource is a dataset described by this model. It is equivalent to the following SPARQL query executed (with inference) on the underlying OWL model:

 prefix foaf: 
 
 ask {
    bind([...] as ?dataset)
    <>       foaf:topic ?dataset .
 }
 

Parameters:

resource -

Returns:

Throws:

it.uniroma2.art.owlart.exceptions.ModelAccessException

deleteDataset

void deleteDataset(it.uniroma2.art.owlart.model.ARTResource resource)
                   throws it.uniroma2.art.owlart.exceptions.ModelUpdateException

Deletes the dataset resource from this description. It is equivalent to the following SPARQL update executed (with inference) on the underlying OWL model:

 prefix foaf: 
 
 delete {
    ?subject ?predicate ?object .
 }
 where {
    bind([...] as ?resource)
    ?subject ?predicate ?object .
    filter(?subject = ?resource || ?object = ?resource)
 }
 

Parameters:

resource -

Throws:

it.uniroma2.art.owlart.exceptions.ModelUpdateException

setPrimaryDataset

void setPrimaryDataset(it.uniroma2.art.owlart.model.ARTResource dataset)
                       throws it.uniroma2.art.owlart.exceptions.ModelUpdateException

Sets the primary dataset of this model. It is equivalent to the following SPARQL update executed (with inference) on the underlying OWL model:

 prefix foaf: 
 
 delete {
    <>  foaf:primaryTopic ?oldDataset .
 }
 insert {
    <>    foaf:primaryTopic ?dataset .
 }
 where {
    optional {
       <> foaf:primaryTopic ?oldDataset .
    }
 }
 

Parameters:

dataset - the dataset to describe as primary

Throws:

it.uniroma2.art.owlart.exceptions.ModelUpdateException

getPrimaryDataset

it.uniroma2.art.owlart.model.ARTResource getPrimaryDataset()
                                                           throws it.uniroma2.art.owlart.exceptions.ModelAccessException

Returns the primary dataset of this model. It is equivalent to the following SPARQL query executed (with inference) on the underlying OWL model:

 prefix foaf: 
 
 select distinct ?dataset {
    <> foaf:primaryTopic ?dataset .
 } limit 1
 

Returns:

the primary dataset, or null if it is not specified

Throws:

it.uniroma2.art.owlart.exceptions.ModelAccessException

hasPrimaryDataset

boolean hasPrimaryDataset(it.uniroma2.art.owlart.model.ARTResource resource)
                          throws it.uniroma2.art.owlart.exceptions.ModelAccessException

Checks wheter resource is the primary dataset of this description. It is equivalent to the following SPARQL query executed (with inference) on the underlying OWL model:

 prefix foaf: 
 
 ask {
    bind([...] as ?dataset)
    <> foaf:primaryTopic ?dataset .
 } limit 1
 

Parameters:

resource -

Returns:

Throws:

it.uniroma2.art.owlart.exceptions.ModelAccessException

removePrimaryDataset

void removePrimaryDataset(it.uniroma2.art.owlart.model.ARTResource dataset)
                          throws it.uniroma2.art.owlart.exceptions.ModelAccessException,
                                 it.uniroma2.art.owlart.exceptions.ModelUpdateException

Removes the primary dataset of this model. It is equivalent to the following SPARQL update executed (with inference) on the underlying OWL model:

 prefix foaf: 
 
 delete {
    <>       foaf:primaryTopic ?dataset .
 }
 where {
    bind([...] as ?dataset)
 }
 

Throws:

it.uniroma2.art.owlart.exceptions.ModelAccessException

it.uniroma2.art.owlart.exceptions.ModelUpdateException

setWorkingDataset

void setWorkingDataset(it.uniroma2.art.owlart.model.ARTResource dataset)

Sets the dataset which is implicitly passed to every operation dealing with datasets. If dataset is null, then the model works on the primary dataset.

Parameters:

dataset - the dataset to work on

getWorkingDataset

it.uniroma2.art.owlart.model.ARTResource getWorkingDataset()
                                                           throws it.uniroma2.art.owlart.exceptions.ModelAccessException

Returns the dataset which this model operations implicitly work on. This method throws an unchecked exception if the working dataset has not been set, nor the model has a primary dataset.

Returns:

the working dataset

Throws:

it.uniroma2.art.owlart.exceptions.ModelAccessException

addDatasetType

void addDatasetType(it.uniroma2.art.owlart.model.ARTURIResource datasetType)
                    throws it.uniroma2.art.owlart.exceptions.ModelUpdateException,
                           it.uniroma2.art.owlart.exceptions.ModelAccessException

Sets the type of the working dataset.It is equivalent to the following SPARQL update executed (with inference) on the underlying OWL model:

 insert {
    ?workingDataset a ?datasetType.
 }
 where {
    bind([...] as ?workingDataset)
    bind([...] as ?datasetType)
 }
 

Note. if datasetType does not appear to subclass void:Dataset an unchecked IllegalArgumentException is thrown.

Parameters:

datasetType -

Throws:

it.uniroma2.art.owlart.exceptions.ModelUpdateException

it.uniroma2.art.owlart.exceptions.ModelAccessException

listDatasetTypes

it.uniroma2.art.owlart.navigation.ARTURIResourceIterator listDatasetTypes()
                                                                          throws it.uniroma2.art.owlart.exceptions.ModelAccessException

Lists the types of the working dataset. It is equivalent to the following SPARQL query executed (with inference) on the underlying OWL model:

 select ?datasetType {
    bind([...] as ?workingDataset)
    ?workingDataset a ?datasetType.
    ?workingDataset rdfs:subClassOf void:Dataset .
    filter(?datasetType != void:Dataset)
 }
 

Returns:

Throws:

it.uniroma2.art.owlart.exceptions.ModelAccessException

removeDatasetType

void removeDatasetType(it.uniroma2.art.owlart.model.ARTURIResource datasetType)
                       throws it.uniroma2.art.owlart.exceptions.ModelUpdateException,
                              it.uniroma2.art.owlart.exceptions.ModelAccessException

Removes the assertion that the working dataset is of the given type. It is equivalent to the following SPARQL update executed (with inference) on the underlying OWL model:

 delete {
    ?workingDataset a ?datasetType.
 }
 where {
    bind([...] as ?workingDataset)
    bind([...] as ?datasetType)
 }
 

Throws:

it.uniroma2.art.owlart.exceptions.ModelUpdateException

it.uniroma2.art.owlart.exceptions.ModelAccessException

addLinguisticModel

void addLinguisticModel(it.uniroma2.art.owlart.model.ARTURIResource linguisticModel)
                        throws it.uniroma2.art.owlart.exceptions.ModelUpdateException,
                               it.uniroma2.art.owlart.exceptions.ModelAccessException

Adds a linguistic model. Note that a linguistic model should be mentioned by the URI associated with the vocabulary, usually its base URI.It is equivalent to the following SPARQL update executed (with inference) on the underlying OWL model:

 prefix lime: 
 
 insert {
    ?workingDataset lime:linguisticModel ?linguisticModel .
 }
 where {
    bind([...] as ?workingDataset)
    bind([...] as ?linguisticModel)
 }

Parameters:

linguisticModel - the URI of a linguistic model (e.g. RDFS, SKOS, SKOS-XL, ...)

Throws:

it.uniroma2.art.owlart.exceptions.ModelUpdateException

it.uniroma2.art.owlart.exceptions.ModelAccessException

listLinguisticModels

it.uniroma2.art.owlart.navigation.ARTURIResourceIterator listLinguisticModels()
                                                                              throws it.uniroma2.art.owlart.exceptions.ModelAccessException

Lists the models adopted for the linguistic characterization of the working dataset. This method returns the most specific type that are subclass of void:Dataset

Returns:

the linguistic models

Throws:

it.uniroma2.art.owlart.exceptions.ModelAccessException

hasLinguisticModel

boolean hasLinguisticModel(it.uniroma2.art.owlart.model.ARTURIResource linguisticModel)
                           throws it.uniroma2.art.owlart.exceptions.ModelAccessException

Checks if the dataset adopts the given linguistic model. It is equivalent to the following SPARQL query executed (with inference) on the underlying OWL model:

 prefix lime: 
 
 ask {
    bind([...] as ?workingDataset)
    bind([...] as ?linguisticModel)
    ?workingDataset lime:linguisticModel ?linguisticModel .
 }
 

Parameters:

linguisticModel -

Returns:

Throws:

it.uniroma2.art.owlart.exceptions.ModelAccessException

removeLinguisticModel

void removeLinguisticModel(it.uniroma2.art.owlart.model.ARTURIResource linguisticModel)
                           throws it.uniroma2.art.owlart.exceptions.ModelUpdateException,
                                  it.uniroma2.art.owlart.exceptions.ModelAccessException

Removes the given lingusitic model from the working dataset. It is equivalent to the following SPARQL update executed (with inference) on the underlying OWL model:

 prefix lime: 
 
 delete {
    ?workingDataset lime:linguisticModel ?linguisticModel .
 } where {
    bind([...] as ?workingDataset)
    bind([...] as ?linguisticModel)
 }
 

Parameters:

linguisticModel -

Throws:

it.uniroma2.art.owlart.exceptions.ModelUpdateException

it.uniroma2.art.owlart.exceptions.ModelAccessException

addLanguage

void addLanguage(String language)
                 throws it.uniroma2.art.owlart.exceptions.ModelUpdateException,
                        it.uniroma2.art.owlart.exceptions.ModelAccessException

Registers that the dataset supports the given natural language. Natural languages are expressed as RDF language tags. It is equivalent to the following SPARQL update executed (with inference) on the underlying OWL model:

 prefix lime: 
 
 insert {
    ?workingDataset lime:language ?language .
 }
 where {
    bind([...] as ?workingDataset).
    bind([...] as ?language);
 }
 

Parameters:

language - the natural language to add

Throws:

it.uniroma2.art.owlart.exceptions.ModelUpdateException

it.uniroma2.art.owlart.exceptions.ModelAccessException

listLanguages

Iterator<String> listLanguages()
                               throws it.uniroma2.art.owlart.exceptions.ModelAccessException

Lists the natural languages (identified as RDF language tags) in which the working dataset is described. It is equivalent to the following SPARQL query executed (with inference) on the underlying OWL model:

 prefix lime: 
 
 select distinct ?language {
    bind([...] as ?workingDataset)
    ?workingDataset lime:language ?languageTerm .
    filter(isLiteral(?languageTerm))
    bind(str(?languageTerm) as ?language)
 }
 

Returns:

a list of supported natural languages

Throws:

it.uniroma2.art.owlart.exceptions.ModelAccessException

hasLanguage

boolean hasLanguage(String language)
                    throws it.uniroma2.art.owlart.exceptions.ModelAccessException

Checks whether the working datasets supports the given language. It is equivalent to the following SPARQL query executed (with inference) on the underlying OWL model:

 prefix lime: 
 
 select ask {
    bind([...] as ?workingDataset)
    bind([...] as ?languageTerm)
    ?workingDataset lime:language ?languageTerm .
 }
 

Parameters:

language -

Returns:

Throws:

it.uniroma2.art.owlart.exceptions.ModelAccessException

removeLanguage

void removeLanguage(String language)
                    throws it.uniroma2.art.owlart.exceptions.ModelAccessException,
                           it.uniroma2.art.owlart.exceptions.ModelUpdateException

Removes the indication that the working dataset supports a given natural language. It is equivalent to the following SPARQL update executed (with inference) on the underlying OWL model:

 prefix lime: 
 
 remove {
    ?workingDataset lime:language ?languageTerm .
 }
 where {
    bind([...] as ?languageTerm)
 }
 

Parameters:

language - a natural language

Throws:

it.uniroma2.art.owlart.exceptions.ModelAccessException

it.uniroma2.art.owlart.exceptions.ModelUpdateException

setLanguageCoverage

void setLanguageCoverage(String lang,
                       it.uniroma2.art.owlart.model.ARTURIResource resourceType,
                       CoverageObservation coverageObservation)
                         throws it.uniroma2.art.owlart.exceptions.ModelUpdateException,
                                it.uniroma2.art.owlart.exceptions.ModelAccessException

Registers the extent to a given natural language covers a resource type in the working dataset. This method asserts the following triples (after removing conflicting ones):

 (prefix 
 
 _:workingDataset lime:languageCoverage [
    lime:lang ?lang ;
    lime:resourceCoverage [
        lime:class ?resourceType
      lime:avgNumOfEntries ?avgNumOfEntries # in coverageObservation
      lime:percentage ?percentage # in coverageObservation
    ]
 ]
 

Parameters:

lang -

resourceType -

coverageObservation -

Throws:

it.uniroma2.art.owlart.exceptions.ModelUpdateException

it.uniroma2.art.owlart.exceptions.ModelAccessException

sliceCoverageByLanguage

Iterator<ImmutablePair<it.uniroma2.art.owlart.model.ARTURIResource,CoverageObservation>> sliceCoverageByLanguage(String lang)
                                                                                                                 throws it.uniroma2.art.owlart.exceptions.ModelAccessException

Slices the resource coverage by language. In other words, given a language, this method returns pairs of resource types and their coverage.

Parameters:

lang -

Returns:

Throws:

it.uniroma2.art.owlart.exceptions.ModelAccessException

sliceLanguageCoverageByResourceType

Iterator<ImmutablePair<String,CoverageObservation>> sliceLanguageCoverageByResourceType(it.uniroma2.art.owlart.model.ARTURIResource resourceType)
                                                                                        throws it.uniroma2.art.owlart.exceptions.ModelAccessException

Slices the resource coverage by resource type. In other words, given a resource type, this method returns the coverage statistics for various languages.

Parameters:

lang -

Returns:

Throws:

it.uniroma2.art.owlart.exceptions.ModelAccessException

setLexicalResourceCoverage

void setLexicalResourceCoverage(it.uniroma2.art.owlart.model.ARTURIResource lexicalResource,
                              it.uniroma2.art.owlart.model.ARTURIResource resourceType,
                              CoverageObservation coverageObservation)
                                throws it.uniroma2.art.owlart.exceptions.ModelUpdateException,
                                       it.uniroma2.art.owlart.exceptions.ModelAccessException

Registers the extent to a given lexical resource covers a resource type in the working dataset by means of explicit links. This method asserts the following triples (after removing conflicting ones):

 (prefix 
 
 _:workingDataset lime:lexicalResourceCoverage [
    lime:lexresource ?lexicalResource ;
    lime:resourceCoverage [
        lime:class ?resourceType
      lime:avgNumOfEntries ?avgNumOfEntries # in coverageObservation
      lime:percentage ?percentage # in coverageObservation
    ]
 ]
 

Parameters:

lexicalResource -

resourceType -

coverageObservation -

Throws:

it.uniroma2.art.owlart.exceptions.ModelUpdateException

it.uniroma2.art.owlart.exceptions.ModelAccessException

sliceCoverageByLexicalResource

Iterator<ImmutablePair<it.uniroma2.art.owlart.model.ARTURIResource,CoverageObservation>> sliceCoverageByLexicalResource(it.uniroma2.art.owlart.model.ARTURIResource lexicalResource)
                                                                                                                        throws it.uniroma2.art.owlart.exceptions.ModelAccessException

Slices the resource coverage by lexical resource. In other words, given a lexical resource, this method returns pairs of resource types and their coverage.

Parameters:

lexicalResource -

Returns:

Throws:

it.uniroma2.art.owlart.exceptions.ModelAccessException

sliceLexicalResourceCoverageByResourceType

Iterator<ImmutablePair<it.uniroma2.art.owlart.model.ARTURIResource,CoverageObservation>> sliceLexicalResourceCoverageByResourceType(it.uniroma2.art.owlart.model.ARTURIResource resourceType)
                                                                                                                                    throws it.uniroma2.art.owlart.exceptions.ModelAccessException

Slice the coverage of links to a lexical resource by resource type. In other words, given a resource type, this method returns the coverage statistics for various linked lexical resources.

Parameters:

resourceType -

Returns:

Throws:

it.uniroma2.art.owlart.exceptions.ModelAccessException

setHasTaxonomy

void setHasTaxonomy(boolean taxonomy)
                    throws it.uniroma2.art.owlart.exceptions.ModelUpdateException,
                           it.uniroma2.art.owlart.exceptions.ModelAccessException

Registers that the working dataset has a taxonomy. It is equivalent to the following SPARQL update executed (with inference) on the underlying OWL model:

 prefix lime: 
 
 delete {
    ?workingDataset lime:hasTaxonomy ?oldTaxonomy .
 }
 insert {
    ?workingDataset lime:hasTaxonomy ?taxonomy .
 }
 where {
    bind([...] as ?workingDataset)
    bind([...] as ?taxonomy)
    optional {
       ?workingDataset lime:hasTaxonomy ?oldTaxonomy .
    }
 }
 

Parameters:

taxonomy -

Throws:

it.uniroma2.art.owlart.exceptions.ModelUpdateException

it.uniroma2.art.owlart.exceptions.ModelAccessException

hasTaxonomy

boolean hasTaxonomy()
                    throws it.uniroma2.art.owlart.exceptions.ModelAccessException

Checks whether the working dataset has a taxonomy. It is equivalent to the following SPARQL query executed (with inference) on the underlying OWL model:

 prefix lime: 
 
 ask {
    bind([...] as ?workingDataset)
    ?workingDataset lime:hasTaxonomy true .
 }
 

Note: this operation works by negation-as-failure

Returns:

Throws:

it.uniroma2.art.owlart.exceptions.ModelAccessException

setHasGlosses

void setHasGlosses(boolean glosses)
                   throws it.uniroma2.art.owlart.exceptions.ModelUpdateException,
                          it.uniroma2.art.owlart.exceptions.ModelAccessException

Registers that the working dataset has a glosses. It is equivalent to the following SPARQL update executed (with inference) on the underlying OWL model:

 prefix lime: 
 
 delete {
    ?workingDataset lime:hasGlosses ?oldGlosses .
 }
 insert {
    ?workingDataset lime:hasGlosses ?glosses .
 }
 where {
    bind([...] as ?workingDataset)
    bind([...] as ?glosses)
    optional {
       ?workingDataset lime:hasGlosses ?oldGlosses .
    }
 }
 

Note: this operation works by negation-as-failure

Parameters:

glosses -

Throws:

it.uniroma2.art.owlart.exceptions.ModelUpdateException

it.uniroma2.art.owlart.exceptions.ModelAccessException

hasGlosses

boolean hasGlosses()
                   throws it.uniroma2.art.owlart.exceptions.ModelAccessException

Checks whether the working dataset has glosses. It is equivalent to the following SPARQL query executed (with inference) on the underlying OWL model:

 prefix lime: 
 
 ask {
    bind([...] as ?workingDataset)
    ?workingDataset lime:hasGlosses true .
 }
 

Note: this operation works by negation-as-failure

Returns:

Throws:

it.uniroma2.art.owlart.exceptions.ModelAccessException

setHasUsageExamples

void setHasUsageExamples(boolean usageExamples)
                         throws it.uniroma2.art.owlart.exceptions.ModelUpdateException,
                                it.uniroma2.art.owlart.exceptions.ModelAccessException

Registers that the working dataset has usage examples. It is equivalent to the following SPARQL update executed (with inference) on the underlying OWL model:

 prefix lime: 
 
 delete {
    ?workingDataset lime:hasUsageExample ?oldUsageExamples .
 }
 insert {
    ?workingDataset lime:hasUsageExample ?usageExamples .
 }
 where {
    bind([...] as ?workingDataset)
    bind([...] as ?usageExamples)
    optional {
       ?workingDataset lime:hasUsageExample ?oldUsageExamples .
    }
 }
 

Parameters:

glosses -

Throws:

it.uniroma2.art.owlart.exceptions.ModelUpdateException

it.uniroma2.art.owlart.exceptions.ModelAccessException

hasUsageExamples

boolean hasUsageExamples()
                         throws it.uniroma2.art.owlart.exceptions.ModelAccessException

Checks whether the working dataset has usage examples. It is equivalent to the following SPARQL query executed (with inference) on the underlying OWL model:

 prefix lime: 
 
 ask {
    bind([...] as ?workingDataset)
    ?workingDataset lime:hasUsageExamples true .
 }
 

Note: this operation works by negation-as-failure

Returns:

Throws:

it.uniroma2.art.owlart.exceptions.ModelAccessException

setHasHumanReadableLocalNames

void setHasHumanReadableLocalNames(boolean humanReadable)
                                   throws it.uniroma2.art.owlart.exceptions.ModelUpdateException,
                                          it.uniroma2.art.owlart.exceptions.ModelAccessException

Registers that the working dataset has usage examples. It is equivalent to the following SPARQL update executed (with inference) on the underlying OWL model:

 prefix lime: 
 
 delete {
    ?workingDataset lime:hasHumanReadableLocalNames ?oldHumanReadable .
 }
 insert {
    ?workingDataset lime:hasHumanReadableLocalNames ?humanReadable .
 }
 where {
    bind([...] as ?workingDataset)
    bind([...] as ?humanReadable)
    optional {
       ?workingDataset lime:hasHumanReadableLocalNames ?oldHumanReadable .
    }
 }
 

Parameters:

humanReadable -

Throws:

it.uniroma2.art.owlart.exceptions.ModelUpdateException

it.uniroma2.art.owlart.exceptions.ModelAccessException

hasHumanReadableLocalNames

boolean hasHumanReadableLocalNames()
                                   throws it.uniroma2.art.owlart.exceptions.ModelAccessException

Checks whether the working dataset has human readable local names. It is equivalent to the following SPARQL query executed (with inference) on the underlying OWL model:

 prefix lime: 
 
 ask {
    bind([...] as ?workingDataset)
    ?workingDataset lime:hasHumanReadableLocalNames true .
 }
 

Note: this operation works by negation-as-failure

Returns:

Throws:

it.uniroma2.art.owlart.exceptions.ModelAccessException

write

void write(File outputFile,
         it.uniroma2.art.owlart.io.RDFFormat rdfFormat)
           throws IOException,
                  it.uniroma2.art.owlart.exceptions.ModelAccessException,
                  it.uniroma2.art.owlart.exceptions.UnsupportedRDFFormatException

Writes the LIME description to a file

Parameters:

outputFile -

rdfFormat -

Throws:

IOException

it.uniroma2.art.owlart.exceptions.ModelAccessException

it.uniroma2.art.owlart.exceptions.UnsupportedRDFFormatException

write

void write(OutputStream outputStream,
         it.uniroma2.art.owlart.io.RDFFormat rdfFormat)
           throws IOException,
                  it.uniroma2.art.owlart.exceptions.ModelAccessException,
                  it.uniroma2.art.owlart.exceptions.UnsupportedRDFFormatException

Writes the LIME description to an output stream

Parameters:

outputStream -

rdfFormat -

Throws:

IOException

it.uniroma2.art.owlart.exceptions.ModelAccessException

it.uniroma2.art.owlart.exceptions.UnsupportedRDFFormatException

getOWLModel

it.uniroma2.art.owlart.models.OWLModel getOWLModel()

Returns the underlying OWL Model.

Returns:

the OWL model.

close

void close()
           throws it.uniroma2.art.owlart.exceptions.ModelUpdateException

Closes the undelying OWL model.

Throws:

it.uniroma2.art.owlart.exceptions.ModelUpdateException