com.cyc.kb.client.BinaryPredicateImpl Maven / Gradle / Ivy
Show all versions of cyc-kb-client Show documentation
package com.cyc.kb.client;
/*
* #%L
* File: BinaryPredicateImpl.java
* Project: KB Client
* %%
* Copyright (C) 2013 - 2017 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%
*/
import com.cyc.base.cycobject.CycObject;
import com.cyc.base.cycobject.DenotationalTerm;
import com.cyc.base.cycobject.Guid;
import com.cyc.baseclient.cycobject.CycConstantImpl;
import com.cyc.kb.BinaryPredicate;
import com.cyc.kb.Context;
import com.cyc.kb.Fact;
import com.cyc.kb.KbCollection;
import com.cyc.kb.KbObject;
import com.cyc.kb.KbStatus;
import com.cyc.kb.client.config.KbConfiguration;
import com.cyc.kb.exception.CreateException;
import com.cyc.kb.exception.InvalidNameException;
import com.cyc.kb.exception.KbException;
import com.cyc.kb.exception.KbObjectNotFoundException;
import com.cyc.kb.exception.KbRuntimeException;
import com.cyc.kb.exception.KbTypeConflictException;
import com.cyc.kb.exception.KbTypeException;
import java.util.Collection;
/**
* A BinaryPredicate object is a facade for a
* #$BinaryPredicate in Cyc KB.
*
* A #$BinaryPredicate is a specialization of #$Predicate. It is a collection of
* predicates that take only two arguments. Binary predicates are the most common
* type of predicate in the Cyc KB and terser methods are provided for binary predicates in KBObject.
* So we have a class to support strongly typing such predicates.
*
* @param type of CycObject core
*
* @author Vijay Raj
* @version $Id: BinaryPredicateImpl.java 173082 2017-07-28 15:36:55Z nwinant $
*/
public class BinaryPredicateImpl extends KbPredicateImpl implements BinaryPredicate {
private static final DenotationalTerm TYPE_CORE =
new CycConstantImpl("BinaryPredicate", new Guid("bd588102-9c29-11b1-9dad-c379636f7270"));
static DenotationalTerm getClassTypeCore() {
return TYPE_CORE;
}
/**
* Not part of the KB API. This default constructor only has the effect of
* ensuring that there is access to a Cyc server.
*/
BinaryPredicateImpl() {
super();
}
/**
* Not part of the KB API. An implementation-dependent constructor.
*
* It is used when the result of query is a CycObject and is known to be or
* requested to be cast as an instance of BinaryPredicate.
*
* @param cycObject the CycObject wrapped by BinaryPredicate. The constructor
* verifies that the CycObject is an instance of #$BinaryPredicate
*
* @throws KbTypeException if cycObject is not or could not be made
* an instance of #$BinaryPredicate
*/
@Deprecated
BinaryPredicateImpl(DenotationalTerm cycObject) throws KbTypeException {
super(cycObject);
}
/**
* This not part of the public, supported KB API. finds or creates an instance of #$BinaryPredicate represented
* by binPredStr in the underlying KB
*
*
* @param binPredStr the string representing an instance of #$BinaryPredicate in the KB
*
* @throws CreateException if the #$BinaryPredicate represented by binPredStr is not found
* and could not be created
* @throws KbTypeException if the term represented by binPredStr is not an instance
* of #$BinaryPredicate and cannot be made into one.
*/
BinaryPredicateImpl(String binPredStr) throws KbTypeException, CreateException {
super(binPredStr);
}
/**
* This not part of the public, supported KB API. finds or creates; or finds an instance of #$BinaryPredicate
* represented by binPredStr in the underlying KB based on input ENUM
*
*
* @param binPredStr the string representing an instance of #$BinaryPredicate in the KB
* @param lookup the enum to specify LookupType: FIND or FIND_OR_CREATE
*
* @throws CreateException
* @throws KbTypeException
*
* @throws KbObjectNotFoundException if the #$BinaryPredicate represented by binPredStr
* is not found and could not be created
* @throws InvalidNameException if the string binPredStr does not conform to Cyc constant-naming
* conventions
*
* @throws KbTypeException if the term represented by binPredStr is not an instance of #$BinaryPredicate and lookup is
* set to find only {@link LookupType#FIND}
* @throws KbTypeConflictException if the term represented by binPredStr is not an instance of #$BinaryPredicate,
* and lookup is set to find or create; and if the term cannot be made an instance #$BinaryPredicate by asserting
* new knowledge.
*/
BinaryPredicateImpl(String binPredStr, LookupType lookup) throws KbTypeException, CreateException {
super(binPredStr, lookup);
}
/**
* Get the
* BinaryPredicate with the name
* nameOrId. Throws exceptions if there is no KB term by that
* name, or if it is not already an instance of #$BinaryPredicate.
*
* @param nameOrId the string representation or the HLID of the #$BinaryPredicate
*
* @return a new BinaryPredicate
*
* @throws KbTypeException
* @throws CreateException
*/
public static BinaryPredicateImpl get(String nameOrId) throws KbTypeException, CreateException {
return KbObjectImplFactory.get(nameOrId, BinaryPredicateImpl.class);
}
/**
* Get the
* BinaryPredicate object that corresponds to
* cycObject. Throws exceptions if the object isn't in the KB, or if
* it's not already an instance of
* #$BinaryPredicate.
*
* @param cycObject the CycObject wrapped by BinaryPredicate. The method
* verifies that the CycObject is an instance of #$BinaryPredicate
*
* @return a new BinaryPredicate
*
* @throws CreateException
* @throws KbTypeException
*/
@Deprecated
public static BinaryPredicateImpl get(CycObject cycObject) throws KbTypeException, CreateException {
return KbObjectImplFactory.get(cycObject, BinaryPredicateImpl.class);
}
/**
* Find or create a
* BinaryPredicate object named
* nameOrId. If no object exists in the KB with the name
* nameOrId, one will be created, and it will be asserted to be
* an instance of
* #$BinaryPredicate. If there is already an object in the KB called
* nameOrId, and it is already a
* #$BinaryPredicate, it will be returned. If it is not already a
* #$BinaryPredicate, but can be made into one by addition of
* assertions to the KB, such assertions will be made, and the object will be
* returned. If the object in the KB cannot be turned into a
* #$BinaryPredicate by adding assertions (i.e. some existing
* assertion prevents it from being a
* #$BinaryPredicate), a
* KBTypeConflictExceptionwill be thrown.
*
* @param nameOrId the string representation or the HLID of the #$BinaryPredicate
*
* @return a new BinaryPredicate
*
* @throws KbTypeException
* @throws CreateException
*/
public static BinaryPredicateImpl findOrCreate(String nameOrId) throws CreateException, KbTypeException {
return KbObjectImplFactory.findOrCreate(nameOrId, BinaryPredicateImpl.class);
}
/**
* Find or create a BinaryPredicate object from
* cycObject. If
* cycObject is already a
* #$BinaryPredicate, an appropriate
* BinaryPredicate object will be returned. If
* object is not already a
* #$BinaryPredicate, but can be made into one by addition of
* assertions to the KB, such assertions will be made, and the relevant object
* will be returned. If
* cycObject cannot be turned into a
* #$BinaryPredicate by adding assertions (i.e. some existing
* assertion prevents it from being a
* #$BinaryPredicate, a
* KBTypeConflictExceptionwill be thrown.
*
* @param cycObject the CycObject wrapped by BinaryPredicate. The method
* verifies that the CycObject is an #$BinaryPredicate
*
* @return a new BinaryPredicate
*
* @throws KbTypeException
* @throws CreateException
*/
@Deprecated
public static BinaryPredicateImpl findOrCreate(CycObject cycObject) throws CreateException, KbTypeException {
return KbObjectImplFactory.findOrCreate(cycObject, BinaryPredicateImpl.class);
}
/**
* Find or create a
* BinaryPredicate object named
* nameOrId, and also make it an instance of
* constraintCol in the default context specified by
* {@link KBAPIDefaultContext#forAssertion()}. If no object
* exists in the KB with the name
* nameOrId, one will be created, and it will be asserted to be
* an instance of both
* #$BinaryPredicate and
* constraintCol. If there is already an object in the
* KB called
* nameOrId, and it is already both a
* #$BinaryPredicate and a
* constraintCol, it will be returned. If it is not
* already both a
* #$BinaryPredicate and a
* constraintCol, but can be made so by addition of
* assertions to the KB, such assertions will be made, and the object will be
* returned. If the object in the KB cannot be turned into both a
* #$BinaryPredicate and a
* constraintCol by adding assertions, a
* KBTypeConflictExceptionwill be thrown.
*
* @param nameOrId the string representation or the HLID of the #$BinaryPredicate
* @param constraintCol the collection that this #$BinaryPredicate will instantiate
*
* @return a new BinaryPredicate
*
* @throws KbTypeException
* @throws CreateException
*/
public static BinaryPredicateImpl findOrCreate(String nameOrId, KbCollection constraintCol) throws CreateException, KbTypeException {
return KbObjectImplFactory.findOrCreate(nameOrId, constraintCol, BinaryPredicateImpl.class);
}
/**
* Find or create a
* BinaryPredicate object named
* nameOrId, and also make it an instance of
* constraintCol in the default context specified by
* {@link KBAPIDefaultContext#forAssertion()}. If no object
* exists in the KB with the name
* nameOrId, one will be created, and it will be asserted to be
* an instance of both
* #$BinaryPredicate and
* constraintCol. If there is already an object in the
* KB called
* nameOrId, and it is already both a
* #$BinaryPredicate and a
* constraintCol, it will be returned. If it is not
* already both a
* #$BinaryPredicate and a
* constraintCol, but can be made so by addition of
* assertions to the KB, such assertions will be made, and the object will be
* returned. If the object in the KB cannot be turned into both a
* #$BinaryPredicate and a
* constraintCol by adding assertions, a
* KBTypeConflictExceptionwill be thrown.
*
* @param nameOrId the string representation or the HLID of the #$BinaryPredicate
* @param constraintColStr the string representation of the collection that
* this #$BinaryPredicate will instantiate
*
* @return a new BinaryPredicate
*
* @throws KbTypeException
* @throws CreateException
*/
public static BinaryPredicateImpl findOrCreate(String nameOrId, String constraintColStr) throws CreateException, KbTypeException {
return KbObjectImplFactory.findOrCreate(nameOrId, constraintColStr, BinaryPredicateImpl.class);
}
/**
* Find or create a
* BinaryPredicate object named
* nameOrId, and also make it an instance of
* constraintCol in
* ctx. If no object exists in the KB with the name
* nameOrId, one will be created, and it will be asserted to be
* an instance of both
* #$BinaryPredicate and
* constraintCol. If there is already an object in the
* KB called
* nameOrId, and it is already both a
* #$BinaryPredicate and a
* constraintCol, it will be returned. If it is not
* already both a
* #$BinaryPredicate and a
* constraintCol, but can be made so by addition of
* assertions to the KB, such assertions will be made, and the object will be
* returned. If the object in the KB cannot be turned into both a
* #$BinaryPredicate and a
* constraintCol by adding assertions, a
* KBTypeConflictExceptionwill be thrown.
*
* @param nameOrId the string representation or the HLID of the #$BinaryPredicate
* @param constraintCol the collection that this #$BinaryPredicate will instantiate
* @param ctx the context in which the resulting object must be an instance of
* constraintCol
*
* @return a new BinaryPredicate
*
* @throws KbTypeException
* @throws CreateException
*/
public static BinaryPredicateImpl findOrCreate(String nameOrId, KbCollection constraintCol, Context ctx)
throws CreateException, KbTypeException {
return KbObjectImplFactory.findOrCreate(nameOrId, constraintCol, ctx, BinaryPredicateImpl.class);
}
/**
* Find or create a
* BinaryPredicate object named
* nameOrId, and also make it an instance of
* constraintCol in
* ctx. If no object exists in the KB with the name
* nameOrId, one will be created, and it will be asserted to be
* an instance of both
* #$BinaryPredicate and
* constraintCol. If there is already an object in the
* KB called
* nameOrId, and it is already both a
* #$BinaryPredicate and a
* constraintCol, it will be returned. If it is not
* already both a
* #$BinaryPredicate and a
* constraintCol, but can be made so by addition of
* assertions to the KB, such assertions will be made, and the object will be
* returned. If the object in the KB cannot be turned into both a
* #$BinaryPredicate and a
* constraintCol by adding assertions, a
* KBTypeConflictExceptionwill be thrown.
*
* @param nameOrId the string representation or the HLID of the term
* @param constraintColStr the string representation of the collection that
* this #$BinaryPredicate will instantiate
* @param ctxStr the context in which the resulting object must be an instance of
* constraintCol
*
* @return a new BinaryPredicate
*
* @throws KbTypeException
* @throws CreateException
*/
public static BinaryPredicateImpl findOrCreate(String nameOrId, String constraintColStr, String ctxStr) throws CreateException, KbTypeException {
return KbObjectImplFactory.findOrCreate(nameOrId, constraintColStr, ctxStr, BinaryPredicateImpl.class);
}
/**
* Checks whether entity exists in KB and is an instance of #$BinaryPredicate. If
* false, {@link #getStatus(String)} may yield more information. This method
* is equivalent to
* getStatus(nameOrId).equals(KBStatus.EXISTS_AS_TYPE).
*
* @param nameOrId either the name or HL ID of an entity in the KB
* @return true if entity exists in KB and is an instance of
* #$BinaryPredicate
*/
public static boolean existsAsType(String nameOrId) {
return getStatus(nameOrId).equals(KbStatus.EXISTS_AS_TYPE);
}
/**
* Checks whether entity exists in KB and is an instance of #$BinaryPredicate. If
* false, {@link #getStatus(CycObject)} may yield more information. This
* method is equivalent to
* getStatus(object).equals(KBStatus.EXISTS_AS_TYPE).
*
* @param cycObject the CycObject representation of a KB entity
* @return true if entity exists in KB and is an instance of
* #$BinaryPredicate
*/
public static boolean existsAsType(CycObject cycObject) {
return getStatus(cycObject).equals(KbStatus.EXISTS_AS_TYPE);
}
/**
* Returns an KBStatus enum which describes whether
* nameOrId exists in the KB and is an instance of
* #$BinaryPredicate.
*
* @param nameOrId either the name or HL ID of an entity in the KB
* @return an enum describing the existential status of the entity in the KB
*/
public static KbStatus getStatus(String nameOrId) {
return KbObjectImplFactory.getStatus(nameOrId, BinaryPredicateImpl.class);
}
/**
* Returns an KBStatus enum which describes whether
* cycObject exists in the KB and is an instance of
* #$BinaryPredicate.
*
* @param cycObject the CycObject representation of a KB entity
* @return an enum describing the existential status of the entity in the KB
*/
public static KbStatus getStatus(CycObject cycObject) {
return KbObjectImplFactory.getStatus(cycObject, BinaryPredicateImpl.class);
}
/**
* Return the KBCollection as a KBObject of the Cyc term that
* underlies this class.
*
* @return KBCollectionImpl.get("#$BinaryPredicate");
*/
@Override
public KbObject getType() {
return getClassType();
}
/**
* Return the KBCollection as a KBObject of the Cyc term that
* underlies this class.
*
* @return KBCollectionImpl.get("#$BinaryPredicate");
*/
public static KbObject getClassType() {
try {
return KbCollectionImpl.get(getClassTypeString());
} catch (KbException kae) {
throw new KbRuntimeException(kae.getMessage(), kae);
}
}
@Override
String getTypeString() {
return getClassTypeString();
}
static String getClassTypeString() {
return "#$BinaryPredicate";
}
@Override
protected void validateArgArity(Object... args) {
if (args.length != 2) {
throw new IllegalArgumentException("All " + getTypeString() + "s require exactly 2 arguments"
+ ", but " + args.length + " args were supplied");
}
}
@Override
public Fact addFact(Context ctx, Object arg1, Object arg2)
throws KbTypeException, CreateException {
return super.addFact(ctx, new Object[]{arg1, arg2});
}
@Override
public Collection getValuesForArg(Object arg1, Object arg2, Context ctx) {
if ((arg1 == null) && (arg2 == null)) {
throw new IllegalArgumentException("arg1 or arg2 must be non-null, but both are null");
}
if ((arg1 != null) && (arg2 != null)) {
throw new IllegalArgumentException("arg1 or arg2 must be null, but neither are null");
}
final int argPosition = (arg1 != null) ? 1 : 2;
final int valuePosition = (arg2 != null) ? 1 : 2;
final Object arg = (arg1 != null) ? arg1 : arg2;
return getValuesForArgPosition(arg, argPosition, valuePosition, ctx);
}
@Override
public Collection getValuesForArg(Object arg1, Object arg2) {
return getValuesForArg(arg1, arg2, KbConfiguration.getDefaultContext().forQuery());
}
}