Interface TopicMapSystem

Description

A generic interface to a PHPTMAPI system.

A generic interface to a PHPTMAPI system. Any PHPTMAPI system must be capable of providing access to one or more TopicMap objects. A PHPTMAPI system may be capable of allowing a client to create new TopicMap instances.

Located in /core/TopicMapSystem.interface.php (line 24)


	
			
Method Summary
void close ()
TopicMap createTopicMap (string $uri)
boolean getFeature (string $featureName)
array getLocators ()
object|null getProperty (string $propertyName)
TopicMap|null getTopicMap (string $uri)
Methods
close (line 102)

Applications SHOULD call this method when the TopicMapSystem instance is no longer required.

Applications SHOULD call this method when the TopicMapSystem instance is no longer required. Once the TopicMapSystem instance is closed, the TopicMapSystem and any object retrieved from or created in this TopicMapSystem MUST NOT be used by the application. An implementation of the TopicMapSystem interface may use this method to clean up any resources used by the implementation.

  • access: public
void close ()
createTopicMap (line 47)

Creates a new TopicMap and stores it within the system under the specified URI.

Creates a new TopicMap and stores it within the system under the specified URI.

TopicMap createTopicMap (string $uri)
  • string $uri: The address which should be used to store the TopicMap.
getFeature (line 73)

Returns the value of the feature specified by featureName for this TopicMapSystem instance.

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

  • return: true if the named feature is enabled for this TopicMapSystem instance; false if the named feature is disabled for this instance.
  • throws: FeatureNotRecognizedException If the underlying implementation does not recognize the named feature.
  • access: public
boolean getFeature (string $featureName)
  • string $featureName: The name of the feature to check.
getLocators (line 56)

Returns all storage addresses of TopicMap instances known by this system.

Returns all storage addresses of TopicMap instances known by this system. The return value may be empty but must never be null.

  • return: An array containing URIs of known TopicMap instances.
  • access: public
array getLocators ()
getProperty (line 89)

Returns a property in the underlying implementation of TopicMapSystem.

Returns a property in the underlying implementation of TopicMapSystem. 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 TopicMapSystem and the value for each property is set when the TopicMapSystem is created by a call to TopicMapSystemFactory::newTopicMapSystem() and cannot be modified subsequently.

  • return: Object The value set for the property or null if no value is set for the specified propertyName.
  • access: public
object|null getProperty (string $propertyName)
  • string $propertyName: The name of the property to retrieve.
getTopicMap (line 36)

Retrieves a TopicMap managed by this system with the specified storage address uri.

Retrieves a TopicMap managed by this system with the specified storage address uri. The string is assumed to be in URI notation.

  • return: The instance managed by this system which is stored at the specified uri, or null if no such TopicMap is found.
  • access: public
TopicMap|null getTopicMap (string $uri)
  • string $uri: The storage address to retrieve the TopicMap from.

Documentation generated on Sat, 15 Jan 2011 20:02:27 +0100 by phpDocumentor 1.4.1