All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Friends
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Member Functions
instruction.opencyc.OpenCyc Class Reference
Inheritance diagram for instruction.opencyc.OpenCyc:
Inheritance graph
[legend]

List of all members.

Public Member Functions

void addExecutableByRobot (String action) throws UnknownHostException, CycApiException, IOException
void addMapping (String synset, String concept) throws UnknownHostException, CycApiException, IOException
void addTypicalObjectInKitchen (String object) throws UnknownHostException, CycApiException, IOException
boolean constantExists (String constant) throws UnknownHostException, IOException
boolean genlsInTopicMt (String subConcept, String upperConcept) throws UnknownHostException, CycApiException, IOException
boolean genlsInUniversalVocabularyMt (String subConcept, String upperConcept) throws UnknownHostException, CycApiException, IOException
boolean genlsSomethingExisting (String concept) throws UnknownHostException, CycApiException, IOException
int getArity (String predicate) throws CycApiException, UnknownHostException, IOException
CycAccess getCycAcces ()
ArrayList< String > getCycConceptFromWordNetID (String synsetID) throws Exception
CycObject getKitchenEnvMt ()
CycObject getKitchenEnvPlanningMt ()
ArrayList< String > getRequiredActorSlots (String concept) throws UnknownHostException, CycApiException, IOException
String getTypeOfArg (String pred, int arg) throws UnknownHostException, CycApiException, IOException
CycObject getUniversalVocMt ()
CycObject getWordNetMappingMt ()
boolean isaInTopicMt (String subConcept, String upperConcept) throws UnknownHostException, CycApiException, IOException
boolean isaInUnivVocMt (String concept, String upperConcept) throws UnknownHostException, CycApiException, IOException
boolean isExecutableByRobot (String action) throws UnknownHostException, CycApiException, IOException
boolean isTypicalObjectInKitchen (String concept) throws UnknownHostException, CycApiException, IOException
void makeAssertionInKitchenMt (String assertion) throws CycApiException, UnknownHostException, IOException
void makeAssertionInKitchenPlanningMt (String assertion) throws CycApiException, UnknownHostException, IOException
boolean typeGenlsInUniversalVocabularyMt (String subConcept, String upperConcept) throws UnknownHostException, CycApiException, IOException

Static Public Member Functions

static OpenCyc getInstance () throws UnknownHostException, CycApiException, IOException

Static Public Attributes

static final String COLL_TYPICAL_OBJECT_IN_KITCHEN = "#$TypicalObjectInKitchen"
static final String MT_TOPIC = "#$TopicMt"
static final String MT_TUM_KITCHEN_ENVIRONMENT = "#$TUMKitchenEnvironmentMt"
static final String MT_TUM_KITCHEN_ENVIRONMENT_COMMENT = "Microtheory containing specific Assertions for the TUM Kitchen Environment"
static final String MT_TUM_KITCHEN_ENVIRONMENT_PLANNING = "#$TUMKitchenEnvironmentPlanningMt"
static final String MT_TUM_KITCHEN_ENVIRONMENT_PLANNING_COMMENT = "Microtheory containing Plans for the TUM Kitchen Environment"
static final String MT_UNIVERSAL_VOCABULARY = "#$UniversalVocabularyMt"
static final String MT_WORDNET_MAPPING = "#$WordNetMappingMt"
static final String PRED_AMOUNT_OF_OBJECT = "#$amountOfObject"
static final String PRED_IS_EXECUTABLE_BY_ROBOT = "#$isExecutableByRobot"

Protected Member Functions

void initializeCyc () throws UnknownHostException, CycApiException, IOException, FileNotFoundException
 OpenCyc () throws UnknownHostException, CycApiException, IOException

Protected Attributes

CycCache cache = null
CycObject kitchenEnvMt = null
CycObject kitchenPlanningMt = null
CycObject topicMt = null
CycObject universalVocMt = null
CycObject wordNetMappingMt = null

Static Protected Attributes

static CycAccess cyc = null
static OpenCyc me = null

Private Member Functions

void makeCycAssertions ()

Detailed Description

Definition at line 17 of file OpenCyc.java.

Constructor & Destructor Documentation

instruction.opencyc.OpenCyc.OpenCyc ( ) throws UnknownHostException, CycApiException, IOException [inline, protected]

Definition at line 56 of file OpenCyc.java.

Member Function Documentation

void instruction.opencyc.OpenCyc.addExecutableByRobot ( String  action) throws UnknownHostException, CycApiException, IOException [inline]

Adds the given Cyc Action Concept to the Actions, which are executable by the Robot, i.e. sets the isExecutableByRobot Predicate to true

Parameters:
actionCyc concept of Action, without leading "#$"
Returns:
Exceptions:
IOException
CycApiException
UnknownHostException

Definition at line 510 of file OpenCyc.java.

void instruction.opencyc.OpenCyc.addMapping ( String  synset,
String  concept 
) throws UnknownHostException, CycApiException, IOException [inline]

Reimplemented in instruction.opencyc.OpenCyc20.

Definition at line 123 of file OpenCyc.java.

void instruction.opencyc.OpenCyc.addTypicalObjectInKitchen ( String  object) throws UnknownHostException, CycApiException, IOException [inline]
Parameters:
object
Exceptions:
UnknownHostException
CycApiException
IOException

Definition at line 524 of file OpenCyc.java.

boolean instruction.opencyc.OpenCyc.constantExists ( String  constant) throws UnknownHostException, IOException [inline]

Checks whether the given constant already exists in Cyc

Parameters:
constant
Returns:
Exceptions:
UnknownHostException
IOException

Definition at line 138 of file OpenCyc.java.

boolean instruction.opencyc.OpenCyc.genlsInTopicMt ( String  subConcept,
String  upperConcept 
) throws UnknownHostException, CycApiException, IOException [inline]

Checks whether upperConcept is a generalisation (genls) of subConcept in TopicMt

Parameters:
subConcept
upperConcept
Returns:
Exceptions:
UnknownHostException
CycApiException
IOException

Definition at line 207 of file OpenCyc.java.

boolean instruction.opencyc.OpenCyc.genlsInUniversalVocabularyMt ( String  subConcept,
String  upperConcept 
) throws UnknownHostException, CycApiException, IOException [inline]

Checks whether upperConcept is a generalisation (genls) of subConcept in UniversalVocabularyMt

Parameters:
subConcept
upperConcept
Returns:
Exceptions:
UnknownHostException
CycApiException
IOException

Definition at line 165 of file OpenCyc.java.

boolean instruction.opencyc.OpenCyc.genlsSomethingExisting ( String  concept) throws UnknownHostException, CycApiException, IOException [inline]

Checks whether concept is a specialization of SomethingExisting in UniversalVocabularyMt

Parameters:
concept
Returns:
Exceptions:
UnknownHostException
CycApiException
IOException

Definition at line 489 of file OpenCyc.java.

int instruction.opencyc.OpenCyc.getArity ( String  predicate) throws CycApiException, UnknownHostException, IOException [inline]

Returns the arity of the predicate predicate

Parameters:
predicate
Returns:
Exceptions:
CycApiException
UnknownHostException
IOException

Definition at line 375 of file OpenCyc.java.

CycAccess instruction.opencyc.OpenCyc.getCycAcces ( ) [inline]

Definition at line 343 of file OpenCyc.java.

ArrayList<String> instruction.opencyc.OpenCyc.getCycConceptFromWordNetID ( String  synsetID) throws Exception [inline]

Retrieves a List of all Cyc Constants that are mapped via synsetID by the synonymousExternalConcept predicate in WordNetMappingMt

Parameters:
synsetID
Returns:
A List of Cyc Constant Strings
Exceptions:
Exception

Reimplemented in instruction.opencyc.OpenCyc20.

Definition at line 310 of file OpenCyc.java.

static OpenCyc instruction.opencyc.OpenCyc.getInstance ( ) throws UnknownHostException, CycApiException, IOException [inline, static]

Returns the singleton instance of the ObjectCyc Wrapper class

Returns:
Exceptions:
UnknownHostException
CycApiException
IOException

Reimplemented in instruction.opencyc.OpenCyc20.

Definition at line 357 of file OpenCyc.java.

CycObject instruction.opencyc.OpenCyc.getKitchenEnvMt ( ) [inline]

Returns a Handle to TUMKitchenEnvironmentMt

Returns:

Definition at line 67 of file OpenCyc.java.

CycObject instruction.opencyc.OpenCyc.getKitchenEnvPlanningMt ( ) [inline]

Returns a Handle to TUMKitchenEnvironmentPlanningMt

Returns:

Definition at line 77 of file OpenCyc.java.

ArrayList<String> instruction.opencyc.OpenCyc.getRequiredActorSlots ( String  concept) throws UnknownHostException, CycApiException, IOException [inline]

Returns a list of all reqiredActorSlots of the concept concept in UniversalVocabularyMt

Parameters:
concept
Returns:
Exceptions:
UnknownHostException
CycApiException
IOException

Definition at line 392 of file OpenCyc.java.

String instruction.opencyc.OpenCyc.getTypeOfArg ( String  pred,
int  arg 
) throws UnknownHostException, CycApiException, IOException [inline]

Returns the type of the argth argument of the predicate pred

Parameters:
pred
arg
Returns:
Exceptions:
UnknownHostException
CycApiException
IOException

Definition at line 264 of file OpenCyc.java.

CycObject instruction.opencyc.OpenCyc.getUniversalVocMt ( ) [inline]

Returns a Handle to UniversalVocabularyMt

Returns:

Definition at line 87 of file OpenCyc.java.

CycObject instruction.opencyc.OpenCyc.getWordNetMappingMt ( ) [inline]

Returns a Handle to WordNetMappingMt

Returns:

Definition at line 98 of file OpenCyc.java.

void instruction.opencyc.OpenCyc.initializeCyc ( ) throws UnknownHostException, CycApiException, IOException, FileNotFoundException [inline, protected]

Initializes this OpenCyc-Class for usage

Exceptions:
UnknownHostException
CycApiException
IOException

Definition at line 110 of file OpenCyc.java.

boolean instruction.opencyc.OpenCyc.isaInTopicMt ( String  subConcept,
String  upperConcept 
) throws UnknownHostException, CycApiException, IOException [inline]

Checks whether subConcept is an instance (isa) of upperConcept in TopicMt

Parameters:
subConcept
upperConcept
Returns:
Exceptions:
UnknownHostException
CycApiException
IOException

Definition at line 292 of file OpenCyc.java.

boolean instruction.opencyc.OpenCyc.isaInUnivVocMt ( String  concept,
String  upperConcept 
) throws UnknownHostException, CycApiException, IOException [inline]

Checks whether concept is an instance of upperConcept in UniversalVocabularyMt

Parameters:
concept
genls
Returns:
Exceptions:
UnknownHostException
CycApiException
IOException

Definition at line 446 of file OpenCyc.java.

boolean instruction.opencyc.OpenCyc.isExecutableByRobot ( String  action) throws UnknownHostException, CycApiException, IOException [inline]

Asks Cyc whether the Action action is executable, i.e. whether the isExecutableByRobot Predicate is set in TUMKitchenEnvironmentMt

Parameters:
actionCyc concept of Action, without leading "#$"
Returns:
Exceptions:
IOException
CycApiException
UnknownHostException

Definition at line 424 of file OpenCyc.java.

boolean instruction.opencyc.OpenCyc.isTypicalObjectInKitchen ( String  concept) throws UnknownHostException, CycApiException, IOException [inline]

Checks whether concept is a specialization of TypicalObjectInKitchen in TUMKitchenEnvironmentMt

Parameters:
concept
Returns:
Exceptions:
UnknownHostException
CycApiException
IOException

Definition at line 468 of file OpenCyc.java.

void instruction.opencyc.OpenCyc.makeAssertionInKitchenMt ( String  assertion) throws CycApiException, UnknownHostException, IOException [inline]

Makes the assertion assertion in the TUMKitchenEnvirionmentMt

Parameters:
assertion
Exceptions:
CycApiException
UnknownHostException
IOException

Definition at line 225 of file OpenCyc.java.

void instruction.opencyc.OpenCyc.makeAssertionInKitchenPlanningMt ( String  assertion) throws CycApiException, UnknownHostException, IOException [inline]

Makes the assertion assertion in the TUMKitchenEnvironmentPlanningMt

Parameters:
assertion
Exceptions:
CycApiException
UnknownHostException
IOException

Definition at line 243 of file OpenCyc.java.

void instruction.opencyc.OpenCyc.makeCycAssertions ( ) [inline, private]

Initializes Cyc with the new TUMKitchenEnvironmentMt and some assertions on predefined Actions (not for external usage, only for debugging purpose)

Deprecated:

Create TUMKitchenEnvironmentMt

Definition at line 540 of file OpenCyc.java.

boolean instruction.opencyc.OpenCyc.typeGenlsInUniversalVocabularyMt ( String  subConcept,
String  upperConcept 
) throws UnknownHostException, CycApiException, IOException [inline]

Checks whether upperConcept is a generalisation of the type (typeGenls) of subConcept in UniversalVocabularyMt

Parameters:
subConcept
upperConcept
Returns:
Exceptions:
UnknownHostException
CycApiException
IOException

Definition at line 186 of file OpenCyc.java.

Member Data Documentation

CycCache instruction.opencyc.OpenCyc.cache = null [protected]

Cyc Cache for better performance *

Definition at line 54 of file OpenCyc.java.

final String instruction.opencyc.OpenCyc.COLL_TYPICAL_OBJECT_IN_KITCHEN = "#$TypicalObjectInKitchen" [static]

Definition at line 27 of file OpenCyc.java.

CycAccess instruction.opencyc.OpenCyc.cyc = null [static, protected]

Interface to Cyc API

Definition at line 33 of file OpenCyc.java.

CycObject instruction.opencyc.OpenCyc.kitchenEnvMt = null [protected]

Handle to TUMKitchenEnvironmentMt

Definition at line 42 of file OpenCyc.java.

CycObject instruction.opencyc.OpenCyc.kitchenPlanningMt = null [protected]

Handle to TUMKitchenEnvirionmentPlanningMt

Definition at line 45 of file OpenCyc.java.

OpenCyc instruction.opencyc.OpenCyc.me = null [static, protected]

Singleton Instance

Definition at line 36 of file OpenCyc.java.

final String instruction.opencyc.OpenCyc.MT_TOPIC = "#$TopicMt" [static]

Definition at line 22 of file OpenCyc.java.

final String instruction.opencyc.OpenCyc.MT_TUM_KITCHEN_ENVIRONMENT = "#$TUMKitchenEnvironmentMt" [static]

Definition at line 20 of file OpenCyc.java.

final String instruction.opencyc.OpenCyc.MT_TUM_KITCHEN_ENVIRONMENT_COMMENT = "Microtheory containing specific Assertions for the TUM Kitchen Environment" [static]

Definition at line 29 of file OpenCyc.java.

final String instruction.opencyc.OpenCyc.MT_TUM_KITCHEN_ENVIRONMENT_PLANNING = "#$TUMKitchenEnvironmentPlanningMt" [static]

Definition at line 21 of file OpenCyc.java.

final String instruction.opencyc.OpenCyc.MT_TUM_KITCHEN_ENVIRONMENT_PLANNING_COMMENT = "Microtheory containing Plans for the TUM Kitchen Environment" [static]

Definition at line 30 of file OpenCyc.java.

final String instruction.opencyc.OpenCyc.MT_UNIVERSAL_VOCABULARY = "#$UniversalVocabularyMt" [static]

Definition at line 19 of file OpenCyc.java.

final String instruction.opencyc.OpenCyc.MT_WORDNET_MAPPING = "#$WordNetMappingMt" [static]

Definition at line 23 of file OpenCyc.java.

final String instruction.opencyc.OpenCyc.PRED_AMOUNT_OF_OBJECT = "#$amountOfObject" [static]

Definition at line 26 of file OpenCyc.java.

final String instruction.opencyc.OpenCyc.PRED_IS_EXECUTABLE_BY_ROBOT = "#$isExecutableByRobot" [static]

Definition at line 25 of file OpenCyc.java.

CycObject instruction.opencyc.OpenCyc.topicMt = null [protected]

Handle to TopicMt

Definition at line 48 of file OpenCyc.java.

CycObject instruction.opencyc.OpenCyc.universalVocMt = null [protected]

Handle to UniversalVocabularyMt

Definition at line 39 of file OpenCyc.java.

CycObject instruction.opencyc.OpenCyc.wordNetMappingMt = null [protected]

Handle to WordNetMappingMt

Definition at line 51 of file OpenCyc.java.

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Friends

comp_ehow
Author(s): Moritz Tenorth, Daniel Nyga
autogenerated on Tue Apr 16 2013 00:18:24