Class TopicMapSystemFactory

Description

This factory class provides access to a topic map system.

This factory class provides access to a topic map system. A new TopicMapSystem instance is created by invoking the newTopicMapSystem() method. Configuration properties for the new TopicMapSystem instance can be set by calling the setFeature() and / or setProperty() methods prior to invoking newTopicMapSystem().

Located in /core/TopicMapSystemFactory.class.php (line 28)


	
			
Method Summary
boolean getFeature (string $featureName)
object|null getProperty (string $propertyName)
boolean hasFeature (string $featureName)
void setFeature (string $featureName, boolean $enable)
void setProperty (string $propertyName, object|null $value)
Methods
static method newInstance (line 111)

Obtain a new instance of a TopicMapSystemFactory.

Obtain a new instance of a TopicMapSystemFactory. Once an application has obtained a reference to a TopicMapSystemFactory it can use the factory to configure and obtain TopicMapSystem instances.

static TopicMapSystemFactory newInstance ()
getFeature (line 42)

Returns the particular feature requested for in the underlying implementation of TopicMapSystem.

Returns the particular feature requested for in the underlying implementation of TopicMapSystem.

  • return: true if the named feature is enabled for TopicMapSystem instances created by this factory; false if the named feature is disabled for TopicMapSystem instances created by this factory.
  • abstract:
  • 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.
getProperty (line 85)

Gets the value of a property in the underlying implementation of TopicMapSystem.

Gets the value of 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.

  • return: Object The value set for this property or null if no value is currently set for the property.
  • abstract:
  • access: public
object|null getProperty (string $propertyName)
  • string $propertyName: The name of the property to retrieve.
hasFeature (line 72)

Returns if the particular feature is supported by the TopicMapSystem.

Returns if the particular feature is supported by the TopicMapSystem. Opposite to getFeature this method returns if the requested feature is generally available / supported by the underlying TopicMapSystem and does not return the state (enabled/disabled) of the feature.

  • return: true if the requested feature is supported, otherwise false.
  • abstract:
  • access: public
boolean hasFeature (string $featureName)
  • string $featureName: The name of the feature to check.
newTopicMapSystem (line 139)

Creates a new TopicMapSystem instance using the currently configured factory parameters.

Creates a new TopicMapSystem instance using the currently configured factory parameters.

  • abstract:
  • throws: PHPTMAPIException If a TopicMapSystem cannot be created which satisfies the requested configuration.
  • access: public
TopicMapSystem newTopicMapSystem ()
setFeature (line 58)

Sets a particular feature in the underlying implementation of TopicMapSystem.

Sets a particular feature in the underlying implementation of TopicMapSystem. A list of the core features can be found at http://tmapi.org/features/.

  • abstract:
  • throws: FeatureNotRecognizedException If the underlying implementation does not recognize the named feature.
  • throws: FeatureNotSupportedException If the underlying implementation recognizes the named feature but does not support enabling or disabling it (as specified by the enabled parameter).
  • access: public
void setFeature (string $featureName, boolean $enable)
  • string $featureName: The name of the feature to be set.
  • boolean $enable: true to enable the feature, false to disable it.
setProperty (line 99)

Sets a property in the underlying implementation of TopicMapSystem.

Sets 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.

  • abstract:
  • access: public
void setProperty (string $propertyName, object|null $value)
  • string $propertyName: The name of the property to be set.
  • object|null $value: Object The value to be set of this property or null to remove the property from the current factory configuration.

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