• Home
• ru.avicomp
• ontapi
• 1.4.0
• source code
• OntPE.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

ru.avicomp.ontapi.jena.model.OntPE Maven / Gradle / Ivy

/*
 * This file is part of the ONT API.
 * The contents of this file are subject to the LGPL License, Version 3.0.
 * Copyright (c) 2019, Avicomp Services, AO
 *
 * This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License along with this program.  If not, see http://www.gnu.org/licenses/.
 *
 * Alternatively, the contents of this file may be used under the terms of the Apache License, Version 2.0 in which case, the provisions of the Apache License Version 2.0 are applicable instead of those above.
 * Licensed 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 ru.avicomp.ontapi.jena.model;

import org.apache.jena.rdf.model.Property;
import org.apache.jena.rdf.model.Resource;
import org.apache.jena.vocabulary.RDFS;

import java.util.stream.Stream;

/**
 * An abstraction for any Ontology Property Expression.
 * In OWL2 there are four such property expressions:
 * Data Property, Object Property (OWL Entity and InverseOf) and Annotation Property.
 * 

 * Created by @szuev on 02.11.2016.
 *
 * @see 2.2 Properties
 * @see OntOPE
 * @see OntNAP
 * @see OntNDP
 */
public interface OntPE extends OntObject {

    /**
     * Answers a {@code Stream} over all of the properties that are declared to be super-properties of this property.
     * Each element of the {@code Stream} will have the same type as this property instance:
     * if it is datatype property the method will return only data properties, etc.
     * The parameter {@code direct} controls selectivity over the properties that appear in the {@code Stream}.
     * Consider the following scenario:
     * 
{@code
     *  :A rdfs:subPropertyOf :B .
     *  :A rdfs:subPropertyOf :C .
     *  :C rdfs:subPropertyOf :D .
     * } 
     * If the flag {@code direct} is {@code true}, then the output will contain only direct super properties:
     * {@code B} and {@code C}. In this case the method is almost equivalent to the method {@link #superProperties()}.
     * If the flag {@code direct} is {@code false}, then the output will contain three properties:
     * {@code B}, {@code C} and {@code D} (indirectly).
     * This property instance is not included into the output in any case.
     *
     * @param direct if {@code true}, only answers the directly adjacent properties in the property hierarchy:
     *               i.e. eliminate any property for which there is a longer route
     *               to reach that child under the super-property relation
     * @return distinct {@code Stream} of properties with the same type as this property
     * @see #superProperties()
     * @see #subProperties(boolean)
     * @since 1.4.0
     */
    Stream superProperties(boolean direct);

    /**
     * Answers a {@code Stream} over all of the properties that are declared to be sub-properties of this property.
     * Each element of the {@code Stream} will have the same type as this property instance:
     * if it is datatype property the method will return only data properties, etc.
     * The parameter {@code direct} controls selectivity over the properties that appear in the {@code Stream}.
     * Consider the following scenario:
     * 
{@code
     *  :D rdfs:subPropertyOf :C .
     *  :C rdfs:subPropertyOf :A .
     *  :B rdfs:subPropertyOf :A .
     * } 
     * If the flag {@code direct} is {@code true}, then the output contains only direct sub properties:
     * {@code B} and {@code C}.
     * If the flag {@code direct} is {@code false}, then the output contains three properties:
     * {@code B}, {@code C} and {@code D}.
     * This property instance is not included into the output in any case.
     *
     * @param direct if {@code true}, only answers the directly adjacent properties in the property hierarchy:
     *               i.e. eliminate any property for which there is a longer route
     *               to reach that child under the super-property relation
     * @return distinct {@code Stream} of properties with the same type as this property
     * @see #superProperties(boolean)
     * @since 1.4.0
     */
    Stream subProperties(boolean direct);

    /**
     * Lists all direct super properties for this property expression.
     * The pattern: {@code P1 rdfs:subPropertyOf P2}.
     * Note: the return elements have the same type as this instance.
     *
     * @return {@code Stream} of {@link Resource jena resource}s
     * @see OntNAP#superProperties()
     * @see OntDOP#superProperties()
     * @since 1.4.0
     */
    Stream superProperties();

    /**
     * Lists all property domains.
     *
     * @return {@code Stream} of {@link Resource}s
     * @see OntNAP#domains()
     * @see OntOPE#domains()
     * @see OntNDP#domains()
     * @since 1.4.0
     */
    Stream domains();

    /**
     * Lists all property ranges.
     *
     * @return {@code Stream} of {@link Resource}s
     * @see OntNAP#ranges()
     * @see OntDOP#ranges()
     * @since 1.4.0
     */
    Stream ranges();

    /**
     * Returns a named part of this property expression.
     *
     * @return {@link Property}
     */
    Property asProperty();

    /**
     * Removes the specified domain resource (predicate is {@link RDFS#domain rdfs:domain}),
     * including the corresponding statement's annotations.
     * No-op in case no such domain found.
     * Removes all domains if {@code null} is specified.
     *
     * @param domain {@link Resource}, or {@code null} to remove all domains
     * @return this instance to allow cascading calls
     */
    OntPE removeDomain(Resource domain);

    /**
     * Removes the specified range resource (predicate is {@link RDFS#range rdfs:range}),
     * including the corresponding statement's annotations.
     * No-op in case no such range is found.
     * Removes all ranges if {@code null} is specified.
     *
     * @param range {@link Resource}, or {@code null} to remove all ranges
     * @return this instance to allow cascading calls
     */
    OntPE removeRange(Resource range);

    /**
     * Removes the specified super property (predicate is {@link RDFS#subPropertyOf rdfs:subPropertyOf}),
     * including the corresponding statement's annotations.
     * No-op in case no such super-property is found.
     * Removes all triples with predicate {@code rdfs:subPropertyOf} if {@code null} is specified.
     *
     * @param property {@link Resource} or {@code null} to remove all direct super properties
     * @return this instance to allow cascading calls
     * @since 1.4.0
     */
    OntPE removeSuperProperty(Resource property);

    /**
     * Removes the specified super property (predicate is {@link RDFS#subPropertyOf rdfs:subPropertyOf}).
     *
     * @param superProperty {@link Resource} or {@code null} to remove all direct super properties
     * @deprecated (since 1.4.0) use the method {@link #removeSuperProperty(Resource)}
     */
    @Deprecated
    default void removeSubPropertyOf(Resource superProperty) {
        removeSuperProperty(superProperty);
    }

    /**
     * Lists all property domains.
     *
     * @return {@code Stream} of {@link Resource}s
     * @deprecated since 1.4.0: use {@link #domains()} instead
     */
    @Deprecated
    default Stream domain() {
        return domains();
    }

    /**
     * Lists all property ranges.
     *
     * @return {@code Stream} of {@link Resource}s
     * @deprecated since 1.4.0: use {@link #ranges()}} instead
     */
    @Deprecated
    default Stream range() {
        return ranges();
    }

    /**
     * Lists all direct super properties.
     *
     * @return {@code Stream} of {@link Resource}s
     * @deprecated since 1.4.0: use {@link #superProperties()} instead
     */
    @Deprecated
    default Stream subPropertyOf() {
        return superProperties();
    }
}