/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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
///////////////
package org.apache.jena.ontology.impl;
// Imports
///////////////
import org.apache.jena.enhanced.* ;
import org.apache.jena.graph.Node ;
import org.apache.jena.ontology.* ;
import org.apache.jena.rdf.model.* ;
import org.apache.jena.util.iterator.ExtendedIterator ;
/**
* <p>
* Implementation of the Ontology interface, encapsulating nodes that hold the
* meta-data about whole ontologies.
* </p>
*/
public class OntologyImpl
extends OntResourceImpl
implements Ontology
{
// Constants
//////////////////////////////////
// Static variables
//////////////////////////////////
/**
* A factory for generating Ontology facets from nodes in enhanced graphs.
*/
@SuppressWarnings("hiding")
public static Implementation factory = new Implementation() {
@Override
public EnhNode wrap( Node n, EnhGraph eg ) {
if (canWrap( n, eg )) {
return new OntologyImpl( n, eg );
}
else {
throw new ConversionException( "Cannot convert node " + n + " to Ontology");
}
}
@Override
public boolean canWrap( Node node, EnhGraph eg ) {
// node will support being an Ontology facet if it has rdf:type owl:Ontology or equivalent
Profile profile = (eg instanceof OntModel) ? ((OntModel) eg).getProfile() : null;
return (profile != null) && profile.isSupported( node, eg, Ontology.class );
}
};
// Instance variables
//////////////////////////////////
// Constructors
//////////////////////////////////
/**
* <p>
* Construct an ontology metadata node represented by the given node in the given graph.
* </p>
*
* @param n The node that represents the resource
* @param g The enh graph that contains n
*/
public OntologyImpl( Node n, EnhGraph g ) {
super( n, g );
}
// External signature methods
//////////////////////////////////
// imports
/**
* <p>Assert that this ontology imports only the given ontology. Any existing
* statements for <code>sameAs</code> will be removed.</p>
* @param res Represents a resource that this ontology imports.
* @exception ProfileException If the {@link Profile#IMPORTS()} property is not supported in the current language profile.
*/
@Override
public void setImport( Resource res ) {
setPropertyValue( getProfile().IMPORTS(), "IMPORTS", res );
}
/**
* <p>Add a resource representing an ontology that this ontology
* (strictly, the ontology reprsented by this node) imports.</p>
* @param res Represents a resource that this ontology imports.
* @exception ProfileException If the {@link Profile#IMPORTS()} property is not supported in the current language profile.
*/
@Override
public void addImport( Resource res ) {
addPropertyValue( getProfile().IMPORTS(), "IMPORTS", res );
}
/**
* <p>Answer a resource that represents an ontology imported by this ontology. If there is
* more than one such resource, an arbitrary selection is made.</p>
* @return An ont resource representing a resource that this ontology imports
* @exception ProfileException If the {@link Profile#IMPORTS()} property is not supported in the current language profile.
*/
@Override
public OntResource getImport() {
return objectAsResource( getProfile().IMPORTS(), "IMPORTS" );
}
/**
* <p>Answer an iterator over all of the resources representing ontologies imported by this ontology.
* Each elemeent of the iterator will be an {@link OntResource}.</p>
* @return An iterator over the ontology import resources
* @exception ProfileException If the {@link Profile#IMPORTS()} property is not supported in the current language profile.
*/
@Override
public ExtendedIterator<OntResource> listImports() {
return listAs( getProfile().IMPORTS(), "IMPORTS", OntResource.class );
}
/**
* <p>Answer true if this ontology (the ontology represented by this
* resource) imports the given resource.</p>
* @param res A resource to test against
* @return True if this ontology imports the ontology represented by <code>res</code>
*/
@Override
public boolean imports( Resource res ) {
return hasPropertyValue( getProfile().IMPORTS(), "IMPORTS", res );
}
/**
* <p>Remove the statement that this ontology imports the ontology represented by the given resource. If this statement
* is not true of the current model, nothing happens.</p>
* @param res A resource that represents an ontology that is no longer to be imported
*/
@Override
public void removeImport( Resource res ) {
removePropertyValue( getProfile().IMPORTS(), "IMPORTS", res );
}
// backwardCompatibleWith
/**
* <p>Assert that this ontology is backward compatible with the given ontology. Any existing
* statements for <code>sameAs</code> will be removed.</p>
* @param res Represents a resource that this ontology is compatible with.
* @exception ProfileException If the {@link Profile#BACKWARD_COMPATIBLE_WITH} property is not supported in the current language profile.
*/
@Override
public void setBackwardCompatibleWith( Resource res ) {
setPropertyValue( getProfile().BACKWARD_COMPATIBLE_WITH(), "BACKWARD_COMPATIBLE_WITH", res );
}
/**
* <p>Add a resource representing an ontology that this ontology
* (strictly, the ontology reprsented by this node) is backwards compatible with.</p>
* @param res Represents a resource that this ontology is compatible with.
* @exception ProfileException If the {@link Profile#BACKWARD_COMPATIBLE_WITH} property is not supported in the current language profile.
*/
@Override
public void addBackwardCompatibleWith( Resource res ) {
addPropertyValue( getProfile().BACKWARD_COMPATIBLE_WITH(), "BACKWARD_COMPATIBLE_WITH", res );
}
/**
* <p>Answer a resource that represents an ontology that is backwards compatible with this ontology. If there is
* more than one such resource, an arbitrary selection is made.</p>
* @return An ont resource representing an ontology that this ontology is compatible with
* @exception ProfileException If the {@link Profile#BACKWARD_COMPATIBLE_WITH} property is not supported in the current language profile.
*/
@Override
public OntResource getBackwardCompatibleWith() {
return objectAsResource( getProfile().BACKWARD_COMPATIBLE_WITH(), "BACKWARD_COMPATIBLE_WITH" );
}
/**
* <p>Answer an iterator over all of the resources representing
* ontologies that this ontology is backwards compatible with.
* Each element of the iterator will be an {@link OntResource}.</p>
* @return An iterator over the ontology resources compatible with this ontology
* @exception ProfileException If the {@link Profile#BACKWARD_COMPATIBLE_WITH} property is not supported in the current language profile.
*/
@Override
public ExtendedIterator<OntResource> listBackwardCompatibleWith() {
return listAs( getProfile().BACKWARD_COMPATIBLE_WITH(), "BACKWARD_COMPATIBLE_WITH", OntResource.class );
}
/**
* <p>Answer true if this ontology (the ontology represented by this
* resource) is backward compatible with the given resource.</p>
* @param res A resource to test against
* @return True if this ontology is compatible with the ontology represented by <code>res</code>
*/
@Override
public boolean isBackwardCompatibleWith( Resource res ) {
return hasPropertyValue( getProfile().BACKWARD_COMPATIBLE_WITH(), "BACKWARD_COMPATIBLE_WITH", res );
}
/**
* <p>Remove the statement that this ontology is backwards compatible with
* the ontology represented by the given resource. If this statement
* is not true of the current model, nothing happens.</p>
* @param res A resource that represents an ontology that is no longer to be imported
*/
@Override
public void removeBackwardCompatibleWith( Resource res ) {
removePropertyValue( getProfile().BACKWARD_COMPATIBLE_WITH(), "BACKWARD_COMPATIBLE_WITH", res );
}
// priorVersion
/**
* <p>Assert that this ontology is a new version of the given ontology. Any existing
* statements for <code>priorVersion</code> will be removed.</p>
* @param res Represents a resource that this ontology supercedes.
* @exception ProfileException If the {@link Profile#PRIOR_VERSION} property is not supported in the current language profile.
*/
@Override
public void setPriorVersion( Resource res ) {
setPropertyValue( getProfile().PRIOR_VERSION(), "PRIOR_VERSION", res );
}
/**
* <p>Add a resource representing an ontology that this ontology
* (strictly, the ontology reprsented by this node) supercedes.</p>
* @param res Represents a resource that this ontology supercedes.
* @exception ProfileException If the {@link Profile#PRIOR_VERSION} property is not supported in the current language profile.
*/
@Override
public void addPriorVersion( Resource res ) {
addPropertyValue( getProfile().PRIOR_VERSION(), "PRIOR_VERSION", res );
}
/**
* <p>Answer a resource that represents an ontology that is superceded by this ontology. If there is
* more than one such resource, an arbitrary selection is made.</p>
* @return An ont resource representing an ontology that this ontology supercedes
* @exception ProfileException If the {@link Profile#PRIOR_VERSION} property is not supported in the current language profile.
*/
@Override
public OntResource getPriorVersion() {
return objectAsResource( getProfile().PRIOR_VERSION(), "PRIOR_VERSION" );
}
/**
* <p>Answer an iterator over all of the resources representing
* ontologies that this ontology supercedes.
* Each element of the iterator will be an {@link OntResource}.</p>
* @return An iterator over the ontology resources superceded by this ontology
* @exception ProfileException If the {@link Profile#PRIOR_VERSION} property is not supported in the current language profile.
*/
@Override
public ExtendedIterator<OntResource> listPriorVersion() {
return listAs( getProfile().PRIOR_VERSION(), "PRIOR_VERSION", OntResource.class );
}
/**
* <p>Answer true if this ontology (the ontology represented by this
* resource) supercedes the given resource.</p>
* @param res A resource to test against
* @return True if this ontology supercedes the ontology represented by <code>res</code>
*/
@Override
public boolean hasPriorVersion( Resource res ) {
return hasPropertyValue( getProfile().PRIOR_VERSION(), "PRIOR_VERSION", res );
}
/**
* <p>Remove the statement that the given ontology is a prior version of this ontology. If this statement
* is not true of the current model, nothing happens.</p>
* @param res A resource that represents an ontology that is no longer a prior version of this ontology
*/
@Override
public void removePriorVersion( Resource res ) {
removePropertyValue( getProfile().PRIOR_VERSION(), "PRIOR_VERSION", res );
}
// incompatibleWith
/**
* <p>Assert that this ontology is incompatible with the given ontology. Any existing
* statements for <code>incompatibleWith</code> will be removed.</p>
* @param res Represents a resource that this ontology is incompatible with.
* @exception ProfileException If the {@link Profile#INCOMPATIBLE_WITH} property is not supported in the current language profile.
*/
@Override
public void setIncompatibleWith( Resource res ) {
setPropertyValue( getProfile().INCOMPATIBLE_WITH(), "INCOMPATIBLE_WITH", res );
}
/**
* <p>Add a resource representing an ontology that this ontology
* (strictly, the ontology reprsented by this node) is incompatible with.</p>
* @param res Represents a resource that this ontology is incompatible with.
* @exception ProfileException If the {@link Profile#INCOMPATIBLE_WITH} property is not supported in the current language profile.
*/
@Override
public void addIncompatibleWith( Resource res ) {
addPropertyValue( getProfile().INCOMPATIBLE_WITH(), "INCOMPATIBLE_WITH", res );
}
/**
* <p>Answer a resource that represents an ontology that is is incompatible with this ontology. If there is
* more than one such resource, an arbitrary selection is made.</p>
* @return An ont resource representing an ontology that this ontology is incompatible with
* @exception ProfileException If the {@link Profile#INCOMPATIBLE_WITH} property is not supported in the current language profile.
*/
@Override
public OntResource getIncompatibleWith() {
return objectAsResource( getProfile().INCOMPATIBLE_WITH(), "INCOMPATIBLE_WITH" );
}
/**
* <p>Answer an iterator over all of the resources representing
* ontologies that this ontology is incompatible with.
* Each element of the iterator will be an {@link OntResource}.</p>
* @return An iterator over the ontology resources that this ontology is incompatible with
* @exception ProfileException If the {@link Profile#INCOMPATIBLE_WITH} property is not supported in the current language profile.
*/
@Override
public ExtendedIterator<OntResource> listIncompatibleWith() {
return listAs( getProfile().INCOMPATIBLE_WITH(), "INCOMPATIBLE_WITH", OntResource.class );
}
/**
* <p>Answer true if this ontology (the ontology represented by this
* resource) is incompatible with the given resource.</p>
* @param res A resource to test against
* @return True if this ontology is incompatible with the ontology represented by <code>res</code>
*/
@Override
public boolean isIncompatibleWith( Resource res ) {
return hasPropertyValue( getProfile().INCOMPATIBLE_WITH(), "INCOMPATIBLE_WITH", res );
}
/**
* <p>Remove the statement that the given ontology is incompatible with this ontology. If this statement
* is not true of the current model, nothing happens.</p>
* @param res A resource that represents an ontology that is no longer incompatible with this ontology
*/
@Override
public void removeIncompatibleWith( Resource res ) {
removePropertyValue( getProfile().INCOMPATIBLE_WITH(), "INCOMPATIBLE_WITH", res );
}
// Internal implementation methods
//////////////////////////////////
//==============================================================================
// Inner class definitions
//==============================================================================
}