Protege 3.0

edu.stanford.smi.protege.model.framestore
Interface FrameStore

All Known Implementing Classes:
AbstractFrameStore, RemoteClientFrameStore, SimpleFrameStore

public interface FrameStore


Field Summary
static int UNLIMITED_MATCHES
           
 
Method Summary
 void addDirectSuperclass(Cls cls, Cls superclass)
           
 void addDirectSuperslot(Slot slot, Slot superslot)
           
 void addDirectTemplateSlot(Cls cls, Slot slot)
           
 void addDirectType(Instance instance, Cls type)
           
 boolean beginTransaction(String name)
           
 void close()
           
 boolean commitTransaction()
           
 Cls createCls(FrameID id, String name, Collection directTypes, Collection directSuperclasses, boolean loadDefaultValues)
           
 Facet createFacet(FrameID id, String name, Collection directTypes, boolean loadDefaultValues)
           
 SimpleInstance createSimpleInstance(FrameID id, String name, Collection directTypes, boolean loadDefaultValues)
           
 Slot createSlot(FrameID id, String name, Collection directTypes, Collection directSuperslots, boolean loadDefaultValues)
           
 void deleteCls(Cls cls)
          Delete a single leaf class.
 void deleteFacet(Facet facet)
           
 void deleteSimpleInstance(SimpleInstance simpleInstance)
           
 void deleteSlot(Slot slot)
           
 Set executeQuery(Query query)
           
 int getClsCount()
           
 Set getClses()
           
 Set getClsesWithAnyDirectTemplateSlotValue(Slot slot)
           
 Set getClsesWithDirectTemplateFacetValue(Slot slot, Facet facet, Object value)
           
 Set getClsesWithDirectTemplateSlotValue(Slot slot, Object value)
           
 Set getClsesWithMatchingDirectTemplateFacetValue(Slot slot, Facet facet, String value, int maxMatches)
           
 Set getClsesWithMatchingDirectTemplateSlotValue(Slot slot, String value, int maxMatches)
           
 FrameStore getDelegate()
           
 List getDirectDomain(Slot slot)
           
 List getDirectInstances(Cls cls)
           
 Set getDirectlyOverriddenTemplateFacets(Cls cls, Slot slot)
           
 Set getDirectlyOverriddenTemplateSlots(Cls cls)
           
 List getDirectOwnSlotValues(Frame frame, Slot slot)
           
 Set getDirectOwnSlotValuesClosure(Frame frame, Slot slot)
           
 int getDirectOwnSlotValuesCount(Frame frame, Slot slot)
           
 List getDirectSubclasses(Cls cls)
           
 List getDirectSubslots(Slot slot)
           
 List getDirectSuperclasses(Cls cls)
           
 List getDirectSuperslots(Slot slot)
           
 List getDirectTemplateFacetValues(Cls cls, Slot slot, Facet facet)
           
 List getDirectTemplateSlots(Cls cls)
           
 List getDirectTemplateSlotValues(Cls cls, Slot slot)
           
 List getDirectTypes(Instance instance)
           
 Set getDomain(Slot slot)
           
 List getEvents()
           
 int getFacetCount()
           
 Set getFacets()
           
 Frame getFrame(FrameID id)
           
 Frame getFrame(String name)
           
 int getFrameCount()
           
 String getFrameName(Frame frame)
           
 Set getFrames()
           
 Set getFramesWithAnyDirectOwnSlotValue(Slot slot)
           
 Set getFramesWithDirectOwnSlotValue(Slot slot, Object value)
           
 Set getFramesWithMatchingDirectOwnSlotValue(Slot slot, String value, int maxMatches)
           
 Set getInstances(Cls cls)
           
 Set getMatchingReferences(String string, int maxMatches)
           
 Set getOverriddenTemplateFacets(Cls cls, Slot slot)
           
 Set getOverriddenTemplateSlots(Cls cls)
           
 Set getOwnFacets(Frame frame, Slot slot)
           
 Collection getOwnFacetValues(Frame frame, Slot slot, Facet facet)
           
 Set getOwnSlots(Frame frame)
           
 Collection getOwnSlotValues(Frame frame, Slot slot)
           
 Set getReferences(Object object)
           
 int getSimpleInstanceCount()
           
 int getSlotCount()
           
 Set getSlots()
           
 Set getSubclasses(Cls cls)
           
 Set getSubslots(Slot slot)
           
 Set getSuperclasses(Cls cls)
           
 Set getSuperslots(Slot slot)
           
 Set getTemplateFacets(Cls cls, Slot slot)
           
 Collection getTemplateFacetValues(Cls cls, Slot slot, Facet facet)
           
 Set getTemplateSlots(Cls cls)
           
 Collection getTemplateSlotValues(Cls cls, Slot slot)
           
 Set getTypes(Instance instance)
           
 void moveDirectSubclass(Cls cls, Cls subclass, int index)
           
 void moveDirectSubslot(Slot slot, Slot subslot, int index)
           
 void moveDirectTemplateSlot(Cls cls, Slot slot, int index)
           
 void reinitialize()
           
 void removeDirectSuperclass(Cls cls, Cls superclass)
           
 void removeDirectSuperslot(Slot slot, Slot superslot)
           
 void removeDirectTemplateFacetOverrides(Cls cls, Slot slot)
           
 void removeDirectTemplateSlot(Cls cls, Slot slot)
           
 void removeDirectType(Instance instance, Cls type)
           
 boolean rollbackTransaction()
           
 void setDelegate(FrameStore delegate)
           
 void setDirectOwnSlotValues(Frame frame, Slot slot, Collection values)
           
 void setDirectTemplateFacetValues(Cls cls, Slot slot, Facet facet, Collection values)
           
 void setDirectTemplateSlotValues(Cls cls, Slot slot, Collection values)
           
 void setFrameName(Frame frame, String name)
           
 

Field Detail

UNLIMITED_MATCHES

public static final int UNLIMITED_MATCHES
See Also:
Constant Field Values
Method Detail

setDelegate

public void setDelegate(FrameStore delegate)

getDelegate

public FrameStore getDelegate()

reinitialize

public void reinitialize()

getClsCount

public int getClsCount()

getSlotCount

public int getSlotCount()

getFacetCount

public int getFacetCount()

getSimpleInstanceCount

public int getSimpleInstanceCount()

getFrameCount

public int getFrameCount()

getClses

public Set getClses()

getSlots

public Set getSlots()

getFacets

public Set getFacets()

getFrames

public Set getFrames()

getFrame

public Frame getFrame(FrameID id)

getFrame

public Frame getFrame(String name)

getFrameName

public String getFrameName(Frame frame)

setFrameName

public void setFrameName(Frame frame,
                         String name)

createCls

public Cls createCls(FrameID id,
                     String name,
                     Collection directTypes,
                     Collection directSuperclasses,
                     boolean loadDefaultValues)

createSlot

public Slot createSlot(FrameID id,
                       String name,
                       Collection directTypes,
                       Collection directSuperslots,
                       boolean loadDefaultValues)

createFacet

public Facet createFacet(FrameID id,
                         String name,
                         Collection directTypes,
                         boolean loadDefaultValues)

createSimpleInstance

public SimpleInstance createSimpleInstance(FrameID id,
                                           String name,
                                           Collection directTypes,
                                           boolean loadDefaultValues)

deleteCls

public void deleteCls(Cls cls)
Delete a single leaf class. The operation fails if the class has subclasses or instances.

Parameters:
cls - Class to be deleted
Throws:
IllegalArgumentException - if the class has either subclasses or instances.

deleteSlot

public void deleteSlot(Slot slot)

deleteFacet

public void deleteFacet(Facet facet)

deleteSimpleInstance

public void deleteSimpleInstance(SimpleInstance simpleInstance)

getOwnSlots

public Set getOwnSlots(Frame frame)

getOwnSlotValues

public Collection getOwnSlotValues(Frame frame,
                                   Slot slot)

getDirectOwnSlotValues

public List getDirectOwnSlotValues(Frame frame,
                                   Slot slot)

getDirectOwnSlotValuesCount

public int getDirectOwnSlotValuesCount(Frame frame,
                                       Slot slot)

setDirectOwnSlotValues

public void setDirectOwnSlotValues(Frame frame,
                                   Slot slot,
                                   Collection values)

getOwnFacets

public Set getOwnFacets(Frame frame,
                        Slot slot)

getOwnFacetValues

public Collection getOwnFacetValues(Frame frame,
                                    Slot slot,
                                    Facet facet)

getTemplateSlots

public Set getTemplateSlots(Cls cls)

getDirectTemplateSlots

public List getDirectTemplateSlots(Cls cls)

getDirectDomain

public List getDirectDomain(Slot slot)

getDomain

public Set getDomain(Slot slot)

getOverriddenTemplateSlots

public Set getOverriddenTemplateSlots(Cls cls)

getDirectlyOverriddenTemplateSlots

public Set getDirectlyOverriddenTemplateSlots(Cls cls)

addDirectTemplateSlot

public void addDirectTemplateSlot(Cls cls,
                                  Slot slot)

removeDirectTemplateSlot

public void removeDirectTemplateSlot(Cls cls,
                                     Slot slot)

moveDirectTemplateSlot

public void moveDirectTemplateSlot(Cls cls,
                                   Slot slot,
                                   int index)

getTemplateSlotValues

public Collection getTemplateSlotValues(Cls cls,
                                        Slot slot)

getDirectTemplateSlotValues

public List getDirectTemplateSlotValues(Cls cls,
                                        Slot slot)

setDirectTemplateSlotValues

public void setDirectTemplateSlotValues(Cls cls,
                                        Slot slot,
                                        Collection values)

getTemplateFacets

public Set getTemplateFacets(Cls cls,
                             Slot slot)

getOverriddenTemplateFacets

public Set getOverriddenTemplateFacets(Cls cls,
                                       Slot slot)

getDirectlyOverriddenTemplateFacets

public Set getDirectlyOverriddenTemplateFacets(Cls cls,
                                               Slot slot)

removeDirectTemplateFacetOverrides

public void removeDirectTemplateFacetOverrides(Cls cls,
                                               Slot slot)

getTemplateFacetValues

public Collection getTemplateFacetValues(Cls cls,
                                         Slot slot,
                                         Facet facet)

getDirectTemplateFacetValues

public List getDirectTemplateFacetValues(Cls cls,
                                         Slot slot,
                                         Facet facet)

setDirectTemplateFacetValues

public void setDirectTemplateFacetValues(Cls cls,
                                         Slot slot,
                                         Facet facet,
                                         Collection values)

getDirectSuperclasses

public List getDirectSuperclasses(Cls cls)

getSuperclasses

public Set getSuperclasses(Cls cls)

getDirectSubclasses

public List getDirectSubclasses(Cls cls)

getSubclasses

public Set getSubclasses(Cls cls)

addDirectSuperclass

public void addDirectSuperclass(Cls cls,
                                Cls superclass)

removeDirectSuperclass

public void removeDirectSuperclass(Cls cls,
                                   Cls superclass)

moveDirectSubclass

public void moveDirectSubclass(Cls cls,
                               Cls subclass,
                               int index)

getDirectSuperslots

public List getDirectSuperslots(Slot slot)

getSuperslots

public Set getSuperslots(Slot slot)

getDirectSubslots

public List getDirectSubslots(Slot slot)

getSubslots

public Set getSubslots(Slot slot)

addDirectSuperslot

public void addDirectSuperslot(Slot slot,
                               Slot superslot)

removeDirectSuperslot

public void removeDirectSuperslot(Slot slot,
                                  Slot superslot)

moveDirectSubslot

public void moveDirectSubslot(Slot slot,
                              Slot subslot,
                              int index)

getDirectTypes

public List getDirectTypes(Instance instance)

getTypes

public Set getTypes(Instance instance)

getDirectInstances

public List getDirectInstances(Cls cls)

getInstances

public Set getInstances(Cls cls)

addDirectType

public void addDirectType(Instance instance,
                          Cls type)

removeDirectType

public void removeDirectType(Instance instance,
                             Cls type)

getEvents

public List getEvents()

executeQuery

public Set executeQuery(Query query)

getReferences

public Set getReferences(Object object)

getMatchingReferences

public Set getMatchingReferences(String string,
                                 int maxMatches)

getFramesWithDirectOwnSlotValue

public Set getFramesWithDirectOwnSlotValue(Slot slot,
                                           Object value)

getFramesWithAnyDirectOwnSlotValue

public Set getFramesWithAnyDirectOwnSlotValue(Slot slot)

getFramesWithMatchingDirectOwnSlotValue

public Set getFramesWithMatchingDirectOwnSlotValue(Slot slot,
                                                   String value,
                                                   int maxMatches)

getClsesWithDirectTemplateSlotValue

public Set getClsesWithDirectTemplateSlotValue(Slot slot,
                                               Object value)

getClsesWithAnyDirectTemplateSlotValue

public Set getClsesWithAnyDirectTemplateSlotValue(Slot slot)

getClsesWithMatchingDirectTemplateSlotValue

public Set getClsesWithMatchingDirectTemplateSlotValue(Slot slot,
                                                       String value,
                                                       int maxMatches)

getClsesWithDirectTemplateFacetValue

public Set getClsesWithDirectTemplateFacetValue(Slot slot,
                                                Facet facet,
                                                Object value)

getClsesWithMatchingDirectTemplateFacetValue

public Set getClsesWithMatchingDirectTemplateFacetValue(Slot slot,
                                                        Facet facet,
                                                        String value,
                                                        int maxMatches)

getDirectOwnSlotValuesClosure

public Set getDirectOwnSlotValuesClosure(Frame frame,
                                         Slot slot)

beginTransaction

public boolean beginTransaction(String name)

commitTransaction

public boolean commitTransaction()

rollbackTransaction

public boolean rollbackTransaction()

close

public void close()

Protege 3.0

Submit a bug report or feature request
Protégé is a trademark of Stanford University.
Copyright (c) 1998-2005 Stanford University.