org.corpus_tools.pepper.core.ModuleResolver Interface Reference

Inherited by org.corpus_tools.pepper.core.ModuleResolverImpl.

Public Member Functions
abstract ComponentContext	getComponentContext ()
	Returns the ComponentContext of the OSGi environment the bundle was started in.
abstract void	activate (ComponentContext componentContext)
	Sets the ComponentContext of the OSGi environment the bundle was started in.
abstract String	getStatus ()
	Returns a status description as String.
abstract void	addPepperImporterComponentFactory (ComponentFactory pepperImporterComponentFactory)
	This method is called by OSGi framework and adds all registered ComponentFactory objects having the name PepperImporterComponentFactory to this object.
abstract void	removePepperImporterComponentFactory (ComponentFactory pepperImporterComponentFactory)
	TODO make docu.
abstract List< ComponentFactory >	getPepperImporterComponentFactories ()
	TODO make docu.
abstract void	addPepperManipulatorComponentFactory (ComponentFactory pepperManipulatorComponentFactory)
	This method is called by OSGi framework and adds all registered ComponentFactory objects having the name PepperManipulatorComponentFactory to this object.
abstract void	removePepperManipulatorComponentFactory (ComponentFactory pepperManipulatorComponentFactory)
	TODO make docu.
abstract List< ComponentFactory >	getPepperManipulatorComponentFactories ()
	TODO make docu.
abstract void	addPepperExporterComponentFactory (ComponentFactory pepperExporterComponentFactory)
	This method is called by OSGi framework and adds all registered ComponentFactory objects having the name PepperExporterComponentFactory to this object.
abstract void	removePepperExporterComponentFactory (ComponentFactory pepperExporterComponentFactory)
	TODO make some docu.
abstract List< ComponentFactory >	getPepperExporterComponentFactories ()
	TODO make docu.
abstract void	setConfiguration (PepperConfiguration pepperConfiguration)
	Sets the configuration object for this object.
abstract PepperConfiguration	getConfiguration ()
	Returns the configuration object for this converter object.
abstract List< PepperImporter >	getPepperImporters ()
	Creates an instance of PepperImporter for each listed ComponentFactory in list pepperImporterComponentFactories and returns that list.
abstract List< PepperManipulator >	getPepperManipulators ()
	Creates an instance of PepperManipulator for each listed ComponentFactory in list pepperManipulatorComponentFactories and returns that list.
abstract List< PepperExporter >	getPepperExporters ()
	Creates an instance of PepperExporter for each listed ComponentFactory in list pepperExporterComponentFactories and returns that list.
abstract PepperModule	getPepperModule (StepDesc stepDesc)
	Returns a PepperModule object matching to the given StepDesc.
abstract PepperImporter	getPepperImporter (StepDesc stepDesc)
	Returns a PepperImporter object matching to the given ImporterParams.
abstract PepperManipulator	getPepperManipulator (StepDesc stepDesc)
	Creates an instance of PepperManipulator for each listed ComponentFactory in list pepperManipulatorComponentFactories and returns that list.
abstract PepperExporter	getPepperExporter (StepDesc stepDesc)
	Creates an instance of PepperExporter for each listed ComponentFactory in list pepperExporterComponentFactories and returns that list.

Static Public Attributes
static final String	RESOURCES = ".resources"

Member Function Documentation

activate()

abstract void org.corpus_tools.pepper.core.ModuleResolver.activate ( ComponentContext  componentContext )

abstract

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

Parameters

componentContext

Implemented in org.corpus_tools.pepper.core.ModuleResolverImpl.

addPepperExporterComponentFactory()

abstract void org.corpus_tools.pepper.core.ModuleResolver.addPepperExporterComponentFactory ( ComponentFactory  pepperExporterComponentFactory )

abstract

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.

Parameters

pepperExporterComponentFactory

ComponentFactory object to be stored in internal list @model pepperExporterComponentFactoryDataType= "de.hub.corpling.pepper.pepperFW.ComponentFactory" @generated

Implemented in org.corpus_tools.pepper.core.ModuleResolverImpl.

addPepperImporterComponentFactory()

abstract void org.corpus_tools.pepper.core.ModuleResolver.addPepperImporterComponentFactory ( ComponentFactory  pepperImporterComponentFactory )

abstract

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

Implemented in org.corpus_tools.pepper.core.ModuleResolverImpl.

addPepperManipulatorComponentFactory()

abstract void org.corpus_tools.pepper.core.ModuleResolver.addPepperManipulatorComponentFactory ( ComponentFactory  pepperManipulatorComponentFactory )

abstract

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.

Implemented in org.corpus_tools.pepper.core.ModuleResolverImpl.

getComponentContext()

abstract ComponentContext org.corpus_tools.pepper.core.ModuleResolver.getComponentContext ( )

abstract

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

Returns

Implemented in org.corpus_tools.pepper.core.ModuleResolverImpl.

getConfiguration()

abstract PepperConfiguration org.corpus_tools.pepper.core.ModuleResolver.getConfiguration ( )

abstract

Returns the configuration object for this converter object.

If no PepperConfiguration object was set, an automatic detection of configuration file will be started.

Returns

configuration object

Implemented in org.corpus_tools.pepper.core.ModuleResolverImpl.

getPepperExporter()

abstract PepperExporter org.corpus_tools.pepper.core.ModuleResolver.getPepperExporter ( StepDesc  stepDesc )

abstract

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.

Returns

a list of PepperExporter objects.

Implemented in org.corpus_tools.pepper.core.ModuleResolverImpl.

getPepperExporterComponentFactories()

abstract List< ComponentFactory > org.corpus_tools.pepper.core.ModuleResolver.getPepperExporterComponentFactories ( )

abstract

TODO make docu.

Implemented in org.corpus_tools.pepper.core.ModuleResolverImpl.

getPepperExporters()

abstract List< PepperExporter > org.corpus_tools.pepper.core.ModuleResolver.getPepperExporters ( )

abstract

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.

Returns

a list of PepperExporter objects.

Implemented in org.corpus_tools.pepper.core.ModuleResolverImpl.

getPepperImporter()

abstract PepperImporter org.corpus_tools.pepper.core.ModuleResolver.getPepperImporter ( StepDesc  stepDesc )

abstract

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.

Parameters

pepperImporterParams

specifies the PepperImporter object to be found

Returns

a new instance of PepperImporter matching the given ImporterParams

Implemented in org.corpus_tools.pepper.core.ModuleResolverImpl.

getPepperImporterComponentFactories()

abstract List< ComponentFactory > org.corpus_tools.pepper.core.ModuleResolver.getPepperImporterComponentFactories ( )

abstract

TODO make docu.

Implemented in org.corpus_tools.pepper.core.ModuleResolverImpl.

getPepperImporters()

abstract List< PepperImporter > org.corpus_tools.pepper.core.ModuleResolver.getPepperImporters ( )

abstract

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.

Returns

a list of PepperImporter objects.

Implemented in org.corpus_tools.pepper.core.ModuleResolverImpl.

getPepperManipulator()

abstract PepperManipulator org.corpus_tools.pepper.core.ModuleResolver.getPepperManipulator ( StepDesc  stepDesc )

abstract

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.

Returns

a list of PepperManipulator objects.

Implemented in org.corpus_tools.pepper.core.ModuleResolverImpl.

getPepperManipulatorComponentFactories()

abstract List< ComponentFactory > org.corpus_tools.pepper.core.ModuleResolver.getPepperManipulatorComponentFactories ( )

abstract

TODO make docu.

Implemented in org.corpus_tools.pepper.core.ModuleResolverImpl.

getPepperManipulators()

abstract List< PepperManipulator > org.corpus_tools.pepper.core.ModuleResolver.getPepperManipulators ( )

abstract

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.

Returns

a list of PepperManipulator objects.

Implemented in org.corpus_tools.pepper.core.ModuleResolverImpl.

getPepperModule()

abstract PepperModule org.corpus_tools.pepper.core.ModuleResolver.getPepperModule ( StepDesc  stepDesc )

abstract

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.

Parameters

pepperImporterParams

specifies the PepperModule object to be found

Returns

a new instance of PepperModule matching the given StepDesc

Implemented in org.corpus_tools.pepper.core.ModuleResolverImpl.

getStatus()

abstract String org.corpus_tools.pepper.core.ModuleResolver.getStatus ( )

abstract

Returns a status description as String.

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

Returns

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

Implemented in org.corpus_tools.pepper.core.ModuleResolverImpl.

removePepperExporterComponentFactory()

abstract void org.corpus_tools.pepper.core.ModuleResolver.removePepperExporterComponentFactory ( ComponentFactory  pepperExporterComponentFactory )

abstract

TODO make some docu.

Implemented in org.corpus_tools.pepper.core.ModuleResolverImpl.

removePepperImporterComponentFactory()

abstract void org.corpus_tools.pepper.core.ModuleResolver.removePepperImporterComponentFactory ( ComponentFactory  pepperImporterComponentFactory )

abstract

TODO make docu.

Implemented in org.corpus_tools.pepper.core.ModuleResolverImpl.

removePepperManipulatorComponentFactory()

abstract void org.corpus_tools.pepper.core.ModuleResolver.removePepperManipulatorComponentFactory ( ComponentFactory  pepperManipulatorComponentFactory )

abstract

TODO make docu.

Implemented in org.corpus_tools.pepper.core.ModuleResolverImpl.

setConfiguration()

abstract void org.corpus_tools.pepper.core.ModuleResolver.setConfiguration ( PepperConfiguration  pepperConfiguration )

abstract

Sets the configuration object for this object.

Parameters

pepperConfiguration

Implemented in org.corpus_tools.pepper.core.ModuleResolverImpl.