Docs For Class TopicMapSystemInterface

Description

Interface TopicMapSystemInterface: A generic interface to a PHPTMAPI system.

author: Johannes Schmidt - t8d <kontakt@t8d.de>

Located in /org.phptmapi.core/TopicMapSystem.interface.php (line 10)

Method Summary

void close ()

object TopicMapInterface createTopicMap (string $baselocatorref)

array getBaseLocators ()

boolean getFeature (string $featureName)

string getProperty (string $propertyName)

object TopicMapInterface getTopicMap (string $baselocatorref)

Methods

close (line 16)

close: Applications SHOULD call this method when the TopicMapSystemInterface instance is no longer required.

access: public

void close ()

createTopicMap (line 30)

createTopicMap: Creates a new topic map with a specified base locator.

access: public

throws: TopicMapExistsException if the topic map system already manages a topic map with the specified base locator.

     public function createTopicMap($baselocatorref){
        throw new TopicMapExistsException('Exception in '.__method__);
     }

object TopicMapInterface createTopicMap (string $baselocatorref)

string $baselocatorref

getBaseLocators (line 45)

getBaseLocators: Returns the base locators of the topic maps managed by the system.

access: public

array getBaseLocators ()

getFeature (line 67)

getFeature: Returns the value of the feature specified by $featureName for this TopicMapSystemInterface instance.

getFeature: Returns the value of the feature specified by $featureName for this TopicMapSystemInterface instance. The features supported by the TopicMapSystemInterface and the value for each feature is set when the TopicMapSystemInterface is created by a call to TopicMapSystemFactory->newTopicMapSystem() and cannot be modified subsequently.

access: public

throws: FeatureNotRecognizedException if the underlying implementation does not recognize the named feature.

     public function getFeature($featureName){
        throw new FeatureNotRecognizedException('Exception in '.__method__);
     }

boolean getFeature (string $featureName)

string $featureName

getProperty (line 53)

getProperty: Gets a property in the underlying implementation of TopicMapSystemInterface.

getProperty: Gets a property in the underlying implementation of TopicMapSystemInterface. A list of the core properties defined by TMAPI can be found at http://tmapi.org/properties/. An implementation is free to support properties other than the core ones. The properties supported by the TopicMapSystemInterface and the value for each property is set when the TopicMapSystemInterface is created by a call to TopicMapSystemFactory->newTopicMapSystem() and cannot be modified subsequently.

return: or null
access: public

string getProperty (string $propertyName)

string $propertyName

getTopicMap (line 38)

getTopicMap: Retrieves the topic map managed by the system with the specified base locator.

return: or null
access: public

object TopicMapInterface getTopicMap (string $baselocatorref)

string $baselocatorref