com.cyc.kb.client.SymbolImpl Maven / Gradle / Ivy
Show all versions of cyc-kb-client Show documentation
/*
* To change this template, choose Tools | Templates
* and open the template in the editor.
*/
package com.cyc.kb.client;
/*
* #%L
* File: SymbolImpl.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.CycSymbol;
import com.cyc.baseclient.cycobject.CycSymbolImpl;
import com.cyc.kb.KbObject;
import com.cyc.kb.Symbol;
import com.cyc.kb.exception.KbException;
import com.cyc.kb.exception.KbRuntimeException;
import com.cyc.kb.exception.KbTypeException;
/**
* A Symbol object is a facade for a quoted instance of
* #$CycLSubLSymbol in Cyc KB.
*
* This class of objects are used in construction of sentences with replacement
* arguments, for example in stored queries for testing. The usage of this is
* rare, but the API supports it for completeness.
*
* @author Vijay Raj
* @version $Id: SymbolImpl.java 173072 2017-07-27 01:21:15Z nwinant $
*/
public class SymbolImpl extends StandardKbObject implements Symbol {
/**
* Not part of the KB API. This default constructor only has the effect of
* ensuring that there is access to a Cyc server.
*/
SymbolImpl() {
super();
}
/**
* An implementation-dependent constructor. Symbol does not have factory
* methods in the current version of the API
*
*
* @param cycObject the CycObject wrapped by Symbol. The constructor
verifies that the CycObject is an instance of CycSymbolImpl
*
* @throws KbTypeException if it is not an instance of CycSymbolImpl
*/
@Deprecated
public SymbolImpl(CycSymbol cycObject) throws KbTypeException {
super(cycObject);
}
/**
* Creates an instance of #$CycLSubLSymbol represented
* by symStr in the underlying KB
*
*
* @param symStr the string representing an #$CycLSubLSymbol in the KB
*
* @throws KbTypeException Symbols are created on demand and are not expected to throw
* any exception
*/
// TODO: verify what kind of exception is thrown for an invalid name
public SymbolImpl(String symStr) throws KbTypeException {
super(new CycSymbolImpl(symStr));
}
/**
* This not part of the public, supported KB API. Check that the candidate core
object is a valid CycSymbolImpl.
Example: ":PERSON"
*
* @param cycObject
* the object that is checked to be an instance of CycSymbolImpl
*
* @return if a cycObject is of an instance of CycSymbolImpl
*
* @see StandardKBObject#isValidCore(CycObject) for more comments
*/
@Override
protected boolean isValidCore(CycObject cycObject) {
return cycObject instanceof CycSymbol;
}
/**
* Return the KBCollection as a KBObject of the Cyc term that
* underlies this class.
*
* @return KBCollectionImpl.get("#$CycLSubLSymbol");
*/
@Override
public KbObject getType() {
return getClassType();
}
/**
* Return the KBCollection as a KBObject of the Cyc term that
* underlies this class.
*
* @return KBCollectionImpl.get("#$CycLSubLSymbol");
*/
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 "#$CycLSubLSymbol";
}
}