org.semanticweb.owlapi.reasoner.NodeSet Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of owlapi-api Show documentation
The newest version!
/*
 * This file is part of the OWL API.
 *
 * The contents of this file are subject to the LGPL License, Version 3.0.
 *
 * Copyright (C) 2011, The University of Manchester
 *
 * 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.
 *
 * Copyright 2011, University of Manchester
 *
 * 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 org.semanticweb.owlapi.reasoner;

import java.util.Set;

import org.semanticweb.owlapi.model.OWLObject;

/**
 * Author: Matthew Horridge

 * The University of Manchester

 * Information Management Group

 * Date: 01-Aug-2009
 *
 * 
 * A set of {@link Node}s.
 * @param  the type of elements in the node set
 */
public interface NodeSet extends Iterable> {


    /**
     * A convenience method that gets all of the entities contained in the Nodes in this NodeSet.
     * @return The union of the entities contained in the Nodes in this NodeSet.
     */
    Set getFlattened();

    /**
     * @return true if the node set is empty
     */
    boolean isEmpty();

    /**
     * A convenience method that determines if this NodeSet contains a specific entity.
     * @param e The entity to test for
     * @return true if this NodeSet contains a Node that contains the entity,
     * e, and false if this NodeSet does not contain a Node
     * that contains the entity, e.
     */
    boolean containsEntity(E e);

    /**
     * Determines if this NodeSet is a singleton.  A NodeSet is a singleton if it contains
     * only one Node.
     * @return true if this NodeSet is a singleton, otherwise false.
     */
    boolean isSingleton();

    /** Determines if this NodeSet is a singleton node that only
     * contains the top node (in a hierarchy).
     * 
     * @see org.semanticweb.owlapi.reasoner.Node#isTopNode()
     * @return true if this NodeSet is a singleton
     *         that contains only the top node, and false
     *         otherwise. */
    boolean isTopSingleton();


    /** Determies if this NodeSet is a singleton that only contains
     * the bottom node (in a hierarchy).
     * 
     * @see org.semanticweb.owlapi.reasoner.Node#isBottomNode()
     * @return true if this NodeSet is a singleton
     *         that only contains a node that is the bottom node, otherwise
     *         false */
    boolean isBottomSingleton();

    /**
     * Gets the Nodes contained in this NodeSet
     * @return The set of Nodes contained in this NodeSet.  Note that this set will be
     * an unmodifiable set.
     */
    Set> getNodes();
}