ai.grakn.concept.SchemaConcept 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 ai.grakn.kb.admin.GraknAdmin;
import ai.grakn.util.Schema;

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

/**
 * 
 *     Facilitates construction of ontological elements.
 * 
 *
 * 
 *     Allows you to create schema or ontological elements.
 *     These differ from normal graph constructs in two ways:
 *     1. They have a unique {@link Label} which identifies them
 *     2. You can link them together into a hierarchical structure
 * 
 *
 *
 * @author fppt
 */
public interface SchemaConcept extends Concept {
    //------------------------------------- Modifiers ----------------------------------
    /**
     * Changes the {@link Label} of this {@link Concept} to a new one.
     * @param label The new {@link Label}.
     * @return The {@link Concept} itself
     */
    SchemaConcept label(Label label);

    //------------------------------------- Accessors ---------------------------------
    /**
     * Returns the unique id of this Type.
     *
     * @return The unique id of this type
     */
    @CheckReturnValue
    LabelId labelId();

    /**
     * Returns the unique label of this Type.
     *
     * @return The unique label of this type
     */
    @CheckReturnValue
    Label label();

    /**
     *
     * @return The direct super of this concept
     */
    @CheckReturnValue
    @Nullable
    SchemaConcept sup();

    /**
     * @return All super-concepts of this {@link SchemaConcept } including itself and excluding the meta
     * {@link Schema.MetaSchema#THING}.
     *
     * 
     *     If you want to include {@link Schema.MetaSchema#THING}, use {@link GraknAdmin#sups(SchemaConcept)}.
     * 
     *
     * @see Schema.MetaSchema#THING
     */
    Stream sups();

    /**
     * Get all indirect subs of this concept.
     *
     * The indirect subs are the concept itself and all indirect subs of direct subs.
     *
     * @return All the indirect sub-types of this {@link SchemaConcept}
     */
    @CheckReturnValue
    Stream subs();

    /**
     * Return whether the {@link SchemaConcept} was created implicitly.
     *
     * By default, {@link SchemaConcept} are not implicit.
     *
     * @return returns true if the type was created implicitly through the {@link Attribute} syntax
     */
    @CheckReturnValue
    Boolean isImplicit();

    /**
     * Return the collection of {@link Rule} for which this {@link SchemaConcept} serves as a hypothesis.
     * @see Rule
     *
     * @return A collection of {@link Rule} for which this {@link SchemaConcept} serves as a hypothesis
     */
    @CheckReturnValue
    Stream whenRules();

    /**
     * Return the collection of {@link Rule} for which this {@link SchemaConcept} serves as a conclusion.
     * @see Rule
     *
     * @return A collection of {@link Rule} for which this {@link SchemaConcept} serves as a conclusion
     */
    @CheckReturnValue
    Stream thenRules();

    //------------------------------------- Other ---------------------------------
    @Deprecated
    @CheckReturnValue
    @Override
    default SchemaConcept asSchemaConcept(){
        return this;
    }

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