org.daisy.pipeline.modules

Class Module

java.lang.Object

org.daisy.pipeline.modules.Module

public abstract class Module
extends Object

Daisy pipeline module holds a set of components accessible via their uri, its name, version and dependencies.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<URI,Supplier<Component>>	components

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Module(String name, String version, String title) Instantiate a new module
protected	Module(String name, String version, String title, ResourceLoader loader)

Method Summary

Modifier and Type	Method and Description
protected boolean	addComponent(Component component)
protected boolean	addComponent(URI uri, String path) This method can be overridden to exclude certain components that have unmet dependencies.
protected boolean	addEntity(Entity entity)
protected boolean	addEntity(String publicId, String path)
protected boolean	addXSLTPackage(String name, String version, String path)
protected boolean	addXSLTPackage(String path, XMLInputFactory parser)
protected boolean	addXSLTPackage(XSLTPackage pack)
boolean	equals(Object o)
Component	getComponent(URI uri) Gets the component identified by the given URI.
Set<URI>	getComponents() Gets all the component URIs.
Set<String>	getEntities() Gets the list of entity IDs.
Entity	getEntity(String publicId) Gets the entity identified by the given ID.
protected org.slf4j.Logger	getLogger()
String	getName() Gets the name.
URL	getResource(String path) Get the specified resource from the module.
String	getTitle() Gets the title.
String	getVersion() Gets the version.
XSLTPackage	getXSLTPackage(String name) Gets the XSLT package identified by the given name.
Iterable<XSLTPackage>	getXSLTPackages() Gets the list of XSLT packages.
boolean	hasComponent(URI uri) Whether this module provides a component with the given URI.
boolean	hasEntity(String publicId) Whether this module provides a entity with the given ID.
int	hashCode()
static void	parseCatalog(Module module, XmlCatalog catalog)
static void	parseCatalog(Module module, XmlCatalogParser parser) Parse catalog.xml file
abstract void	resolveDependencies() Called by ModuleRegistry to resolve dependencies of components.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

components

protected final Map<URI,Supplier<Component>> components

Constructor Detail

Module

protected Module(String name,
                 String version,
                 String title)

Instantiate a new module

Module

protected Module(String name,
                 String version,
                 String title,
                 ResourceLoader loader)

Method Detail

getLogger

protected org.slf4j.Logger getLogger()

resolveDependencies

public abstract void resolveDependencies()

Called by ModuleRegistry to resolve dependencies of components. If a dependency of a component can not be resolved, this does not result in an exception, but the component will not be created (and consequently will not be available through the #getComponent() or getEntity(java.lang.String) method).

parseCatalog

public static void parseCatalog(Module module,
                                XmlCatalogParser parser)

Parse catalog.xml file

parseCatalog

public static void parseCatalog(Module module,
                                XmlCatalog catalog)
                         throws NoSuchFileException

Throws:

NoSuchFileException

addComponent

protected boolean addComponent(URI uri,
                               String path)
                        throws NoSuchFileException

This method can be overridden to exclude certain components that have unmet dependencies.

Throws:

NoSuchFileException

addComponent

protected boolean addComponent(Component component)

addEntity

protected boolean addEntity(String publicId,
                            String path)
                     throws NoSuchFileException

Throws:

NoSuchFileException

addEntity

protected boolean addEntity(Entity entity)

addXSLTPackage

protected boolean addXSLTPackage(String path,
                                 XMLInputFactory parser)
                          throws NoSuchFileException,
                                 IllegalArgumentException

Throws:

NoSuchFileException

IllegalArgumentException

addXSLTPackage

protected boolean addXSLTPackage(String name,
                                 String version,
                                 String path)
                          throws NoSuchFileException

Throws:

NoSuchFileException

addXSLTPackage

protected boolean addXSLTPackage(XSLTPackage pack)

getName

public String getName()

Gets the name.

getVersion

public String getVersion()

Gets the version.

getTitle

public String getTitle()

Gets the title.

getResource

public URL getResource(String path)
                throws NoSuchFileException

Get the specified resource from the module. This includes all resources, also the ones that are not exposed as components. The method can be overridden to exclude certain resources that have unmet dependencies.

Parameters:

path - The (not URL-encoded) path, relative to catalog.xml, of a resource inside the JAR or class directory of the module.

Returns:

An encoded absolute URL

Throws:

NoSuchFileException - if the resource at path is not available

hasComponent

public boolean hasComponent(URI uri)

Whether this module provides a component with the given URI. This assumes that the component can be resolved. If the component could not be resolved (e.g. due to a missing dependency), this will result in a ResolutionException when the getComponent(java.net.URI) method is called.

getComponents

public Set<URI> getComponents()

Gets all the component URIs.

getComponent

public Component getComponent(URI uri)
                       throws NoSuchElementException,
                              ResolutionException

Gets the component identified by the given URI.

Throws:

NoSuchElementException - if this module provides a component with the given URI.

ResolutionException - if the component could not be resolved, e.g. due to a missing dependency.

getEntities

public Set<String> getEntities()

Gets the list of entity IDs.

hasEntity

public boolean hasEntity(String publicId)

Whether this module provides a entity with the given ID. This assumes that the entity can be resolved. If the entity could not be resolved (e.g. due to a missing dependency), this will result in a ResolutionException when the getEntity(java.lang.String) method is called.

getEntity

public Entity getEntity(String publicId)
                 throws NoSuchElementException,
                        ResolutionException

Gets the entity identified by the given ID.

Throws:

NoSuchElementException - if this module provides an entity with the given ID.

ResolutionException - if the entity could not be resolved, e.g. due to a missing dependency.

getXSLTPackages

public Iterable<XSLTPackage> getXSLTPackages()

Gets the list of XSLT packages.

getXSLTPackage

public XSLTPackage getXSLTPackage(String name)

Gets the XSLT package identified by the given name.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object