com.cyc.kb.client.QuantifierImpl Maven / Gradle / Ivy
package com.cyc.kb.client;
/*
* #%L
* File: QuantifierImpl.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.KbStatus;
import com.cyc.kb.Quantifier;
import com.cyc.kb.client.LookupType;
import com.cyc.kb.KbObject;
import com.cyc.kb.exception.CreateException;
import com.cyc.kb.exception.InvalidNameException;
import com.cyc.kb.exception.KbException;
import com.cyc.kb.exception.KbRuntimeException;
import com.cyc.kb.exception.KbTypeConflictException;
import com.cyc.kb.exception.KbTypeException;
/**
* THIS IS NOT PART OF 1.0.0.
* @author vijay
*/
public class QuantifierImpl extends ScopingRelationImpl implements Quantifier {
private static final DenotationalTerm TYPE_CORE =
new CycConstantImpl("Quantifier", new Guid("bd58c271-9c29-11b1-9dad-c379636f7270"));
static DenotationalTerm getClassTypeCore() {
return TYPE_CORE;
}
/**
* default constructor, calls the default super constructor
*
* @throws Exception
*/
@SuppressWarnings("unused")
private QuantifierImpl() {
super();
}
/**
* Return a new
* Quantifier based on the existing predicate
* cycBinPred. The KB term underlying
* cycBinPred must already be an instance of #$Quantifier.
*
* @param cycQuantifier the CycObject wrapped by Quantifier. The constructor verifies that the
* CycObject is a #$Quantifier
* @throws KbTypeException if cycBinPred is not a #$Quantifier
*/
protected QuantifierImpl(CycObject cycQuantifier) throws KbTypeException {
super(cycQuantifier);
}
/**
* finds or creates a Quantifier represented by binPredStr in the underlying KB
*
*
* @param quantifierStr the string representing a Quantifier in the KB
* @throws CreateException if the Quantifier represented by predStr is not found and could not be
* created
* @throws KbTypeException
*/
public QuantifierImpl(String quantifierStr) throws KbTypeException, CreateException {
super(quantifierStr);
}
protected QuantifierImpl (String quantifierStr, LookupType lookup) throws KbTypeException, CreateException {
super(quantifierStr, lookup);
}
/**
* Get the
* Relation with the name
* nameOrId. Throws exceptions if there is no KB term by that name, or if it is not
* already an instance of #$Relation.
*
* @param nameOrId
* @return new Quantifier
* @throws CreateException
* @throws KbTypeException
*/
public static QuantifierImpl get(String nameOrId) throws KbTypeException, CreateException {
return KbObjectFactory.get(nameOrId, QuantifierImpl.class);
}
/**
* Get the
* Relation object that corresponds to
* object. Throws exceptions if the object isn't in the KB, or if it's not already an
* instance of
* #$Relation.
*
* @param cycObject
* @return new Quantifier
* @throws CreateException
* @throws KbTypeException
*/
@SuppressWarnings("deprecation")
public static QuantifierImpl get(CycObject cycObject) throws KbTypeException, CreateException {
return KbObjectFactory.get(cycObject, QuantifierImpl.class);
}
/**
* The KBAPI does not support the creation of new quantifiers. The
* get methods on quantifiers should be used to retrieve existing quantifiers.
*
* @param nameOrId
* @return new Quantifier
* @throws UnsupportedOperationException
* @deprecated Creation of new quantifiers is not supported in the KBAPI.
*/
public static QuantifierImpl findOrCreate(String nameOrId) {
throw new UnsupportedOperationException("Creation of new Quantifiers is not allowed. Please use a get method.");
}
/**
* The KBAPI does not support the creation of new quantifiers. The
* get methods on quantifiers should be used to retrieve existing quantifiers.
*
* @param cycObject
* @return new Quantifier
* @throws UnsupportedOperationException
* @deprecated Creation of new quantifiers is not supported in the KBAPI.
*/
public static QuantifierImpl findOrCreate(CycObject cycObject) {
throw new UnsupportedOperationException("Creation of new Quantifiers is not allowed. Please use a get method.");
}
/**
* Checks whether entity exists in KB and is an instance of #$Individual. 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 #$Individual
*/
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 #$Individual. If false,
* {@link #getStatus(CycObject)} may yield more information. This method is equivalent to
* getStatus(object).equals(KBStatus.EXISTS_AS_TYPE).
*
* @param cycObject either the name or HL ID of an entity in the KB
* @return true if entity exists in KB and is an instance of #$Individual
*/
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
* #$Individual.
*
* @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 KbObjectFactory.getStatus(nameOrId, QuantifierImpl.class);
}
/**
* Returns an KBStatus enum which describes whether
* object exists in the KB and is an instance of
* #$Individual.
*
* @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 KbObjectFactory.getStatus(cycObject, QuantifierImpl.class);
}
/**
* Return the KBCollection as a KBObject of the Cyc term that
* underlies this class.
*
* @return KBCollectionImpl.get("#$Quantifier");
*/
@Override
public KbObject getType() {
return getClassType();
}
/**
* Return the KBCollection as a KBObject of the Cyc term that
* underlies this class.
*
* @return KBCollectionImpl.get("#$Quantifier");
*/
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 "#$Quantifier";
}
}