org.ggp.base.util.gdl.model.SentenceForm Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of alloy-ggp-base Show documentation

A modified version of the GGP-Base library for Alloy.

There is a newer version: 0.0.15

package org.ggp.base.util.gdl.model;

import java.util.Comparator;
import java.util.List;

import org.ggp.base.util.gdl.GdlUtils;
import org.ggp.base.util.gdl.grammar.GdlConstant;
import org.ggp.base.util.gdl.grammar.GdlSentence;
import org.ggp.base.util.gdl.grammar.GdlTerm;

/**
 * A sentence form captures the structure of a group of possible
 * GdlSentences. Two sentences have the same form if they have the
 * same name and include the same functions in the same place
 *
 * Implementations of SentenceForm should be immutable. They
 * should extend {@link AbstractSentenceForm} for implementations
 * of hashCode and equals that will be compatible with other
 * SentenceForms, as well as a recommended implementation of
 * toString.
 */
public interface SentenceForm {
    /**
     * Returns the name of all sentences with this form.
     */
    GdlConstant getName();

    /**
     * Returns a sentence form exactly like this one, except
     * with a new name.
     */
    SentenceForm withName(GdlConstant name);

    /**
     * Returns true iff the given sentence is of this sentence form.
     */
    boolean matches(GdlSentence relation);

    /**
     * Returns the number of constants and/or variables that a sentence
     * of this form contains.
     */
    int getTupleSize();

    /**
     * Given a list of GdlConstants and/or GdlVariables in the
     * order they would appear in a sentence of this sentence form,
     * returns that sentence.
     *
     * For the opposite operation (getting a tuple from a sentence),
     * see {@link GdlUtils#getTupleFromSentence(GdlSentence)} and
     * {@link GdlUtils#getTupleFromGroundSentence(GdlSentence)}.
     */
    GdlSentence getSentenceFromTuple(List tuple);

    /**
     * See {@link AbstractSentenceForm#equals(Object)}
     */
    @Override
    boolean equals(Object other);

    /**
     * See {@link AbstractSentenceForm#hashCode()}
     */
    @Override
    public int hashCode();

    /**
     * See {@link AbstractSentenceForm#toString()}
     */
    @Override
    public String toString();

    static Comparator ALPHA_COMPARATOR = Comparator.comparing(SentenceForm::toString);

    GdlSentence getSampleSentence();

}