Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.cyc.kb.client.KbIndividualImpl Maven / Gradle / Ivy
package com.cyc.kb.client;
/*
* #%L
* File: KbIndividualImpl.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.KbCollection;
import com.cyc.kb.KbIndividual;
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;
import java.util.Map;
/**
* A KBIndividual object is a facade for a #$Individual
* in Cyc KB.
*
* Individual is anything that is not a set or collection. An individual
* can be abstract or concrete entity. Physical objects, relations, events
* and even groups are individuals. An individual can have parts but not
* elements or subsets.
*
* @param type of CycObject core
*
* @author Vijay Raj
* @version $Id: KbIndividualImpl.java 173082 2017-07-28 15:36:55Z nwinant $
*/
public class KbIndividualImpl extends KbTermImpl implements KbIndividual {
//private static final Logger LOG = LoggerFactory.getLogger(KbIndividualImpl.class.getName());
private static final DenotationalTerm TYPE_CORE =
new CycConstantImpl("Individual", new Guid("bd58da02-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.
*/
KbIndividualImpl() {
super();
}
protected KbIndividualImpl (KbIndividual ind) {
super();
this.setCore(ind);
}
/**
* 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 ind the KBIndividual to be copied
*/
protected KbIndividualImpl (DefaultContext c, KbIndividual ind) {
super();
this.setCore(ind);
if (((KbIndividualImpl)ind).getkboData() != null) {
this.setKboData(((KbIndividualImpl)ind).getkboData());
this.setTypeCore((KbCollection)((KbIndividualImpl)ind).getkboData().get("typeCore"));
}
}
public KbIndividualImpl (KbCollection c, KbIndividual ind) {
super();
this.setCore(ind);
this.setTypeCore(c);
}
public KbIndividualImpl (KbIndividual ind, Map kboData) {
super();
this.setCore(ind);
this.setKboData(kboData);
if (kboData.get("typeCore") != null) {
this.setTypeCore((KbCollection) kboData.get("typeCore"));
}
}
public KbIndividual reifyTypedVariable () throws Exception {
if (!this.isVariable()) {
return this;
} else {
return KbIndividualImpl.findOrCreate((String)this.getkboData().get("constantName"), (KbCollection)this.getType());
}
}
/**
* 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 KBIndividual.
*
* @param cycObject the CycObject wrapped by KBIndividual. The constructor
* verifies that the CycObject is an #$Individual
*
* @throws KbTypeException if cycObject is not an #$Individual
*/
KbIndividualImpl(DenotationalTerm cycObject) throws KbTypeException {
super(cycObject);
}
/* *
* EXPERIMENTAL!!! NOT PART OF THE KB API
* @param cycIndStr
* @param l
* @throws com.cyc.kb.exception.KbTypeException
* @throws com.cyc.kb.exception.CreateException
* /
protected KbIndividualImpl(String cycIndStr, List l) throws KbTypeException, CreateException {
super(cycIndStr, l);
}
*/
/* *
* EXPERIMENTAL!!! NOT PART OF THE KB API
* @return
* @throws com.cyc.kb.exception.KbException
* /
public static KbIndividual some() throws KbException {
List l = new ArrayList<>();
l.add(QuantifierImpl.get("thereExists"));
KbIndividual o = new KbIndividualImpl("?IND", l);
return o;
}
/* *
* EXPERIMENTAL!!! NOT PART OF THE KB API
* @return
* @throws com.cyc.kb.exception.KbException
* /
public static KbObject all() throws KbException {
List l = new ArrayList<>();
l.add(QuantifierImpl.get("forAll"));
KbIndividualImpl o = new KbIndividualImpl("?IND", l);
return o;
}
*/
/**
* This not part of the public, supported KB API. finds or creates an individual represented
* by indStr in the underlying KB
*
*
* @param indStr the string representing an #$Individual in the KB
*
* @throws CreateException if the #$Individual represented by indStr is not found
* and could not be created
* @throws KbTypeException if the term represented by indStr is not an instance
* of #$Individual and cannot be made into one.
*/
protected KbIndividualImpl(String indStr) throws KbTypeException, CreateException {
super(indStr);
}
/**
* This not part of the public, supported KB API. finds or creates; or finds an individual
* represented by indStr in the underlying KB based on input ENUM
*
*
* @param indStr the string representing an #$Individual in the KB
* @param lookup the enum to specify LookupType: FIND or FIND_OR_CREATE
*
* @throws CreateException
* @throws KbTypeException
*
* @throws KbObjectNotFoundException if the #$Individual represented by indStr
* is not found and could not be created
* @throws InvalidNameException if the string indStr does not conform to Cyc constant-naming
* conventions
*
* @throws KbTypeException if the term represented by indStr is not an #$Individual and lookup is
* set to find only {@link LookupType#FIND} an #$Individual
* @throws KbTypeConflictException if the term represented by indStr is not an #$Individual,
* and lookup is set to find or create; and if the term cannot be made an #$Individual by asserting
* new knowledge.
*/
KbIndividualImpl(String indStr, LookupType lookup) throws KbTypeException, CreateException {
super(indStr, lookup);
}
/**
* Get the
* KBIndividual with the name
* nameOrId. Throws exceptions if there is no KB term by that
* name, or if it is not already an instance of #$Individual.
*
* @param nameOrId the string representation or the HLID of the #$Individual
*
* @return a new KBIndividual
*
* @throws KbTypeException
* @throws CreateException
*/
public static KbIndividualImpl get(String nameOrId) throws KbTypeException, CreateException {
return KbObjectImplFactory.get(nameOrId, KbIndividualImpl.class);
}
/**
* Get the
* KBIndividual object that corresponds to
* cycObject. Throws exceptions if the object isn't in the KB, or if
* it's not already an instance of
* #$Individual.
*
* @param cycObject the CycObject wrapped by KBIndividual. The method
* verifies that the CycObject is an #$Individual
*
* @return a new KBIndividual
*
* @throws CreateException
* @throws KbTypeException
*/
@Deprecated
public static KbIndividualImpl get(CycObject cycObject) throws KbTypeException, CreateException {
return KbObjectImplFactory.get(cycObject, KbIndividualImpl.class);
}
/**
* Find or create a
* KBIndividual 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
* #$Individual. If there is already an object in the KB called
* nameOrId, and it is already a
* #$Individual, it will be returned. If it is not already a
* #$Individual, 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
* #$Individual by adding assertions (i.e. some existing
* assertion prevents it from being a
* #$Individual), a
* KBTypeConflictExceptionwill be thrown.
*
* @param nameOrId the string representation or the HLID of the #$Individual
*
* @return a new KBIndividual
*
* @throws KbTypeException
* @throws CreateException
*/
public static KbIndividualImpl findOrCreate(String nameOrId) throws CreateException, KbTypeException {
return KbObjectImplFactory.findOrCreate(nameOrId, KbIndividualImpl.class);
}
/**
* Find or create a KBIndividual object from
* cycObject. If
* cycObject is already a
* #$Individual, an appropriate
* KBIndividual object will be returned. If
* object is not already a
* #$Individual, 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
* #$Individual by adding assertions (i.e. some existing
* assertion prevents it from being a
* #$Individual, a
* KBTypeConflictExceptionwill be thrown.
*
* @param cycObject the CycObject wrapped by KBIndividual. The method
* verifies that the CycObject is an #$Individual
*
* @return a new KBIndividual
*
* @throws KbTypeException
* @throws CreateException
*/
@Deprecated
public static KbIndividualImpl findOrCreate(CycObject cycObject) throws CreateException, KbTypeException {
return KbObjectImplFactory.findOrCreate(cycObject, KbIndividualImpl.class);
}
/**
* Find or create a
* KBIndividual 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
* #$Individual and
* constraintCol. If there is already an object in the
* KB called
* nameOrId, and it is already both a
* #$Individual and a
* constraintCol, it will be returned. If it is not
* already both a
* #$Individual 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
* #$Individual and a
* constraintCol by adding assertions, a
* KBTypeConflictExceptionwill be thrown.
*
* @param nameOrId the string representation or the HLID of the #$Individual
* @param constraintCol the collection that this #$Individual will instantiate
*
* @return a new KBIndividual
*
* @throws KbTypeException
* @throws CreateException
*/
public static KbIndividualImpl findOrCreate(String nameOrId, KbCollection constraintCol) throws CreateException, KbTypeException {
return KbObjectImplFactory.findOrCreate(nameOrId, constraintCol, KbIndividualImpl.class);
}
/**
* Find or create a
* KBIndividual 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
* #$Individual and
* constraintCol. If there is already an object in the
* KB called
* nameOrId, and it is already both a
* #$Individual and a
* constraintCol, it will be returned. If it is not
* already both a
* #$Individual 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
* #$Individual and a
* constraintCol by adding assertions, a
* KBTypeConflictExceptionwill be thrown.
*
* @param nameOrId the string representation or the HLID of the #$Individual
* @param constraintColStr the string representation of the collection that
* this #$Individual will instantiate
*
* @return a new KBIndividual
*
* @throws KbTypeException
* @throws CreateException
*/
public static KbIndividualImpl findOrCreate(String nameOrId, String constraintColStr) throws CreateException, KbTypeException {
return KbObjectImplFactory.findOrCreate(nameOrId, constraintColStr, KbIndividualImpl.class);
}
/**
* Find or create a
* KBIndividual 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
* #$Individual and
* constraintCol. If there is already an object in the
* KB called
* nameOrId, and it is already both a
* #$Individual and a
* constraintCol, it will be returned. If it is not
* already both a
* #$Individual 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
* #$Individual and a
* constraintCol by adding assertions, a
* KBTypeConflictExceptionwill be thrown.
*
* @param nameOrId the string representation or the HLID of the #$Individual
* @param constraintCol the collection that this #$Individual will instantiate
* @param ctx the context in which the resulting object must be an instance of
* constraintCol
*
* @return a new KBIndividual
*
* @throws KbTypeException
* @throws CreateException
*/
public static KbIndividualImpl findOrCreate(String nameOrId, KbCollection constraintCol, Context ctx)
throws CreateException, KbTypeException {
return KbObjectImplFactory.findOrCreate(nameOrId, constraintCol, ctx, KbIndividualImpl.class);
}
/**
* Find or create a
* KBIndividual 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
* #$Individual and
* constraintCol. If there is already an object in the
* KB called
* nameOrId, and it is already both a
* #$Individual and a
* constraintCol, it will be returned. If it is not
* already both a
* #$Individual 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
* #$Individual 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 #$Individual will instantiate
* @param ctxStr the context in which the resulting object must be an instance of
* constraintCol
*
* @return a new KBIndividual
*
* @throws KbTypeException
* @throws CreateException
*/
public static KbIndividualImpl findOrCreate(String nameOrId, String constraintColStr, String ctxStr)
throws CreateException, KbTypeException {
return KbObjectImplFactory.findOrCreate(nameOrId, constraintColStr, ctxStr, KbIndividualImpl.class);
}
/**
* 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 the CycObject representation of a KB entity
* @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 KbObjectImplFactory.getStatus(nameOrId, KbIndividualImpl.class);
}
/**
* Returns an KBStatus enum which describes whether
* cycObject 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 KbObjectImplFactory.getStatus(cycObject, KbIndividualImpl.class);
}
@Override
public Collection instanceOf() {
return instanceOf(KbConfiguration.getDefaultContext().forQuery());
}
@Override
public Collection instanceOf(String ctxStr) {
return instanceOf(KbUtils.getKBObjectForArgument(ctxStr, ContextImpl.class));
}
@Override
public Collection instanceOf(Context ctx) {
return Constants.isa().getValuesForArgPosition(this, 1, 2, ctx);
}
/**
* Return the KBCollection as a KBObject of the Cyc term that
* underlies this class.
*
* @return KBCollectionImpl.get("#$Individual");
*/
@Override
public KbObject getType() {
if (this.getTypeCore() == null) {
return getClassType();
} else {
return this.getTypeCore();
}
}
public Map getkboData() {
return this.getKboData();
}
/**
* Return the KBCollection as a KBObject of the Cyc term that
* underlies this class.
*
* @return KBCollectionImpl.get("#$Individual");
*/
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 "#$Individual";
}
@Override
public boolean isQuoted() throws KbTypeException, CreateException {
return (getArity() == 1) && (getArgument(0) == Constants.getInstance().QUOTE_FUNC);
}
@Override
public O unquote() throws KbTypeException, CreateException {
if (!isQuoted()) {
return (O) super.unquote();
}
return getArgument(1);
}
}
