ru.avicomp.ontapi.internal.DirectObjectMapImpl 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
The newest version!
/*
 * 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.internal;

import org.apache.jena.util.iterator.ExtendedIterator;
import org.semanticweb.owlapi.model.OWLObject;
import ru.avicomp.ontapi.jena.utils.Iter;

import java.util.Iterator;
import java.util.Objects;
import java.util.Optional;
import java.util.function.Function;
import java.util.function.Supplier;
import java.util.stream.Stream;

/**
 * The implementation of {@link ObjectMap} that redirects calls directly to a graph, without any caching.
 * Created by @ssz on 16.03.2019.
 */
@SuppressWarnings("WeakerAccess")
public class DirectObjectMapImpl implements ObjectMap {
    private final Supplier>> loader;
    private final Function>> finder;

    /**
     * Creates a direct {@link ObjectMap} instance with default finder.
     *
     * @param loader {@code Supplier}, that provides a {@code Stream} of {@link ONTObject}s, not {@code null}
     */
    public DirectObjectMapImpl(Supplier>> loader) {
        this(Objects.requireNonNull(loader),
                k -> Iter.findFirst(Iter.create(loader.get()).filterKeep(x -> x.getObject().equals(k))));
    }

    /**
     * Creates a direct {@link ObjectMap} instance.
     *
     * @param loader {@code Supplier}, that provides a {@code Stream} of {@link ONTObject}s, not {@code null}
     * @param finder {@code Function}, that maps a {@link OWLObject}-key to {@link ONTObject}-value, not {@code null}
     */
    public DirectObjectMapImpl(Supplier>> loader, Function>> finder) {
        this.loader = Objects.requireNonNull(loader);
        this.finder = Objects.requireNonNull(finder);
    }

    /**
     * Lists all {@link ONTObject} using {@code loader}.
     *
     * @return {@code ExtendedIterator} over all {@link ONTObject}s
     */
    public ExtendedIterator> listONTObjects() {
        return Iter.create(loader.get());
    }

    /**
     * Finds the {@link ONTObject} using encapsulated {@code finder}.
     *
     * @param key {@link X}
     * @return {@code Optional} of {@link ONTObject}
     */
    public Optional> findONTObject(X key) {
        return finder.apply(key);
    }

    @Override
    public Stream keys() {
        return Iter.asStream(listONTObjects().mapWith(ONTObject::getObject));
    }

    @Override
    public Stream> values() {
        return Iter.asStream(listONTObjects());
    }

    @Override
    public boolean contains(X key) {
        return findONTObject(key).isPresent();
    }

    @Override
    public ONTObject get(X key) {
        return findONTObject(key).orElse(null);
    }

    @Override
    public boolean hasNew() {
        return false;
    }

    /**
     * {@inheritDoc}
     * This {@code ObjectMap} does not contain any caches, so the method always answers {@code false}.
     *
     * @return {@code false}
     */
    @Override
    public boolean isLoaded() {
        return false;
    }

    @Override
    public void load() {
        // nothing
    }

    @Override
    public void clear() {
        // nothing
    }

    @Override
    public void remove(X key) {
        // nothing
    }

    @Override
    public void add(ONTObject value) {
        // nothing
    }

}