ai.grakn.concept.Entity 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;

/**
 * 
 *     An instance of Entity Type {@link EntityType}
 * 
 *
 * 
 *     This represents an entity in the graph.
 *     Entities are objects which are defined by their {@link Attribute} and their links to
 *     other entities via {@link Relationship}
 * 
 *
 * @author fppt
 */
public interface Entity extends Thing {
    //------------------------------------- Accessors ----------------------------------

    /**
     *
     * @return The EntityType of this Entity
     * @see EntityType
     */
    @Override
    EntityType type();

    /**
     * Creates a relation from this instance to the provided {@link Attribute}.
     *
     * @param attribute The {@link Attribute} to which a relationship is created
     * @return The instance itself
     */
    @Override
    Entity has(Attribute attribute);

    /**
     * Removes the provided {@link Attribute} from this {@link Entity}
     * @param attribute the {@link Attribute} to be removed
     * @return The {@link Entity} itself
     */
    @Override
    Entity unhas(Attribute attribute);

    //------------------------------------- Other ---------------------------------
    @Deprecated
    @CheckReturnValue
    @Override
    default Entity asEntity(){
        return this;
    }

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