com.cyc.kb.client.FirstOrderCollectionImpl Maven / Gradle / Ivy
Show all versions of cyc-kb-client Show documentation
package com.cyc.kb.client;
/*
* #%L
* File: FirstOrderCollectionImpl.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.Context;
import com.cyc.kb.DefaultContext;
import com.cyc.kb.FirstOrderCollection;
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 FirstOrderCollection object is a facade for a
* #$FirstOrderCollection in Cyc KB.
*
* A #$FirstOrderCollection is a specialization of #$Collection. It is a collection of
* collections that have only #$Individual as its instances. The higher level APIs that use
* the KB API utilize this subclass (specialization) of KBCollection (#$Collection.)
* So we have a class to support strongly typing such collections.
*
* @param type of CycObject core
*
* @author Vijay Raj
* @version $Id: FirstOrderCollectionImpl.java 173082 2017-07-28 15:36:55Z nwinant $
*/
public class FirstOrderCollectionImpl extends KbCollectionImpl implements FirstOrderCollection {
private static final DenotationalTerm TYPE_CORE =
new CycConstantImpl("FirstOrderCollection", new Guid("1c8052d2-1fd3-11d6-8000-0050dab92c2f"));
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.
*/
protected FirstOrderCollectionImpl() {
super();
}
/**
* EXPERIMENTAL!!! NOT PART OF THE KB API
*
* A copy constructor to allow higher level APIs to construct
* subclass objects using super class objects, when appropriate.
*
* @param c
* @param foCol the FirstOrderCollection to be copied
*/
protected FirstOrderCollectionImpl (DefaultContext c, FirstOrderCollection foCol) {
super();
this.setCore(foCol);
}
/**
* 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 FirstOrderCollection.
*
* @param cycObject the CycObject wrapped by FirstOrderCollection. The constructor
* verifies that the CycObject is an instance of #$FirstOrderCollection
*
* @throws KbTypeException if cycObject is not or could not be made
* an instance of #$FirstOrderCollection
*/
FirstOrderCollectionImpl(DenotationalTerm cycObject) throws KbTypeException {
super(cycObject);
}
/**
* This not part of the public, supported KB API. finds or creates an instance of #$FirstOrderCollection represented
* by foColStr in the underlying KB
*
*
* @param foColStr the string representing an instance of #$FirstOrderCollection in the KB
*
* @throws CreateException if the #$FirstOrderCollection represented by foColStr is not found
* and could not be created
* @throws KbTypeException if the term represented by foColStr is not an instance
* of #$FirstOrderCollection and cannot be made into one.
*/
FirstOrderCollectionImpl(String foColStr) throws KbTypeException, CreateException {
super(foColStr);
}
/**
* This not part of the public, supported KB API. finds or creates; or finds an instance of #$FirstOrderCollection
* represented by foColStr in the underlying KB based on input ENUM
*
*
* @param foColStr the string representing an instance of #$FirstOrderCollection in the KB
* @param lookup the enum to specify LookupType: FIND or FIND_OR_CREATE
*
* @throws CreateException
* @throws KbTypeException
*
* @throws KbObjectNotFoundException if the #$FirstOrderCollection represented by foColStr
* is not found and could not be created
* @throws InvalidNameException if the string foColStr does not conform to Cyc constant-naming
* conventions
*
* @throws KbTypeException if the term represented by foColStr is not an instance of #$FirstOrderCollection and lookup is
* set to find only {@link LookupType#FIND}
* @throws KbTypeConflictException if the term represented by foColStr is not an instance of #$FirstOrderCollection,
* and lookup is set to find or create; and if the term cannot be made an instance #$FirstOrderCollection by asserting
* new knowledge.
*/
FirstOrderCollectionImpl(String foColStr, LookupType lookup) throws KbTypeException, CreateException {
super(foColStr, lookup);
}
/**
* Get the
* FirstOrderCollection with the name
* nameOrId. Throws exceptions if there is no KB term by that
* name, or if it is not already an instance of #$FirstOrderCollection.
*
* @param nameOrId the string representation or the HLID of the #$FirstOrderCollection
*
* @return a new FirstOrderCollection
*
* @throws KbTypeException
* @throws CreateException
*/
public static FirstOrderCollectionImpl get(String nameOrId) throws KbTypeException, CreateException {
return KbObjectImplFactory.get(nameOrId, FirstOrderCollectionImpl.class);
}
/**
* Get the
* FirstOrderCollection object that corresponds to
* cycObject. Throws exceptions if the object isn't in the KB, or if
* it's not already an instance of
* #$FirstOrderCollection.
*
* @param cycObject the CycObject wrapped by FirstOrderCollection. The method
* verifies that the CycObject is an instance of #$FirstOrderCollection
*
* @return a new FirstOrderCollection
*
* @throws CreateException
* @throws KbTypeException
*/
@Deprecated
public static FirstOrderCollectionImpl get(CycObject cycObject) throws KbTypeException, CreateException {
return KbObjectImplFactory.get(cycObject, FirstOrderCollectionImpl.class);
}
/**
* Find or create a
* FirstOrderCollection 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
* #$FirstOrderCollection. If there is already an object in the KB called
* nameOrId, and it is already a
* #$FirstOrderCollection, it will be returned. If it is not already a
* #$FirstOrderCollection, 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
* #$FirstOrderCollection by adding assertions (i.e. some existing
* assertion prevents it from being a
* #$FirstOrderCollection), a
* KBTypeConflictExceptionwill be thrown.
*
* @param nameOrId the string representation or the HLID of the #$FirstOrderCollection
*
* @return a new FirstOrderCollection
*
* @throws KbTypeException
* @throws CreateException
*/
public static FirstOrderCollectionImpl findOrCreate(String nameOrId) throws CreateException, KbTypeException {
return KbObjectImplFactory.findOrCreate(nameOrId, FirstOrderCollectionImpl.class);
}
/**
* Find or create a FirstOrderCollection object from
* cycObject. If
* cycObject is already a
* #$FirstOrderCollection, an appropriate
* FirstOrderCollection object will be returned. If
* object is not already a
* #$FirstOrderCollection, 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
* #$FirstOrderCollection by adding assertions (i.e. some existing
* assertion prevents it from being a
* #$FirstOrderCollection, a
* KBTypeConflictExceptionwill be thrown.
*
* @param cycObject the CycObject wrapped by FirstOrderCollection. The method
* verifies that the CycObject is an #$FirstOrderCollection
*
* @return a new FirstOrderCollection
*
* @throws KbTypeException
* @throws CreateException
*/
@Deprecated
public static FirstOrderCollectionImpl findOrCreate(CycObject cycObject) throws CreateException, KbTypeException {
return KbObjectImplFactory.findOrCreate(cycObject, FirstOrderCollectionImpl.class);
}
/**
* Find or create a
* FirstOrderCollection 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
* #$FirstOrderCollection and
* constraintCol. If there is already an object in the
* KB called
* nameOrId, and it is already both a
* #$FirstOrderCollection and a
* constraintCol, it will be returned. If it is not
* already both a
* #$FirstOrderCollection 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
* #$FirstOrderCollection and a
* constraintCol by adding assertions, a
* KBTypeConflictExceptionwill be thrown.
*
* @param nameOrId the string representation or the HLID of the #$FirstOrderCollection
* @param constraintCol the collection that this #$FirstOrderCollection will instantiate
*
* @return a new FirstOrderCollection
*
* @throws KbTypeException
* @throws CreateException
*/
public static FirstOrderCollectionImpl findOrCreate(String nameOrId, KbCollection constraintCol) throws CreateException, KbTypeException {
return KbObjectImplFactory.findOrCreate(nameOrId, constraintCol, FirstOrderCollectionImpl.class);
}
/**
* Find or create a
* FirstOrderCollection 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
* #$FirstOrderCollection and
* constraintCol. If there is already an object in the
* KB called
* nameOrId, and it is already both a
* #$FirstOrderCollection and a
* constraintCol, it will be returned. If it is not
* already both a
* #$FirstOrderCollection 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
* #$FirstOrderCollection and a
* constraintCol by adding assertions, a
* KBTypeConflictExceptionwill be thrown.
*
* @param nameOrId the string representation or the HLID of the #$FirstOrderCollection
* @param constraintColStr the string representation of the collection that
* this #$FirstOrderCollection will instantiate
*
* @return a new FirstOrderCollection
*
* @throws KbTypeException
* @throws CreateException
*/
public static FirstOrderCollectionImpl findOrCreate(String nameOrId, String constraintColStr) throws CreateException, KbTypeException {
return KbObjectImplFactory.findOrCreate(nameOrId, constraintColStr, FirstOrderCollectionImpl.class);
}
/**
* Find or create a
* FirstOrderCollection 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
* #$FirstOrderCollection and
* constraintCol. If there is already an object in the
* KB called
* nameOrId, and it is already both a
* #$FirstOrderCollection and a
* constraintCol, it will be returned. If it is not
* already both a
* #$FirstOrderCollection 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
* #$FirstOrderCollection and a
* constraintCol by adding assertions, a
* KBTypeConflictExceptionwill be thrown.
*
* @param nameOrId the string representation or the HLID of the #$FirstOrderCollection
* @param constraintCol the collection that this #$FirstOrderCollection will instantiate
* @param ctx the context in which the resulting object must be an instance of
* constraintCol
*
* @return a new FirstOrderCollection
*
* @throws KbTypeException
* @throws CreateException
*/
public static FirstOrderCollectionImpl findOrCreate(String nameOrId, KbCollection constraintCol, Context ctx) throws CreateException, KbTypeException {
return KbObjectImplFactory.findOrCreate(nameOrId, constraintCol, ctx, FirstOrderCollectionImpl.class);
}
/**
* Find or create a
* FirstOrderCollection 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
* #$FirstOrderCollection and
* constraintCol. If there is already an object in the
* KB called
* nameOrId, and it is already both a
* #$FirstOrderCollection and a
* constraintCol, it will be returned. If it is not
* already both a
* #$FirstOrderCollection 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
* #$FirstOrderCollection 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 #$FirstOrderCollection will instantiate
* @param ctxStr the context in which the resulting object must be an instance of
* constraintCol
*
* @return a new FirstOrderCollection
*
* @throws KbTypeException
* @throws CreateException
*/
public static FirstOrderCollectionImpl findOrCreate(String nameOrId, String constraintColStr, String ctxStr) throws CreateException, KbTypeException {
return KbObjectImplFactory.findOrCreate(nameOrId, constraintColStr, ctxStr, FirstOrderCollectionImpl.class);
}
/**
* Checks whether entity exists in KB and is an instance of #$FirstOrderCollection. 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
* #$FirstOrderCollection
*/
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 #$FirstOrderCollection. 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
* #$FirstOrderCollection
*/
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
* #$FirstOrderCollection.
*
* @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, FirstOrderCollectionImpl.class);
}
/**
* Returns an KBStatus enum which describes whether
* cycObject exists in the KB and is an instance of
* #$FirstOrderCollection.
*
* @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, FirstOrderCollectionImpl.class);
}
// This method need not be defined, but is to make sure that the return value
// is explicitly a list of FirstOrderCollection, not just list of KBCollection
// which actually does contain FirstOrderCollection getInstances.
@Override
public Collection getGeneralizations() {
return getGeneralizations(KbConfiguration.getDefaultContext().forQuery());
}
@Override
public Collection getGeneralizations(String ctxStr) {
return getGeneralizations(KbUtils.getKBObjectForArgument(ctxStr, ContextImpl.class));
}
@Override
public Collection getGeneralizations(Context ctx) {
//return (this.getValues(Constants.genls(), 1, 2, ctx));
return Constants.genls().getValuesForArgPosition(this, 1, 2, ctx);
}
@Override
public FirstOrderCollection addGeneralization(String moreGeneralStr, String ctxStr) throws KbTypeException, CreateException {
FirstOrderCollectionImpl c;
ContextImpl ctx;
try {
c = FirstOrderCollectionImpl.get(moreGeneralStr);
ctx = ContextImpl.get(ctxStr);
} catch (KbException e){
throw new IllegalArgumentException(e.getMessage(), e);
}
return addGeneralization(c, ctx);
}
@Override
public FirstOrderCollection addGeneralization(KbCollection moreGeneral, Context ctx) throws KbTypeException, CreateException {
Context ctx1 = Constants.uvMt();
if (moreGeneral.isInstanceOf((KbCollection)FirstOrderCollectionImpl.getClassType(), ctx1)) {
//this check is not strictly necessary, but will reduce the wff-checking that needs to happen Cyc-side.
super.addGeneralization(moreGeneral, ctx);
} else {
throw new CreateException("The collection " + moreGeneral + " is not an instance of #$FirstOrderCollection");
}
return this;
}
/**
* Return the KBCollection as a KBObject of the Cyc term that
* underlies this class.
*
* @return KBCollectionImpl.get("#$FirstOrderCollection");
*/
@Override
public KbObject getType() {
return getClassType();
}
/**
* Return the KBCollection as a KBObject of the Cyc term that
* underlies this class.
*
* @return KBCollectionImpl.get("#$FirstOrderCollection");
*/
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 "#$FirstOrderCollection";
}
}