org.corpus_tools.pepper.core

Class ModuleResolverImpl

java.lang.Object

org.corpus_tools.pepper.core.ModuleResolverImpl

All Implemented Interfaces:

ModuleResolver

public class ModuleResolverImpl
extends Object
implements ModuleResolver

The ModuleResolverImpl realizes a bridge between the Pepper framework and the OSGi environment. Through OSGi declarative services all PepperModule no matter if PepperImporter, PepperExporter or PepperManipulator, all of them are registered in the ModuleResolverImpl. The main task of this class is to get a description of a PepperModule and to resolve a real instance of that PepperModule.

Author:

Florian Zipser

Field Summary

Fields

Modifier and Type	Field and Description
protected List<org.osgi.service.component.ComponentFactory>	pepperExporterComponentFactories TODO make docu
protected org.osgi.service.component.ComponentFactory	pepperExporterComponentFactory This unnecessary variable must be initialized, because of restrictions of the maven osgi scr plugin.
protected List<org.osgi.service.component.ComponentFactory>	pepperImporterComponentFactories TODO make docu
protected org.osgi.service.component.ComponentFactory	pepperImporterComponentFactory This unnecessary variable must be initialized, because of restrictions of the maven osgi scr plugin.
protected List<org.osgi.service.component.ComponentFactory>	pepperManipulatorComponentFactories TODO make docu
protected org.osgi.service.component.ComponentFactory	pepperManipulatorComponentFactory This unnecessary variable must be initialized, because of restrictions of the maven osgi scr plugin.
static String	PROP_OSGI_BUNDLES name of system property to determine the locations of OSGi bundles

Fields inherited from interface org.corpus_tools.pepper.core.ModuleResolver

RESOURCES

Constructor Summary

Constructors

Constructor and Description
ModuleResolverImpl() TODO make docu

Method Summary

Modifier and Type	Method and Description
void	activate(org.osgi.service.component.ComponentContext componentContext) Sets the ComponentContext of the OSGi environment the bundle was started in.
void	addPepperExporterComponentFactory(org.osgi.service.component.ComponentFactory pepperExporterComponentFactory) This method is called by OSGi framework and adds all registered ComponentFactory objects having the name PepperExporterComponentFactory to this object.
void	addPepperImporterComponentFactory(org.osgi.service.component.ComponentFactory pepperImporterComponentFactory) This method is called by OSGi framework and adds all registered ComponentFactory objects having the name PepperImporterComponentFactory to this object.
void	addPepperManipulatorComponentFactory(org.osgi.service.component.ComponentFactory pepperManipulatorComponentFactory) This method is called by OSGi framework and adds all registered ComponentFactory objects having the name PepperManipulatorComponentFactory to this object.
org.osgi.service.component.ComponentContext	getComponentContext() Returns the ComponentContext of the OSGi environment the bundle was started in.
PepperConfiguration	getConfiguration() Returns the configuration object for this converter object.
PepperExporter	getPepperExporter(StepDesc stepDesc) Creates an instance of PepperExporter for each listed ComponentFactory in list #pepperExporterComponentFactories and returns that list.
List<org.osgi.service.component.ComponentFactory>	getPepperExporterComponentFactories() TODO make docu
List<PepperExporter>	getPepperExporters() Creates an instance of PepperExporter for each listed ComponentFactory in list #pepperExporterComponentFactories and returns that list.
PepperImporter	getPepperImporter(StepDesc stepDesc) Returns a PepperImporter object matching to the given ImporterParams.
List<org.osgi.service.component.ComponentFactory>	getPepperImporterComponentFactories() TODO make docu
List<PepperImporter>	getPepperImporters() Creates an instance of PepperImporter for each listed ComponentFactory in list #pepperImporterComponentFactories and returns that list.
PepperManipulator	getPepperManipulator(StepDesc stepDesc) Creates an instance of PepperManipulator for each listed ComponentFactory in list #pepperManipulatorComponentFactories and returns that list.
List<org.osgi.service.component.ComponentFactory>	getPepperManipulatorComponentFactories() TODO make docu
List<PepperManipulator>	getPepperManipulators() Creates an instance of PepperManipulator for each listed ComponentFactory in list #pepperManipulatorComponentFactories and returns that list.
PepperModule	getPepperModule(StepDesc stepDesc) Returns a PepperModule object matching to the given StepDesc.
String	getStatus() Returns a status description as String.
void	removePepperExporterComponentFactory(org.osgi.service.component.ComponentFactory pepperExporterComponentFactory) TODO make some docu
void	removePepperImporterComponentFactory(org.osgi.service.component.ComponentFactory pepperImporterComponentFactory) TODO make docu
void	removePepperManipulatorComponentFactory(org.osgi.service.component.ComponentFactory pepperManipulatorComponentFactory) TODO make docu
protected String	retrieveResourcePathFromBundle(PepperModule module) Retrieves the path, where the bundle is located and extracts the path, where resources are estimated
void	setConfiguration(PepperConfiguration pepperConfiguration) Sets the configuration object for this object.
protected void	setResources(PepperModule module) Sets resources to a given PepperModule-object.
protected void	setTemporaries(PepperModule module, int number) Sets a temporary folder for each PepperModule to store temporary files if necessary.
String	toString() TODO make docu

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

pepperImporterComponentFactory

protected org.osgi.service.component.ComponentFactory pepperImporterComponentFactory

This unnecessary variable must be initialized, because of restrictions of the maven osgi scr plugin. Here it is not possible to use a list as osgi-reference. (this is a workaround)

pepperImporterComponentFactories

protected List<org.osgi.service.component.ComponentFactory> pepperImporterComponentFactories

TODO make docu

pepperManipulatorComponentFactory

protected org.osgi.service.component.ComponentFactory pepperManipulatorComponentFactory

This unnecessary variable must be initialized, because of restrictions of the maven osgi scr plugin. Here it is not possible to use a list as osgi-reference. (this is a workaround)

pepperManipulatorComponentFactories

protected List<org.osgi.service.component.ComponentFactory> pepperManipulatorComponentFactories

TODO make docu

pepperExporterComponentFactory

protected org.osgi.service.component.ComponentFactory pepperExporterComponentFactory

This unnecessary variable must be initialized, because of restrictions of the maven osgi scr plugin. Here it is not possible to use a list as osgi-reference. (this is a workaround)

pepperExporterComponentFactories

protected List<org.osgi.service.component.ComponentFactory> pepperExporterComponentFactories

TODO make docu

PROP_OSGI_BUNDLES

public static final String PROP_OSGI_BUNDLES

name of system property to determine the locations of OSGi bundles

See Also:

Constant Field Values

Constructor Detail

ModuleResolverImpl

public ModuleResolverImpl()

TODO make docu

Method Detail

getComponentContext

public org.osgi.service.component.ComponentContext getComponentContext()

Returns the ComponentContext of the OSGi environment the bundle was started in.

Specified by:

getComponentContext in interface ModuleResolver

Returns:

activate

public void activate(org.osgi.service.component.ComponentContext componentContext)

Sets the ComponentContext of the OSGi environment the bundle was started in.

Specified by:

activate in interface ModuleResolver

getStatus

public String getStatus()

Returns a status description as String. The returned String contains the number of all available PepperModule objects in a readable format.

Specified by:

getStatus in interface ModuleResolver

Returns:

String representation of all PepperModule objects available by this PepperModuleResolver object.

addPepperImporterComponentFactory

public void addPepperImporterComponentFactory(org.osgi.service.component.ComponentFactory pepperImporterComponentFactory)

This method is called by OSGi framework and adds all registered ComponentFactory objects having the name PepperImporterComponentFactory to this object. All ComponentFactory objects are stored in an internal object #pepperImporterComponentFactories

Specified by:

addPepperImporterComponentFactory in interface ModuleResolver

removePepperImporterComponentFactory

public void removePepperImporterComponentFactory(org.osgi.service.component.ComponentFactory pepperImporterComponentFactory)

TODO make docu

Specified by:

removePepperImporterComponentFactory in interface ModuleResolver

getPepperImporterComponentFactories

public List<org.osgi.service.component.ComponentFactory> getPepperImporterComponentFactories()

TODO make docu

Specified by:

getPepperImporterComponentFactories in interface ModuleResolver

addPepperManipulatorComponentFactory

public void addPepperManipulatorComponentFactory(org.osgi.service.component.ComponentFactory pepperManipulatorComponentFactory)

This method is called by OSGi framework and adds all registered ComponentFactory objects having the name PepperManipulatorComponentFactory to this object. All ComponentFactory objects are stored in an internal object #pepperManipulatorComponentFactories.

Specified by:

addPepperManipulatorComponentFactory in interface ModuleResolver

removePepperManipulatorComponentFactory

public void removePepperManipulatorComponentFactory(org.osgi.service.component.ComponentFactory pepperManipulatorComponentFactory)

TODO make docu

Specified by:

removePepperManipulatorComponentFactory in interface ModuleResolver

getPepperManipulatorComponentFactories

public List<org.osgi.service.component.ComponentFactory> getPepperManipulatorComponentFactories()

TODO make docu

Specified by:

getPepperManipulatorComponentFactories in interface ModuleResolver

addPepperExporterComponentFactory

public void addPepperExporterComponentFactory(org.osgi.service.component.ComponentFactory pepperExporterComponentFactory)

This method is called by OSGi framework and adds all registered ComponentFactory objects having the name PepperExporterComponentFactory to this object. All ComponentFactory objects are stored in the internal object list #pepperExporterComponentFactories.

Specified by:

addPepperExporterComponentFactory in interface ModuleResolver

Parameters:

pepperExporterComponentFactory - ComponentFactory object to be stored in internal list

removePepperExporterComponentFactory

public void removePepperExporterComponentFactory(org.osgi.service.component.ComponentFactory pepperExporterComponentFactory)

TODO make some docu

Specified by:

removePepperExporterComponentFactory in interface ModuleResolver

getPepperExporterComponentFactories

public List<org.osgi.service.component.ComponentFactory> getPepperExporterComponentFactories()

TODO make docu

Specified by:

getPepperExporterComponentFactories in interface ModuleResolver

setResources

protected void setResources(PepperModule module)

Sets resources to a given PepperModule-object. The policy of computing the resource path is the following:

1. If a system property named SYMBOLIC_NAME_OF_MODULE+ModuleResolver.RESOURCES is set, the PepperModule.getResources() would be directed the value contained by this property
2. If environment variable is set, PepperModule.getResources() would be directed to value of /SYMBOLIC_NAME_OF_MODULE
3. If system property is set, PepperModule.getResources() would be directed to value of /SYMBOLIC_NAME_OF_MODULE
4. If nothing is set, PepperModule.getResources() would be directed to a subfolder having the name equal to the symbolic name of the bundle, which is located in the same folder as the bundle is located

Parameters:

module - - the object for setting resources

retrieveResourcePathFromBundle

protected String retrieveResourcePathFromBundle(PepperModule module)

Retrieves the path, where the bundle is located and extracts the path, where resources are estimated

Returns:

setConfiguration

public void setConfiguration(PepperConfiguration pepperConfiguration)

Sets the configuration object for this object.

Specified by:

setConfiguration in interface ModuleResolver

getConfiguration

public PepperConfiguration getConfiguration()

Returns the configuration object for this converter object. If no PepperConfiguration object was set, an automatic detection of configuration file will be started.

Specified by:

getConfiguration in interface ModuleResolver

Returns:

configuration object

setTemporaries

protected void setTemporaries(PepperModule module,
                              int number)

Sets a temporary folder for each PepperModule to store temporary files if necessary. The general temporary folder could either be given via the property PepperConfiguration.PROP_TEMP_FOLDER or if this is not set, resolved by via using the temporary folder provided by the OS.
The specific temporary folder is given by the general temporary folder + a subfolder for the modules name and a subfolder for the number of the instance of the current module.

Parameters:

module - - the object for setting temporaries

number - - number of module instance

getPepperImporters

public List<PepperImporter> getPepperImporters()

Creates an instance of PepperImporter for each listed ComponentFactory in list #pepperImporterComponentFactories and returns that list. This PepperModuleResolver instance does not store any link to the created object, so it can be used and removed as the caller like. Thus each call creates a new list containing new objects.

Specified by:

getPepperImporters in interface ModuleResolver

Returns:

a list of PepperImporter objects.

getPepperManipulators

public List<PepperManipulator> getPepperManipulators()

Creates an instance of PepperManipulator for each listed ComponentFactory in list #pepperManipulatorComponentFactories and returns that list. This PepperModuleResolver instance does not store any link to the created object, so it can be used and removed as the caller like. Thus each call creates a new list containing new objects.

Specified by:

getPepperManipulators in interface ModuleResolver

Returns:

a list of PepperManipulator objects.

getPepperExporters

public List<PepperExporter> getPepperExporters()

Creates an instance of PepperExporter for each listed ComponentFactory in list #pepperExporterComponentFactories and returns that list. This PepperModuleResolver instance does not store any link to the created object, so it can be used and removed as the caller like. Thus each call creates a new list containing new objects.

Specified by:

getPepperExporters in interface ModuleResolver

Returns:

a list of PepperExporter objects.

getPepperModule

public PepperModule getPepperModule(StepDesc stepDesc)

Returns a PepperModule object matching to the given StepDesc. A new instance of the specific PepperImporter class is created and returned. No references to the returned object will be stored in this PepperModuleResolver object. When calling #getPepperModule(ImporterParams) a new instance of PepperModule is created.

Specified by:

getPepperModule in interface ModuleResolver

Returns:

a new instance of PepperModule matching the given StepDesc

getPepperImporter

public PepperImporter getPepperImporter(StepDesc stepDesc)

Returns a PepperImporter object matching to the given ImporterParams. A new instance of the specific PepperImporter class is created and returned. No references to the returned object will be stored in this PepperModuleResolver object. When calling #getPepperImporter(ImporterParams) a new instance of PepperImporter is created.

Specified by:

getPepperImporter in interface ModuleResolver

Returns:

a new instance of PepperImporter matching the given ImporterParams

getPepperManipulator

public PepperManipulator getPepperManipulator(StepDesc stepDesc)

Creates an instance of PepperManipulator for each listed ComponentFactory in list #pepperManipulatorComponentFactories and returns that list. This PepperModuleResolver instance does not store any link to the created object, so it can be used and removed as the caller like. Thus each call creates a new list containing new objects.

Specified by:

getPepperManipulator in interface ModuleResolver

Returns:

a list of PepperManipulator objects.

getPepperExporter

public PepperExporter getPepperExporter(StepDesc stepDesc)

Creates an instance of PepperExporter for each listed ComponentFactory in list #pepperExporterComponentFactories and returns that list. This PepperModuleResolver instance does not store any link to the created object, so it can be used and removed as the caller like. Thus each call creates a new list containing new objects.

Specified by:

getPepperExporter in interface ModuleResolver

Returns:

a list of PepperExporter objects.

toString

public String toString()

TODO make docu

Overrides:

toString in class Object