KBmanager (sigma-component 2.09 API)

java.lang.Object
- com.articulate.sigma.KBmanager

```
public class KBmanager
extends Object
```
This is a class that manages a group of knowledge bases. It should only have one instance, contained in its own static member variable.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`CONFIG_FILE`
`boolean`	`initializing`
`protected HashMap<String,KB>`	`kbs`
`static int`	`USE_CACHE` A numeric (bitwise) constant used to signal whether the closure of instance and subclass relastions should be "cached out" for use by the inference engine.
`static int`	`USE_HOLDS_PREFIX` A numeric (bitwise) constant used to signal whether holds prefixes should be added during formula preprocessing.
`static int`	`USE_TPTP` A numeric (bitwise) constant used to signal whether formulas should be translated to TPTP format during the processing of KB constituent files.
`static int`	`USE_TYPE_PREFIX` A numeric (bitwise) constant used to signal whether type prefixes (sortals) should be added during formula preprocessing.

Constructor Summary

Constructors
Constructor and Description

KBmanager()

Constructors
Constructor and Description
`KBmanager()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addKB(String name)` Create a new empty KB with a name.
`void`	`addKB(String name, boolean isVisible)`
`ArrayList<String>`	`allAvailableLanguages()` Get the the complete list of languages available in all KBs
`static String`	`ccheckResults(String kbName)`
`static CCheckManager.CCheckStatus`	`ccheckStatus(String kbName)`
`static void`	`copyFile(File in, File out)` Read an XML-formatted configuration file.
`static String`	`escapeFilename(String fname)` Double the backslash in a filename so that it can be saved to a text file and read back properly.
`boolean`	`existsKB(String name)` Returns true if a KB with the given name exists.
`String`	`getError()` Get the error string for file loading.
`int`	`getInferenceBitValue()` Returns an int value, the bitwise interpretation of which indicates the current configuration of inference parameter (preference) settings.
`KB`	`getKB(String name)` Get the KB that has the given name.
`HashSet<String>`	`getKBnames()` Get the Set of KB names in this manager.
`static KBmanager`	`getMgr()` Get the one instance of KBmanager from its class variable.
`int`	`getOldInferenceBitValue()` Returns the last cached inference bit value setting.
`String`	`getPref(String key)` Get the preference corresponding to the given kef.
`boolean`	`initializeOnce()` Reads in the KBs and other parameters defined in the XML configuration file, or uses the default parameters.
`boolean`	`initializeOnce(String configFileDir)` Reads in the KBs and other parameters defined in the XML configuration file, or uses the default parameters.
`static CCheckManager.CCheckStatus`	`initiateCCheck(KB kb, String chosenEngine, String systemChosen, String location, String language, int timeout)`
`boolean`	`loadKB(String kbName, List<String> constituents)`
`static void`	`main(String[] args)` A test method.
`static KBmanager`	`newMgr(String username)` Reset the one instance of KBmanager from its class variable.
`protected SimpleElement`	`readConfiguration(String configDirPath)` Reads an XML configuration file from the directory configDirPath, and tries to find a configuration file elsewhere if configDirPath is null.
`void`	`remove(String name)` Remove the KB that has the given name.
`String`	`removeKB(String name)` Remove a knowledge base.
`void`	`setError(String er)` Set an error string for file loading.
`void`	`setOldInferenceBitValue(int bv)` Sets the value of the private variable oldInferenceBitValue.
`void`	`setPref(String key, String value)` Set the preference to the given value.
`void`	`writeConfiguration()` Write the current configuration of the system.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - USE_TYPE_PREFIX
```
public static final int USE_TYPE_PREFIX
```
    A numeric (bitwise) constant used to signal whether type prefixes (sortals) should be added during formula preprocessing.
    
    See Also:
    
    Constant Field Values
  - USE_HOLDS_PREFIX
```
public static final int USE_HOLDS_PREFIX
```
    A numeric (bitwise) constant used to signal whether holds prefixes should be added during formula preprocessing.
    
    See Also:
    
    Constant Field Values
  - USE_CACHE
```
public static final int USE_CACHE
```
    A numeric (bitwise) constant used to signal whether the closure of instance and subclass relastions should be "cached out" for use by the inference engine.
    
    See Also:
    
    Constant Field Values
  - USE_TPTP
```
public static final int USE_TPTP
```
    A numeric (bitwise) constant used to signal whether formulas should be translated to TPTP format during the processing of KB constituent files.
    
    See Also:
    
    Constant Field Values
  - CONFIG_FILE
```
protected static final String CONFIG_FILE
```
    See Also:
    
    Constant Field Values
  - kbs
```
protected HashMap<String,KB> kbs
```
  - initializing
```
public boolean initializing
```
- Constructor Detail
  - KBmanager
```
public KBmanager()
```
- Method Detail
  - setError
```
public void setError(String er)
```
    Set an error string for file loading.
  - getError
```
public String getError()
```
    Get the error string for file loading.
  - initiateCCheck
```
public static CCheckManager.CCheckStatus initiateCCheck(KB kb,
                                                        String chosenEngine,
                                                        String systemChosen,
                                                        String location,
                                                        String language,
                                                        int timeout)
```
  - ccheckResults
```
public static String ccheckResults(String kbName)
```
  - ccheckStatus
```
public static CCheckManager.CCheckStatus ccheckStatus(String kbName)
```
  - loadKB
```
public boolean loadKB(String kbName,
                      List<String> constituents)
```
  - copyFile
```
public static void copyFile(File in,
                            File out)
```
    Read an XML-formatted configuration file. The method initializeOnce() sets the preferences based on the contents of the configuration file. This routine has the side effect of setting the variable called "configuration". It also creates the KBs directory and an empty configuration file if none exists.
  - readConfiguration
```
protected SimpleElement readConfiguration(String configDirPath)
```
    Reads an XML configuration file from the directory configDirPath, and tries to find a configuration file elsewhere if configDirPath is null. The method initializeOnce() sets the preferences based on the contents of the configuration file. This routine has the side effect of setting the variable called "configuration". It also creates the KBs directory and an empty configuration file if none exists.
  - initializeOnce
```
public boolean initializeOnce()
```
    Reads in the KBs and other parameters defined in the XML configuration file, or uses the default parameters.
  - initializeOnce
```
public boolean initializeOnce(String configFileDir)
```
    Reads in the KBs and other parameters defined in the XML configuration file, or uses the default parameters. If configFileDir is not null and a configuration file can be read from the directory, reinitialization is forced.
  - escapeFilename
```
public static String escapeFilename(String fname)
```
    Double the backslash in a filename so that it can be saved to a text file and read back properly.
  - addKB
```
public void addKB(String name)
```
    Create a new empty KB with a name.
    
    Parameters:
    
    name - - the name of the KB
  - addKB
```
public void addKB(String name,
                  boolean isVisible)
```
  - removeKB
```
public String removeKB(String name)
```
    Remove a knowledge base.
    
    Parameters:
    
    name - - the name of the KB
  - writeConfiguration
```
public void writeConfiguration()
                        throws IOException
```
    Write the current configuration of the system. Call writeConfiguration() on each KB object to write its manifest.
    
    Throws:
    
    IOException
  - getKB
```
public KB getKB(String name)
```
    Get the KB that has the given name.
  - existsKB
```
public boolean existsKB(String name)
```
    Returns true if a KB with the given name exists.
  - remove
```
public void remove(String name)
```
    Remove the KB that has the given name.
  - getMgr
```
public static KBmanager getMgr()
```
    Get the one instance of KBmanager from its class variable.
  - newMgr
```
public static KBmanager newMgr(String username)
```
    Reset the one instance of KBmanager from its class variable.
  - getKBnames
```
public HashSet<String> getKBnames()
```
    Get the Set of KB names in this manager.
  - allAvailableLanguages
```
public ArrayList<String> allAvailableLanguages()
```
    Get the the complete list of languages available in all KBs
  - getPref
```
public String getPref(String key)
```
    Get the preference corresponding to the given kef.
  - setPref
```
public void setPref(String key,
                    String value)
```
    Set the preference to the given value.
  - getInferenceBitValue
```
public int getInferenceBitValue()
```
    Returns an int value, the bitwise interpretation of which indicates the current configuration of inference parameter (preference) settings. The int value is computed from the KBmanager preferences at the time this method is evaluated.
    
    Returns:
    
    An int value indicating the current configuration of inference parameters, according to KBmanager preference settings.
  - getOldInferenceBitValue
```
public int getOldInferenceBitValue()
```
    Returns the last cached inference bit value setting.
    
    Returns:
    
    An int value indicating the inference parameter configuration at the time the value was set.
  - setOldInferenceBitValue
```
public void setOldInferenceBitValue(int bv)
```
    Sets the value of the private variable oldInferenceBitValue.
  - main
```
public static void main(String[] args)
```
    A test method.

Class KBmanager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

USE_TYPE_PREFIX

USE_HOLDS_PREFIX

USE_CACHE

USE_TPTP

CONFIG_FILE

kbs

initializing

Constructor Detail

KBmanager

Method Detail

setError

getError

initiateCCheck

ccheckResults

ccheckStatus

loadKB

copyFile

readConfiguration

initializeOnce

initializeOnce

escapeFilename

addKB

addKB

removeKB

writeConfiguration

getKB

existsKB

remove

getMgr

newMgr

getKBnames

allAvailableLanguages

getPref

setPref

getInferenceBitValue

getOldInferenceBitValue

setOldInferenceBitValue

main