ai.grakn.concept.Role Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of grakn-core Show documentation
There is a newer version: 1.4.3
/*
 * GRAKN.AI - THE KNOWLEDGE GRAPH
 * Copyright (C) 2018 Grakn Labs Ltd
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see .
 */

package ai.grakn.concept;

import javax.annotation.CheckReturnValue;
import javax.annotation.Nullable;
import java.util.stream.Stream;

/**
 * 
 *     An {@link SchemaConcept} which defines a role which can be played in a {@link RelationshipType}
 * 
 *
 * 
 *     This ontological element defines the {@link Role} which make up a {@link RelationshipType}.
 *     It behaves similarly to {@link SchemaConcept} when relating to other types.
 * 
 *
 * @author fppt
 *
 */
public interface Role extends SchemaConcept {
    //------------------------------------- Modifiers ----------------------------------
    /**
     * Changes the {@link Label} of this {@link Concept} to a new one.
     * @param label The new {@link Label}.
     * @return The {@link Concept} itself
     */
    Role label(Label label);

    /**
     * Sets the super of this Role.
     *
     * @param type The super of this Role
     * @return The Role itself
     */
    Role sup(Role type);

    //------------------------------------- Accessors ----------------------------------
    /**
     * Returns the super of this Role.
     *
     * @return The super of this Role
     */
    @Nullable
    @Override
    Role sup();

    /**
     * @return All the super-types of this this {@link Role}
     */
    @Override
    Stream sups();

    /**
     * Returns the sub of this Role.
     *
     * @return The sub of this Role
     */
    @Override
    Stream subs();

    /**
     * Returns the {@link RelationshipType}s that this {@link Role} takes part in.
     * @see RelationshipType
     *
     * @return The {@link RelationshipType} which this {@link Role} takes part in.
     */
    @CheckReturnValue
    Stream relationships();

    /**
     * Returns a collection of the {@link Type}s that can play this {@link Role}.
     * @see Type
     *
     * @return A list of all the {@link Type}s which can play this {@link Role}.
     */
    @CheckReturnValue
    Stream players();

    //------------------------------------- Other ---------------------------------
    @Deprecated
    @CheckReturnValue
    @Override
    default Role asRole(){
        return this;
    }

    @Deprecated
    @CheckReturnValue
    @Override
    default boolean isRole(){
        return true;
    }
}