• Home
• org.daisy.pipeline
• modules-api
• 1.0.0
• source code
• ModuleRegistry.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.daisy.pipeline.modules.ModuleRegistry Maven / Gradle / Ivy

package org.daisy.pipeline.modules;

import java.net.URI;



// TODO: Auto-generated Javadoc
/**
 * ModuleRegistry offers the functionality to enregister and query for the modules loaded.
 */
public interface ModuleRegistry extends Iterable {


	/**
	 * Adds the module.
	 *
	 * @param module the module
	 */
	public void addModule(Module module);



	/**
	 * Gets the module which has a component identified by the unique systemId.
	 *
	 * @param uri the uri
	 * @return the module by component
	 */
	public Module getModuleByComponent(URI uri);

	/**
	 * Gets the module which has declared the entity with the given public id.
	 *
	 * @param publicId the public id
	 * @return the module by entity
	 */
	public Module getModuleByEntity(String publicId);

	/**
	 * Gets the module handler which solves the dependency of the module source
	 * with the returned module component uri.
	 *
	 * @param component the component
	 * @param source the source
	 * @return the module
	 */
	public Module resolveDependency(URI component, Module source);

	/**
	 * Returns the list of available components.
	 *
	 * @return an iterable with all the available components
	 */
	public Iterable getComponents();

	/**
	 * Returns the list of available entities.
	 *
	 * @return the entities
	 */
	public Iterable getEntities();

}