com.cyc.kb.KbTerm Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cyc-core-object-api Show documentation

The interfaces which define the Cyc Core API.

There is a newer version: 1.0.0-rc7.0

package com.cyc.kb;

import java.util.Date;

/*
 * #%L
 * File: KbTerm.java
 * Project: Core API Object Specification
 * %%
 * Copyright (C) 2013 - 2015 Cycorp, Inc
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */
/**
 * The top-level interface for most kinds of {@link KbObject}s that are not
 * {@link Sentence}s.
 *
 * @author vijay
 */
public interface KbTerm extends KbObject {

  /**
   * Determine whether this is provably not an instance of
   * col. This means that there is no way to convert
   * this into an instance of col without editing or
   * removing current KB assertions.
   *
   * @param col the collection which this is to be tested against
   * @param ctx the context in which the semantic test should be performed
   *
   * @return whether this is provably not an instance of
   * col
   */
  public boolean provablyNotInstanceOf(KbCollection col, Context ctx);

  /**
   * Determine whether this is provably not an instance of
   * col. This means that there is no way to convert
   * this into an instance of the collection without editing or
   * removing current KB assertions.
   *
   * @param colStr the string representing the collection which
   * this is to be tested against
   * @param ctxStr the context in which the semantic test should be performed
   *
   * @return whether this is provably not an instance
   * col
   */
  public boolean provablyNotInstanceOf(String colStr, String ctxStr);

  /**
   * Return the #$Cyclist (not necessarily #$HumanCyclist) who created this term. 
   * If not found or if there is an exception, return null.
   * 
   * @return the cyclist who created the term
   */
  public KbIndividual getCreator();
  
  /**
   * Return the date and time at which this term was created. If not found or if
   * there is an exception, return null.
   * 
   * @return the date and time at which the term was created
   */
  public Date getCreationDate();
}