org.carewebframework.maven.plugin.help

Class SourceLoader

java.lang.Object

org.carewebframework.maven.plugin.help.SourceLoader

Direct Known Subclasses:

ChmSourceLoader

public class SourceLoader
extends Object

Generic source loader. Used for JavaHelp and OHJ formats. May be extended to support other formats.

Constructor Summary

Constructors

Constructor and Description
SourceLoader(String formatSpecifier, String helpSetPattern, Class<? extends IResourceIterator> iteratorClass) Create a source loader.

Method Summary

Modifier and Type	Method and Description
String	getFormatSpecifier()
String	getHelpSetPattern()
Class<? extends IResourceIterator>	getIteratorClass() Returns the class that will be used to iterate over the contents of a source archive.
boolean	isHelpSetFile(String fileName) Returns true if the file name matches the pattern specified for the main help set file.
IResourceIterator	load(String archiveName) Returns a resource iterator instance for the given archive name.
void	registerTransforms(HelpProcessor processor) Register all file transforms with the main processor.

Methods inherited from class java.lang.Object

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

Constructor Detail

SourceLoader

public SourceLoader(String formatSpecifier,
                    String helpSetPattern,
                    Class<? extends IResourceIterator> iteratorClass)

Create a source loader.

Parameters:

formatSpecifier - The unique help format specifier (e.g., "javahelp").

helpSetPattern - The pattern that will be used to identify the main help set file.

iteratorClass - The class that will be used to iterate over files in the source archive.

Method Detail

registerTransforms

public void registerTransforms(HelpProcessor processor)

Register all file transforms with the main processor. This is called by the main processor to allow each source loader to register its file transforms. By default, all files are simply copied from the source to the target. Override if additional transforms are needed.

Parameters:

processor - The main help processor.

getIteratorClass

public Class<? extends IResourceIterator> getIteratorClass()

Returns the class that will be used to iterate over the contents of a source archive.

Returns:

A resource iterator.

getHelpSetPattern

public String getHelpSetPattern()

getFormatSpecifier

public String getFormatSpecifier()

isHelpSetFile

public boolean isHelpSetFile(String fileName)

Returns true if the file name matches the pattern specified for the main help set file.

Parameters:

fileName - File name to check.

Returns:

True if this is the main help set file.

load

public IResourceIterator load(String archiveName)
                       throws Exception

Returns a resource iterator instance for the given archive name.

Parameters:

archiveName - Name of the archive file.

Returns:

A resource iterator instance.

Throws:

Exception - Unspecified exception.