ai.grakn.graql.Pattern Maven / Gradle / Ivy
/*
* Grakn - A Distributed Semantic Database
* Copyright (C) 2016 Grakn Labs Limited
*
* Grakn 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.
*
* Grakn 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 Grakn. If not, see .
*/
package ai.grakn.graql;
import ai.grakn.graql.admin.PatternAdmin;
import javax.annotation.CheckReturnValue;
/**
* A pattern describing a subgraph.
*
* A {@code Pattern} can describe an entire graph, or just a single concept.
*
* For example, {@code var("x").isa("movie")} is a pattern representing things that are movies.
*
* A pattern can also be a conjunction: {@code and(var("x").isa("movie"), var("x").value("Titanic"))}, or a disjunction:
* {@code or(var("x").isa("movie"), var("x").isa("tv-show"))}. These can be used to combine other patterns together
* into larger patterns.
*
* @author Felix Chapman
*/
public interface Pattern {
/**
* @return an Admin class that allows inspecting or manipulating this pattern
*/
@CheckReturnValue
PatternAdmin admin();
/**
* Join patterns in a conjunction
*/
@CheckReturnValue
Pattern and(Pattern pattern);
/**
* Join patterns in a disjunction
*/
@CheckReturnValue
Pattern or(Pattern pattern);
}