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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ontapi Show documentation
ONT-API is an OWL-API impl over Apache Jena
There is a newer version: 1.4.2
/*
 * 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.Literal;
import org.apache.jena.rdf.model.RDFNode;

import java.util.Collection;
import java.util.stream.Stream;

/**
 * Common interface for Ontology Data Range expressions (both named and anonymous).
 * Examples of rdf-patterns see here.
 * 
 * Created by szuev on 01.11.2016.
 *
 * @see OntDT
 * @see 2.4 Data Ranges
 * @see 7 Data Ranges
 */
public interface OntDR extends OntObject {

    /**
     * Returns a data range arity.
     * OWL2 spec says:
     * 
{@code This specification currently does not define data ranges of arity more than one}.
     * So n-ary data ranges are not supported and, therefore, the method always returns {@code 1}.
     *
     * @return int, positive number
     * @since 1.4.0
     */
    default int arity() {
        return 1;
    }

    /**
     * @see 7.3 Complement of Data Ranges
     * @see OntGraphModel#createComplementOfDataRange(OntDR)
     */
    interface ComplementOf extends OntDR, SetValue, HasValue {
        /**
         * Gets a data-range.
         *
         * @return {@link OntDR}, not {@code null}
         * @deprecated since 1.4.0: use {@link #getValue()} instead.
         */
        @Deprecated
        default OntDR getDataRange() {
            return getValue();
        }
    }

    /**
     * @see 7.1 Intersection of Data Ranges
     * @see OntGraphModel#createIntersectionOfDataRange(Collection)
     */
    interface IntersectionOf extends ComponentsDR, SetComponents {
        /**
         * Lists all data-ranges.
         *
         * @return a {@code Stream} of {@link OntDR}s
         * @deprecated since 1.4.0: use {@code getList().members()} instead
         */
        @Deprecated
        default Stream dataRanges() {
            return getList().members();
        }
    }

    /**
     * @see 7.2 Union of Data Ranges
     * @see OntGraphModel#createUnionOfDataRange(Collection)
     */
    interface UnionOf extends ComponentsDR, SetComponents {
        /**
         * Lists all data-ranges.
         *
         * @return a {@code Stream} of {@link OntDR}s
         * @deprecated since 1.4.0: use {@code getList().members()} instead
         */
        @Deprecated
        default Stream dataRanges() {
            return getList().members();
        }
    }

    /**
     * @see 7.4 Enumeration of Literals
     * @see OntGraphModel#createOneOfDataRange(Collection)
     */
    interface OneOf extends ComponentsDR, SetComponents {
        /**
         * Lists all literals.
         *
         * @return a {@code Stream} of {@link Literal literal}s
         * @deprecated since 1.4.0: use {@code getList().members()} instead
         */
        @Deprecated
        default Stream values() {
            return getList().members();
        }
    }

    /**
     * @see 7.5 Datatype Restrictions
     * @see OntFR
     * @see OntGraphModel#createFacetRestriction(Class, Literal)
     * @see OntGraphModel#createRestrictionDataRange(OntDT, Collection)
     */
    interface Restriction extends ComponentsDR,
            SetComponents, SetValue, HasValue {
        /**
         * {@inheritDoc}
         * The result stream for {@link Restriction Restriction Data Range} also includes
         * {@link OntFR facet restrinction} definition triples.
         *
         * @return {@code Stream} of {@link OntStatement}s.
         */
        @Override
        Stream spec();

        /**
         * Adds a facet restriction to the end of the []-list.
         *
         * @param type    subclass of {@link OntFR}, not {@code null}
         * @param literal value, not {@code null}
         * @return this instance to allow cascading calls
         * @since 1.4.0
         */
        default Restriction addFacet(Class type, Literal literal) {
            getList().add(getModel().createFacetRestriction(type, literal));
            return this;
        }

        /**
         * Lists all facet restrictions.
         *
         * @return a {@code Stream} of {@link OntFR}s
         * @deprecated since 1.4.0: use {@code getList().members()} instead
         */
        @Deprecated
        default Stream facetRestrictions() {
            return getList().members();
        }

        /**
         * Returns the datatype from the right side of
         * the statement {@code _:x owl:onDatatype DN}, where {@code _:x} this Restriction.
         *
         * @return {@link OntDT}
         * @deprecated since 1.4.0: use {@link #getValue()}
         */
        @Deprecated
        default OntDT getDatatype() {
            return getValue();
        }
    }

    /**
     * An abstract DataRange Expression with {@link OntList} support.
     *
     * @param  {@link RDFNode}
     */
    interface ComponentsDR extends OntDR, HasRDFNodeList {
    }

}