edu.isi.powerloom.gui.serverinterface
Interface ServerInterface

All Known Implementing Classes:
LocalServerImpl, RemoteServerImpl

public interface ServerInterface

This specifies the contract between the client and server. Implementations of this interface are produced by InterfaceFactory

Since:
Sun Feb 24 16:06:23 2002
Author:
Eric Melz
See Also:
InterfaceFactory

Method Summary
 void clearKB(PLModule mod)
          Insert the method's description here.
 PLString destroyObject(PLString modName, PLString objectName)
           
 PLString evaluateLogicCommand(PLString modName, PLString command)
           
 PLConceptContainer getConcept(PLString modName, PLString concept)
           
 PLConceptContainer getConceptCompletions(PLString modName, PLString prefix)
           
 PLConceptContainer getConceptsForModule(PLString modName)
           
 PLDirectoryContents getDefaultDirectoryListing(PLString extensionFilter)
           
 PLInstanceContainer getDirectInstancesForConcept(PLString modName, PLString conceptName)
           
 PLDirectoryContents getDirectoryListing(PLString currentDir, PLString extensionFilter)
           
 PLString getDocumentationForConcept(PLString modName, PLString conceptName)
           
 PLString getDocumentationForInstance(PLString modName, PLString conceptName)
           
 PLString getDocumentationForRelation(PLString modName, PLString conceptName)
           
 PLString getExplanationForQuery(PLQuery query, PLString resultNum)
           
 PLQueryResult getExtensionForRelation(PLString modName, PLString relation)
           
 PLSurrogateCollection getIncludesForModule(PLString modName)
          Insert the method's description here.
 PLRelationContainer getInheritedRelationsForConcept(PLString modName, PLString conceptName)
           
 PLInstanceContainer getInstance(PLString modName, PLString instance)
           
 PLInstanceContainer getInstanceCompletions(PLString modName, PLString prefix)
           
 PLInstanceContainer getInstancesForConcept(PLString modName, PLString conceptName)
           
 PLInstanceContainer getInstancesForModule(PLString modName)
           
 PLModuleFileList getLoadableKBs()
          Insert the method's description here.
 PLModuleContainer getModules()
           
 PLPropositionContainer getPropositionsForConcept(PLString modName, PLString conceptName)
           
 PLPropositionContainer getPropositionsForInstance(PLString modName, PLString instanceName)
           
 PLPropositionContainer getPropositionsForInstanceAndRelation(PLString modName, PLString instanceName, PLString relationName)
           
 PLPropositionContainer getPropositionsForRelation(PLString modName, PLString relationName)
           
 PLRelationContainer getRelation(PLString modName, PLString relation)
           
 PLRelationContainer getRelationCompletions(PLString modName, PLString prefix)
           
 PLRelationContainer getRelationsForConcept(PLString modName, PLString conceptName)
           
 PLRelationContainer getRelationsForModule(PLString modName)
           
 PLPropositionContainer getRulesForConcept(PLString modName, PLString conceptName)
           
 PLPropositionContainer getRulesForRelation(PLString modName, PLString relationName)
           
 PLServerInfo getServerInfo()
           
 PLSurrogateCollection getShadowedSurrogatesForModule(PLString modName)
          Insert the method's description here.
 PLString getSourceForConcept(PLString modName, PLString conceptName)
           
 PLSurrogateCollection getSuperConceptsForConcept(PLString modName, PLString conceptName)
           
 PLSurrogateCollection getSuperRelationsForRelation(PLString modName, PLString conceptName)
           
 PLSurrogateCollection getTypesForInstance(PLString modName, PLString instanceName)
           
 PLSurrogateCollection getUsesForModule(PLString modName)
          Insert the method's description here.
 PLVariableList getVariablesForRelation(PLString modName, PLString conceptName)
           
 PLString loadKB(PLString kbName)
          Insert the method's description here.
 PLString loadKB2(PLString fileName)
           
 PLQueryResult query(PLQuery query, PLString continueFlag)
           
 PLString saveKB(PLString modName, PLString kbName, PLString description)
          Insert the method's description here.
 PLString saveKB2(PLString modName, PLString fileName)
           
 PLSearchResult search(PLSearchParameter searchParameter)
           
 

Method Detail

getModules

public PLModuleContainer getModules()
                             throws AppException
AppException

getConceptsForModule

public PLConceptContainer getConceptsForModule(PLString modName)
                                        throws AppException
AppException

getInstancesForModule

public PLInstanceContainer getInstancesForModule(PLString modName)
                                          throws AppException
AppException

getRelationsForModule

public PLRelationContainer getRelationsForModule(PLString modName)
                                          throws AppException
AppException

getInstancesForConcept

public PLInstanceContainer getInstancesForConcept(PLString modName,
                                                  PLString conceptName)
                                           throws AppException
AppException

getDirectInstancesForConcept

public PLInstanceContainer getDirectInstancesForConcept(PLString modName,
                                                        PLString conceptName)
                                                 throws AppException
AppException

getDocumentationForConcept

public PLString getDocumentationForConcept(PLString modName,
                                           PLString conceptName)
                                    throws AppException
AppException

getSourceForConcept

public PLString getSourceForConcept(PLString modName,
                                    PLString conceptName)
                             throws AppException
AppException

getSuperConceptsForConcept

public PLSurrogateCollection getSuperConceptsForConcept(PLString modName,
                                                        PLString conceptName)
                                                 throws AppException
AppException

getPropositionsForInstance

public PLPropositionContainer getPropositionsForInstance(PLString modName,
                                                         PLString instanceName)
                                                  throws AppException
AppException

getRelationsForConcept

public PLRelationContainer getRelationsForConcept(PLString modName,
                                                  PLString conceptName)
                                           throws AppException
AppException

getInheritedRelationsForConcept

public PLRelationContainer getInheritedRelationsForConcept(PLString modName,
                                                           PLString conceptName)
                                                    throws AppException
AppException

getPropositionsForConcept

public PLPropositionContainer getPropositionsForConcept(PLString modName,
                                                        PLString conceptName)
                                                 throws AppException
AppException

getPropositionsForRelation

public PLPropositionContainer getPropositionsForRelation(PLString modName,
                                                         PLString relationName)
                                                  throws AppException
AppException

getRulesForConcept

public PLPropositionContainer getRulesForConcept(PLString modName,
                                                 PLString conceptName)
                                          throws AppException
AppException

getRulesForRelation

public PLPropositionContainer getRulesForRelation(PLString modName,
                                                  PLString relationName)
                                           throws AppException
AppException

getPropositionsForInstanceAndRelation

public PLPropositionContainer getPropositionsForInstanceAndRelation(PLString modName,
                                                                    PLString instanceName,
                                                                    PLString relationName)
                                                             throws AppException
AppException

evaluateLogicCommand

public PLString evaluateLogicCommand(PLString modName,
                                     PLString command)
                              throws AppException
AppException

getDocumentationForRelation

public PLString getDocumentationForRelation(PLString modName,
                                            PLString conceptName)
                                     throws AppException
AppException

getSuperRelationsForRelation

public PLSurrogateCollection getSuperRelationsForRelation(PLString modName,
                                                          PLString conceptName)
                                                   throws AppException
AppException

getVariablesForRelation

public PLVariableList getVariablesForRelation(PLString modName,
                                              PLString conceptName)
                                       throws AppException
AppException

clearKB

public void clearKB(PLModule mod)
             throws AppException
Insert the method's description here. Creation date: (4/24/2002 3:35:10 PM)

Parameters:
mod - edu.isi.powerloom.gui.xmlobject.PLModule
Throws:
AppException - The exception description.

getDocumentationForInstance

public PLString getDocumentationForInstance(PLString modName,
                                            PLString conceptName)
                                     throws AppException
AppException

getIncludesForModule

public PLSurrogateCollection getIncludesForModule(PLString modName)
                                           throws AppException
Insert the method's description here. Creation date: (4/16/2002 5:45:30 PM)

Parameters:
modName - edu.isi.powerloom.gui.xmlobject.PLString
Returns:
edu.isi.powerloom.gui.xmlobject.PLSurrogateCollection
Throws:
AppException - The exception description.

getLoadableKBs

public PLModuleFileList getLoadableKBs()
                                throws AppException
Insert the method's description here. Creation date: (4/23/2002 8:22:13 PM)

Returns:
edu.isi.powerloom.gui.xmlobject.PLModuleFileList
Throws:
AppException - The exception description.

getShadowedSurrogatesForModule

public PLSurrogateCollection getShadowedSurrogatesForModule(PLString modName)
                                                     throws AppException
Insert the method's description here. Creation date: (4/16/2002 5:46:13 PM)

Parameters:
modName - edu.isi.powerloom.gui.xmlobject.PLString
Returns:
edu.isi.powerloom.gui.xmlobject.PLSurrogateCollection
Throws:
AppException - The exception description.

getTypesForInstance

public PLSurrogateCollection getTypesForInstance(PLString modName,
                                                 PLString instanceName)
                                          throws AppException
AppException

getUsesForModule

public PLSurrogateCollection getUsesForModule(PLString modName)
                                       throws AppException
Insert the method's description here. Creation date: (4/16/2002 5:45:56 PM)

Parameters:
modName - edu.isi.powerloom.gui.xmlobject.PLString
Returns:
edu.isi.powerloom.gui.xmlobject.PLSurrogateCollection
Throws:
AppException - The exception description.

loadKB

public PLString loadKB(PLString kbName)
                throws AppException
Insert the method's description here. Creation date: (4/24/2002 1:21:56 PM)

Parameters:
kbName - edu.isi.powerloom.gui.xmlobject.PLString
Returns:
edu.isi.powerloom.gui.xmlobject.PLString
Throws:
AppException - The exception description.

loadKB2

public PLString loadKB2(PLString fileName)
                 throws AppException
AppException

saveKB

public PLString saveKB(PLString modName,
                       PLString kbName,
                       PLString description)
                throws AppException
Insert the method's description here. Creation date: (4/24/2002 1:22:28 PM)

Parameters:
modName - edu.isi.powerloom.gui.xmlobject.PLString
kbName - edu.isi.powerloom.gui.xmlobject.PLString
description - edu.isi.powerloom.gui.xmlobject.PLString
Returns:
edu.isi.powerloom.gui.xmlobject.PLString
Throws:
AppException - The exception description.

saveKB2

public PLString saveKB2(PLString modName,
                        PLString fileName)
                 throws AppException
AppException

query

public PLQueryResult query(PLQuery query,
                           PLString continueFlag)
                    throws AppException
AppException

search

public PLSearchResult search(PLSearchParameter searchParameter)
                      throws AppException
AppException

getDefaultDirectoryListing

public PLDirectoryContents getDefaultDirectoryListing(PLString extensionFilter)
                                               throws AppException
AppException

getDirectoryListing

public PLDirectoryContents getDirectoryListing(PLString currentDir,
                                               PLString extensionFilter)
                                        throws AppException
AppException

getExtensionForRelation

public PLQueryResult getExtensionForRelation(PLString modName,
                                             PLString relation)
                                      throws AppException
AppException

getRelation

public PLRelationContainer getRelation(PLString modName,
                                       PLString relation)
                                throws AppException
AppException

getConcept

public PLConceptContainer getConcept(PLString modName,
                                     PLString concept)
                              throws AppException
AppException

getInstance

public PLInstanceContainer getInstance(PLString modName,
                                       PLString instance)
                                throws AppException
AppException

getRelationCompletions

public PLRelationContainer getRelationCompletions(PLString modName,
                                                  PLString prefix)
                                           throws AppException
AppException

getConceptCompletions

public PLConceptContainer getConceptCompletions(PLString modName,
                                                PLString prefix)
                                         throws AppException
AppException

getInstanceCompletions

public PLInstanceContainer getInstanceCompletions(PLString modName,
                                                  PLString prefix)
                                           throws AppException
AppException

destroyObject

public PLString destroyObject(PLString modName,
                              PLString objectName)
                       throws AppException
AppException

getExplanationForQuery

public PLString getExplanationForQuery(PLQuery query,
                                       PLString resultNum)
                                throws AppException
AppException

getServerInfo

public PLServerInfo getServerInfo()
                           throws AppException
AppException


Copyright © 2002 University of Southern California Information Sciences Institute. All Rights Reserved.