ai.grakn.graql.AggregateQuery 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.graql;

import ai.grakn.GraknTx;
import ai.grakn.graql.answer.Answer;

import javax.annotation.Nullable;

/**
 * An aggregate query produced from a {@link Match}.
 *
 * @param  the type of the result of the aggregate query
 *
 * @author Grakn Warriors
 */
public interface AggregateQuery extends Query {

    @Override
    AggregateQuery withTx(GraknTx tx);

    /**
     * Get the {@link Match} that this {@link AggregateQuery} will operate on.
     */
    @Nullable
    Match match();

    /**
     * Get the {@link Aggregate} that will be executed against the results of the {@link #match()}.
     */
    Aggregate aggregate();
}