Class TopicMapSystemFactory

Description
Description | Methods (details)

This factory class provides access to a Topic Maps system.

This factory class provides access to a Topic Maps 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

		

			Description |
												Methods (details)
		

		
			
			

																																				

					static 						TopicMapSystemFactory
										newInstance
										()
									

																																								

					static 						string
										_getImplementationClassName
										()
									

								
												

											boolean
										getFeature
											(string $featureName)
									

																

											mixed
										getProperty
											(string $propertyName)
									

																

											boolean
										hasFeature
											(string $featureName)
									

																								

											TopicMapSystem
										newTopicMapSystem
										()
									

																

											void
										setFeature
											(string $featureName, boolean $enable)
									

																

											void
										setProperty
											(string $propertyName, mixed $value)
									

																

		

	
		

	
	
	

		
Methods

		

			Description |
																Methods (details)
						
		

		

			



	
	

		static method newInstance (line 113)
	
 
	
	

Obtains a new instance of TopicMapSystemFactory.


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

	
    
				
  • throws: FactoryConfigurationException If the provided implementation of                 TopicMapSystemFactory is not an instance of TopicMapSystemFactory.
    • 
				
  • access: public
    • 
			

	
	

	    static
		TopicMapSystemFactory
		
			newInstance
		
				()
			

	
		
			
	




	
	

		static method _getImplementationClassName (line 155)
	
 
	
	

Returns the class name of the TopicMapSystemFactory implementation as defined in the PHPTMAPI configuration file.


Returns the class name of the TopicMapSystemFactory implementation as defined in the PHPTMAPI configuration file. This configuration file is config.php which is located on root level.

	
    
				
  • return: The class name of the TopicMapSystemFactory implementation.
    • 
				
  • access: private
    • 
			

	
	

	    static
		string
		
			_getImplementationClassName
		
				()
			

	
		
			
	





	
	

		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 86)
	
 
	
	

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: The value set for this property or null        if no value is set.
    • 
				
  • abstract: 
    • 
				
  • access: public
    • 
			

	
	

		mixed
		
			getProperty
		
					(string $propertyName)
			

	
			
    
					
  • 
				string
				$propertyName: The name of the property to retrieve.			
    • 
				

		
			
	




	
	

		hasFeature (line 73)
	
 
	
	

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 145)
	
 
	
	

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 59)
	
 
	
	

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 $enable 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 100)
	
 
	
	

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, mixed $value)
			

	
			
    
					
  • 
				string
				$propertyName: The name of the property to be set.			
    • 
					
  • 
				mixed
				$value: The value to be set of this property or null to        remove the property from the current factory configuration.			
    • 
				

		
			
	

						
		

	



	

		Documentation generated on Mon, 19 Sep 2011 21:01:28 +0200 by phpDocumentor 1.4.0