org.swrlapi.builtins.arguments.SWRLVariableBuiltInArgument Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of swrlapi Show documentation

Java API for working with SWRL rules and SQWRL queries

There is a newer version: 2.1.2

package org.swrlapi.builtins.arguments;

import org.checkerframework.checker.nullness.qual.NonNull;
import org.semanticweb.owlapi.model.SWRLVariable;
import org.swrlapi.exceptions.SWRLBuiltInException;

import java.util.Optional;

/**
 * Represents a variable argument to a SWRL built-in atom.
 *
 * @see org.semanticweb.owlapi.model.SWRLVariable
 */
public interface SWRLVariableBuiltInArgument extends SWRLBuiltInArgument, SWRLVariable
{
  /**
   * @return The name of the variable stripped of a ":" if it is a local prefixed name
   */
  @NonNull String getVariableName();

  /**
   * @return True if the variable has a built-in result attached
   */
  boolean hasBuiltInResult();

  /**
   * @return A SWRL built-in result
   */
  @NonNull Optional<@NonNull SWRLBuiltInArgument> getBuiltInResult();

  /**
   * @param builtInResult A SWRL built-in result
   * @throws SWRLBuiltInException If the variable is bound
   */
  void setBuiltInResult(@NonNull SWRLBuiltInArgument builtInResult) throws SWRLBuiltInException;

  /**
   * @return True if the variable is unbound
   */
  boolean isUnbound();

  /**
   * @return True if the variable is bound
   */
  boolean isBound();

  /**
   * Set the variable as unbound
   */
  void setUnbound();

  /**
   * The set variable as bound
   */
  void setBound();
}