gate.creole.ontology.ObjectProperty Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gate-core Show documentation

GATE - general achitecture for text engineering - is open source software capable of solving almost any text processing problem. This artifact enables you to embed the core GATE Embedded with its essential dependencies. You will able to use the GATE Embedded API and load and store GATE XML documents. This artifact is the perfect dependency for CREOLE plugins or for applications that need to customize the GATE dependencies due to confict with their own dependencies or for lower footprint.

The newest version!

/*
 *  ObjectProperty.java
 *
 *  Niraj Aswani, 09/March/07
 *
 *  $Id: ObjectProperty.java 17530 2014-03-04 15:57:43Z markagreenwood $
 */
package gate.creole.ontology;

import java.util.Set;

/**
 * ObjectProperty is a sub type of the RDFProperty. This property takes
 * a set of OClasses as its domain and range. The property can be then
 * assigned to an instance, where the subject instance must belongs to
 * all the OClasses (Transitive closure) specified in the domain and the
 * object instance must belongs to all the OClass (Transitive Closure)
 * specified in the range.
 * 
 * @author Niraj Aswani
 * @author Johann Petrak
 * 
 */
@SuppressWarnings("deprecation")
public interface ObjectProperty extends RDFProperty {
  /**
   * Returns the set of inverse properties for this property. 
   * 
   * @return a {@link Set} of {@link ObjectProperty} value.
   */
  public Set getInverseProperties();

  /**
   * Set theInverse as inverse property to this property.
   * 
   * @param theInverse
   */
  public void setInverseOf(ObjectProperty theInverse);

  /**
   * Returns the set of domain restrictions for this property.
   */
  @Override
  public Set getDomain();

  /**
   * Gets the set of range restrictions for this property.
   * 
   * @return a set of {@link OClass} or {@link Class} objects.
   */
  @Override
  public Set getRange();

  /**
   * Checks whether the provided instance is compatible with the range
   * restrictions on the property.
   * 
   * @param anInstance the Instance
   * @return true if this instance is compatible with the range
   *         restrictions on the property. False otherwise.
   */
  public boolean isValidRange(OInstance anInstance);

  /**
   * Checks whether the provided instance is compatible with the domain
   * restrictions on the property.
   * 
   * @param anInstance the Instance
   * @return true if this instance is compatible with the domain
   *         restrictions on the property. False otherwise.
   */
  public boolean isValidDomain(OInstance anInstance);

}