Class TopicMapSystemFactory

Description
Description | Methods (details)

abstract class TopicMapSystemFactory: This factory class provides access to a topic map system.

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

Located in /org.phptmapi.core/TopicMapSystemFactory.abstract.php (line 11) 


	
			







	
	

		
Method Summary

		

			Description |
												Methods (details)
		

		
			
			

								
				

											void
										__construct
										()
									

								
				

											boolean
										getFeature
											(string $featureName)
									

								
				

											string
										getProperty
											(string $propertyName)
									

								
				

											boolean
										hasFeature
											(string $featureName)
									

								
				

											object TopicMapSystemFactory
										newInstance
										()
									

								
				

											object TopicMapSystemInterface
										newTopicMapSystem
										()
									

								
				

											void
										setFeature
											(string $featureName, boolean $value)
									

								
				

											void
										setProperties
											(array $props)
									

								
				

											void
										setProperty
											(string $propertyName, string $value)
									

							

		

	
		

	
	
	

		
Methods

		

			Description |
																Methods (details)
						
		

		

			



	
	

		Constructor __construct (line 17)
	
 
	
	

Constructor


Constructor

	
    
				
  • abstract: 
    • 
				
  • access: public
    • 
			

	
	

		void
		
			__construct
		
				()
			

	
		
		
	




	
	

		getFeature (line 82)
	
 
	
	

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


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

	
    
				
  • return: true if the named feature is enabled for TopicMapSystemInterface instances created by this factory; false if the named feature is disabled for TopicMapSystemInterface instances created by this factory.
    • 
				
  • abstract: 
    • 
				
  • throws: FeatureNotRecognizedException if the underlying implementation does not recognize the named feature. 
    1.      public function getFeature($featureName){
      2. 

    2.         throw new FeatureNotRecognizedException('Exception in '.__method__);
      3. 

    3.      }
      4. 

    • 
				
  • access: public
    • 
			

	
	

		boolean
		
			getFeature
		
					(string $featureName)
			

	
			
    
					
  • 
				string
				$featureName: The name of the feature to check.			
    • 
				

		
		
	




	
	

		getProperty (line 117)
	
 
	
	

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


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

	
    
				
  • return: The value set for this property or null if no value is currently set for the property.
    • 
				
  • abstract: 
    • 
				
  • access: public
    • 
			

	
	

		string
		
			getProperty
		
					(string $propertyName)
			

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

		
		
	




	
	

		hasFeature (line 90)
	
 
	
	

Returns if the particular feature is supported by the TopicMapSystemInterface.


Returns if the particular feature is supported by the TopicMapSystemInterface. Opposite to getFeature() this method returns if the requested feature is generally available/supported by the underlying TopicMapSystemInterface 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.			
    • 
				

		
		
	




	
	

		newInstance (line 25)
	
 
	
	

newInstance: This static method creates a new factory instance.


newInstance: This static method creates a new factory instance.

	
    
				
  • static: 
    • 
				
  • access: public
    • 
				
  • throws: FactoryConfigurationException
    • 
			

	
	

		object TopicMapSystemFactory
		
			newInstance
		
				()
			

	
		
		
	




	
	

		newTopicMapSystem (line 51)
	
 
	
	

newTopicMapSystem: Creates a new TopicMapSystemInterface instance using the currently configured factory parameters.


newTopicMapSystem: Creates a new TopicMapSystemInterface instance using the currently configured factory parameters.

	
    
				
  • abstract: 
    • 
				
  • throws: TMAPIException if a topic map system cannot be created which satisfies the requested configuration. 
    1.      public function newTopicMapSystem(){
      2. 

    2.         throw new TMAPIException('Exception in '.__method__);
      3. 

    3.      }
      4. 

    • 
				
  • access: public
    • 
			

	
	

		object TopicMapSystemInterface
		
			newTopicMapSystem
		
				()
			

	
		
		
	




	
	

		setFeature (line 68)
	
 
	
	

setFeature: Sets a particular feature in the underlying implementation of TopicMapSystemInterface.


setFeature: Sets a particular feature in the underlying implementation of TopicMapSystemInterface. 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 value parameter). 
    1.      public function setFeature($featureName, $value){
      2. 

    2.         throw new FeatureNotRecognizedException('Exception in '.__method__);
      3. 

    3.         throw new FeatureNotSupportedException('Exception in '.__method__);
      4. 

    4.      }
      5. 

    • 
				
  • access: public
    • 
			

	
	

		void
		
			setFeature
		
					(string $featureName, boolean $value)
			

	
			
    
					
  • 
				string
				$featureName: The name of the feature to be set.			
    • 
					
  • 
				boolean
				$value: True to enable the feature, false to disable it.			
    • 
				

		
		
	




	
	

		setProperties (line 99)
	
 
	
	

Sets the properties in the underlying implementation of TopicMapSystemInterface.


Sets the properties in the underlying implementation of TopicMapSystemInterface.

	
	
	

		void
		
			setProperties
		
					(array $props)
			

	
			
    
					
  • 
				array
				$props: The properties to be used to initialise the system.			
    • 
				

		
		
	




	
	

		setProperty (line 108)
	
 
	
	

Sets a property in the underlying implementation of TopicMapSystemInterface.


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

	
    
				
  • abstract: 
    • 
				
  • access: public
    • 
			

	
	

		void
		
			setProperty
		
					(string $propertyName, string $value)
			

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

		
		
	

						
		

	



	

		Documentation generated on Fri, 30 Jun 2006 13:07:12 +0200 by phpDocumentor 1.3.0RC4