KBcache

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

All Implemented Interfaces:: java.io.Serializable

public class KBcache
extends java.lang.Object
implements java.io.Serializable

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`_cacheFileSuffix`
`java.util.HashMap<java.lang.String,java.util.HashMap<java.lang.String,java.util.HashSet<java.lang.String>>>`	`children` All the cached "child" relations of all transitive relations meaning the relations between all first arguments and the transitive closure of second arguments.
`static boolean`	`debug`
`java.util.HashMap<java.lang.String,java.util.HashSet<java.lang.String>>`	`explicitDisjointRelations` Disjoint relations which were explicitly defined in "partition", "disjoint", "disjointDecomposition" and "exhaustiveDecomposition" expressions
`java.util.HashMap<java.lang.String,java.util.HashSet<java.lang.String>>`	`instances` Parent relations from instances, including those that are transitive through (instance,instance) relations, such as subAttribute and subrelation
`java.util.HashSet<java.lang.String>`	`insts` A temporary list of instances built during creation of the children map, in order to efficiently create the instances map
`java.util.HashSet<java.lang.String>`	`instTransRels`
`KB`	`kb`
`java.util.HashMap<java.lang.String,java.util.HashMap<java.lang.String,java.util.HashSet<java.lang.String>>>`	`parents` All the cached "parent" relations of all transitive relations meaning the relations between all first arguments and the transitive closure of second arguments.
`java.util.HashSet<java.lang.String>`	`relations`
`java.util.HashMap<java.lang.String,java.util.ArrayList<java.lang.String>>`	`signatures` Relation name keys and argument types with 0th arg always "" except in the case of Functions where the 0th arg will be the function range.
`java.util.HashSet<java.lang.String>`	`transRels`
`java.util.HashMap<java.lang.String,java.lang.Integer>`	`valences`

Constructor Summary

Constructors
Constructor and Description

KBcache()
empty constructor for testing only

KBcache(KB kb)

KBcache(KBcache kbCacheIn, KB kbIn)

Constructors
Constructor and Description
`KBcache()` empty constructor for testing only
`KBcache(KB kb)`
`KBcache(KBcache kbCacheIn, KB kbIn)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`buildCaches()` Main entry point for the class.
`void`	`buildChildren()` For each transitive relation, find its transitive closure.
`void`	`buildDirectInstances()` Record instances and their explicitly defined parent classes
`void`	`buildDisjointRelationsMap()` build a disjoint-relations-map which were explicitly defined in "partition", "exhaustiveDecomposition", "disjointDecomposition" and "disjoint" expressions;
`void`	`buildInstTransRels()` Compile the set of transitive relations that are between instances
`void`	`buildParents()` For each transitive relation, find its transitive closure.
`void`	`buildRelationsSet()` Do a proper search for relations (including Functions), utilizing the formal definitions, rather than the convention of initial lower case letter.
`void`	`buildTransInstOf()` Cache whether a given instance has a given parent class.
`void`	`buildTransitiveRelationsSet()` Do a proper search for relations (including Functions), utilizing the formal definitions, rather than the convention of initial lower case letter.
`static boolean`	`checkDisjoint(KB kb, java.util.HashSet<java.lang.String> typeSet)` check if there are any two types in typeSet are disjoint or not;
`static boolean`	`checkDisjoint(KB kb, java.lang.String rel1, java.lang.String rel2)` check if rel1 and rel2 are disjoint return true if rel1 and rel2 are disjoint; otherwise return false.
`boolean`	`childOfP(java.lang.String rel, java.lang.String parent, java.lang.String child)` Find whether the given child has the given parent for the given transitive relation.
`static java.util.HashSet<java.lang.String>`	`collectArgFromFormulas(int arg, java.util.ArrayList<Formula> forms)` Get the HashSet of the given arguments from an ArrayList of Formulas.
`void`	`collectDomains()` Build the argument type list for every relation.
`void`	`copyNewPredFromVariableArity(java.lang.String pred, java.lang.String oldPred, int arity)` Copy all relevant information from a VariableArityRelation to a new predicate that is a particular fixed arity.
`int`	`getArity(java.lang.String rel)` An ArrayList utility method
`java.util.HashSet<java.lang.String>`	`getChildClasses(java.lang.String cl)` return child classes for the given cl from subclass expressions.
`java.util.HashSet<java.lang.String>`	`getChildInstances(java.lang.String cl)` return child classes for the given cl from subclass expressions.
`java.util.HashSet<java.lang.String>`	`getChildTerms(java.lang.String cl, java.lang.String rel)` return child term for the given cl from rel expressions.
`java.lang.String`	`getCommonParent(java.lang.String t1, java.lang.String t2)`
`java.util.HashSet<java.lang.String>`	`getInstancesForType(java.lang.String cl)` Get all instances for the given input class For example, given the class "Nation", getInstancesForType(Nation) returns all instances, like "America", "Austria", "Albania", etc.
`java.util.HashSet<java.lang.String>`	`getParentClasses(java.lang.String cl)` return parent classes for the given cl from subclass expressions.
`java.util.HashSet<java.lang.String>`	`getParentClassesOfInstance(java.lang.String cl)` return classes for the given instance cl.
`void`	`inheritDomains()` Find domain and domainSubclass definitions that impact a child relation.
`boolean`	`isExplicitDisjoint(java.util.HashMap<java.lang.String,java.util.HashSet<java.lang.String>> explicitDisjointRelations, java.lang.String rel1, java.lang.String rel2)` return true if rel1 and rel2 are explicitly defined as disjoint relations; otherwise return false.
`boolean`	`isInstanceOf(java.lang.String i, java.lang.String c)` Returns true if i is an instance of c, else returns false.
`static void`	`main(java.lang.String[] args)`
`java.lang.String`	`mostSpecificParent(java.util.HashSet<java.lang.String> p1)`
`void`	`showState()`
`boolean`	`subAttributeOf(java.lang.String child, java.lang.String parent)` Find whether the given class is the subAttribute of the given parent class.
`boolean`	`subclassOf(java.lang.String child, java.lang.String parent)` Find whether the given class has the given parent class.
`boolean`	`transInstOf(java.lang.String child, java.lang.String parent)` Find whether the given instance has the given parent class.
`void`	`writeCacheFile()` Delete and writes the cache .kif file then call addConstituent() so that the file can be processed and loaded by the inference engine.

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

- Field Detail
  - kb
```
public KB kb
```
  - debug
```
public static boolean debug
```
  - _cacheFileSuffix
```
public static final java.lang.String _cacheFileSuffix
```
    See Also:
    
    Constant Field Values
  - relations
```
public java.util.HashSet<java.lang.String> relations
```
  - transRels
```
public java.util.HashSet<java.lang.String> transRels
```
  - instTransRels
```
public java.util.HashSet<java.lang.String> instTransRels
```
  - parents
```
public java.util.HashMap<java.lang.String,java.util.HashMap<java.lang.String,java.util.HashSet<java.lang.String>>> parents
```
    All the cached "parent" relations of all transitive relations meaning the relations between all first arguments and the transitive closure of second arguments. The external HashMap pairs relation name String keys to values that are the parent relationships. The interior HashMap is the set of terms and their transitive closure of parents.
  - instances
```
public java.util.HashMap<java.lang.String,java.util.HashSet<java.lang.String>> instances
```
    Parent relations from instances, including those that are transitive through (instance,instance) relations, such as subAttribute and subrelation
  - insts
```
public java.util.HashSet<java.lang.String> insts
```
    A temporary list of instances built during creation of the children map, in order to efficiently create the instances map
  - children
```
public java.util.HashMap<java.lang.String,java.util.HashMap<java.lang.String,java.util.HashSet<java.lang.String>>> children
```
    All the cached "child" relations of all transitive relations meaning the relations between all first arguments and the transitive closure of second arguments. The external HashMap pairs relation name String keys to values that are the child relationships. The interior HashMap is the set of terms and their transitive closure of children.
  - signatures
```
public java.util.HashMap<java.lang.String,java.util.ArrayList<java.lang.String>> signatures
```
    Relation name keys and argument types with 0th arg always "" except in the case of Functions where the 0th arg will be the function range. Variable arity relations may have a type for the last argument, which will be the type repeated for all extended arguments. Note that types can be functions, rather than just terms. Note that types (when there's a domainSubclass etc) are designated by a '+' appended to the class name.
  - valences
```
public java.util.HashMap<java.lang.String,java.lang.Integer> valences
```
  - explicitDisjointRelations
```
public java.util.HashMap<java.lang.String,java.util.HashSet<java.lang.String>> explicitDisjointRelations
```
    Disjoint relations which were explicitly defined in "partition", "disjoint", "disjointDecomposition" and "exhaustiveDecomposition" expressions
- Constructor Detail
  - KBcache
```
public KBcache()
```
    empty constructor for testing only
  - KBcache
```
public KBcache(KB kb)
```
  - KBcache
```
public KBcache(KBcache kbCacheIn,
               KB kbIn)
```
- Method Detail
  - getArity
```
public int getArity(java.lang.String rel)
```
    An ArrayList utility method
  - childOfP
```
public boolean childOfP(java.lang.String rel,
                        java.lang.String parent,
                        java.lang.String child)
```
    Find whether the given child has the given parent for the given transitive relation. Return false if they are equal
  - isInstanceOf
```
public boolean isInstanceOf(java.lang.String i,
                            java.lang.String c)
```
    Returns true if i is an instance of c, else returns false.
    
    Parameters:
    
    i - A String denoting an instance.
    
    c - A String denoting a Class.
    
    Returns:
    
    true or false.
  - transInstOf
```
public boolean transInstOf(java.lang.String child,
                           java.lang.String parent)
```
    Find whether the given instance has the given parent class. Include paths the have transitive relations between instances such as an Attribute that is a subAttribute of another instance, which in turn then is an instance of the given class. Return false if they are equal.
  - subclassOf
```
public boolean subclassOf(java.lang.String child,
                          java.lang.String parent)
```
    Find whether the given class has the given parent class.
  - subAttributeOf
```
public boolean subAttributeOf(java.lang.String child,
                              java.lang.String parent)
```
    Find whether the given class is the subAttribute of the given parent class.
  - buildDirectInstances
```
public void buildDirectInstances()
```
    Record instances and their explicitly defined parent classes
  - buildDisjointRelationsMap
```
public void buildDisjointRelationsMap()
```
    build a disjoint-relations-map which were explicitly defined in "partition", "exhaustiveDecomposition", "disjointDecomposition" and "disjoint" expressions;
  - checkDisjoint
```
public static boolean checkDisjoint(KB kb,
                                    java.util.HashSet<java.lang.String> typeSet)
```
    check if there are any two types in typeSet are disjoint or not;
  - checkDisjoint
```
public static boolean checkDisjoint(KB kb,
                                    java.lang.String rel1,
                                    java.lang.String rel2)
```
    check if rel1 and rel2 are disjoint return true if rel1 and rel2 are disjoint; otherwise return false.
  - isExplicitDisjoint
```
public boolean isExplicitDisjoint(java.util.HashMap<java.lang.String,java.util.HashSet<java.lang.String>> explicitDisjointRelations,
                                  java.lang.String rel1,
                                  java.lang.String rel2)
```
    return true if rel1 and rel2 are explicitly defined as disjoint relations; otherwise return false.
  - buildTransInstOf
```
public void buildTransInstOf()
```
    Cache whether a given instance has a given parent class. Include paths the have transitive relations between instances such as an Attribute that is a subAttribute of another instance, which in turn then is an instance of the given class. TODO: make sure that direct instances are recorded too
  - mostSpecificParent
```
public java.lang.String mostSpecificParent(java.util.HashSet<java.lang.String> p1)
```
    Returns:
    
    the most specific parent of a set of classes
  - getCommonParent
```
public java.lang.String getCommonParent(java.lang.String t1,
                                        java.lang.String t2)
```
    Returns:
    
    the most specific parent of the two parameters or null if there is no common parent. TODO: Take into account that there are instances, classes, relations, and attributes,
  - getParentClasses
```
public java.util.HashSet<java.lang.String> getParentClasses(java.lang.String cl)
```
    return parent classes for the given cl from subclass expressions.
  - getChildClasses
```
public java.util.HashSet<java.lang.String> getChildClasses(java.lang.String cl)
```
    return child classes for the given cl from subclass expressions.
  - getChildTerms
```
public java.util.HashSet<java.lang.String> getChildTerms(java.lang.String cl,
                                                         java.lang.String rel)
```
    return child term for the given cl from rel expressions.
  - getChildInstances
```
public java.util.HashSet<java.lang.String> getChildInstances(java.lang.String cl)
```
    return child classes for the given cl from subclass expressions.
  - getParentClassesOfInstance
```
public java.util.HashSet<java.lang.String> getParentClassesOfInstance(java.lang.String cl)
```
    return classes for the given instance cl. For example, if we know (instance UnitedStates Nation), then getParentClassesOfInstances(UnitedStates) returns Nation and its super claasses from subclass expressions.
  - getInstancesForType
```
public java.util.HashSet<java.lang.String> getInstancesForType(java.lang.String cl)
```
    Get all instances for the given input class For example, given the class "Nation", getInstancesForType(Nation) returns all instances, like "America", "Austria", "Albania", etc.
  - collectArgFromFormulas
```
public static java.util.HashSet<java.lang.String> collectArgFromFormulas(int arg,
                                                                         java.util.ArrayList<Formula> forms)
```
    Get the HashSet of the given arguments from an ArrayList of Formulas.
  - buildTransitiveRelationsSet
```
public void buildTransitiveRelationsSet()
```
    Do a proper search for relations (including Functions), utilizing the formal definitions, rather than the convention of initial lower case letter. This means getting any instance of Relation tracing back through subclasses as well.
  - buildRelationsSet
```
public void buildRelationsSet()
```
    Do a proper search for relations (including Functions), utilizing the formal definitions, rather than the convention of initial lower case letter. This means getting any instance of Relation tracing back through subclasses as well.
  - buildParents
```
public void buildParents()
```
    For each transitive relation, find its transitive closure. If rel is transitive, and (rel A B) and (rel B C) then the entry for rel is a HashMap where the key A has value ArrayList of {B,C}.
  - buildChildren
```
public void buildChildren()
```
    For each transitive relation, find its transitive closure. If rel is transitive, and (rel A B) and (rel B C) then the entry for rel is a HashMap where the key A has value ArrayList of {B,C}.
  - collectDomains
```
public void collectDomains()
```
    Build the argument type list for every relation. If the argument is a domain subclass, append a "+" to the argument type. If no domain is defined for the given relation and argument position, inherit it from the parent. If there is no argument type, send an error to the Sigma error list. Relation name keys and argument types with 0th arg always "" except for functions which will have the range type as their 0th argument public HashMap> signatures = new HashMap>();
  - writeCacheFile
```
public void writeCacheFile()
```
    Delete and writes the cache .kif file then call addConstituent() so that the file can be processed and loaded by the inference engine.
  - inheritDomains
```
public void inheritDomains()
```
    Find domain and domainSubclass definitions that impact a child relation. If the type of an argument is less specific than the same type of a parent's argument, use that of the parent.
  - buildInstTransRels
```
public void buildInstTransRels()
```
    Compile the set of transitive relations that are between instances
  - buildCaches
```
public void buildCaches()
```
    Main entry point for the class.
  - copyNewPredFromVariableArity
```
public void copyNewPredFromVariableArity(java.lang.String pred,
                                         java.lang.String oldPred,
                                         int arity)
```
    Copy all relevant information from a VariableArityRelation to a new predicate that is a particular fixed arity.
  - showState
```
public void showState()
```
  - main
```
public static void main(java.lang.String[] args)
```

Class KBcache

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

kb

debug

_cacheFileSuffix

relations

transRels

instTransRels

parents

instances

insts

children

signatures

valences

explicitDisjointRelations

Constructor Detail

KBcache

KBcache

KBcache

Method Detail

getArity

childOfP

isInstanceOf

transInstOf

subclassOf

subAttributeOf

buildDirectInstances

buildDisjointRelationsMap

checkDisjoint

checkDisjoint

isExplicitDisjoint

buildTransInstOf

mostSpecificParent

getCommonParent

getParentClasses

getChildClasses

getChildTerms

getChildInstances

getParentClassesOfInstance

getInstancesForType

collectArgFromFormulas

buildTransitiveRelationsSet

buildRelationsSet

buildParents

buildChildren

collectDomains

writeCacheFile

inheritDomains

buildInstTransRels

buildCaches

copyNewPredFromVariableArity

showState

main