com.xmlmind.w2x.processor

Class LoadStep

java.lang.Object

com.xmlmind.w2x.processor.ProcessStep

com.xmlmind.w2x.processor.LoadStep

public class LoadStep
extends ProcessStep

This processing step is used to load an input XML file.

Note that this processing step never parses the DTD (http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd, http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd, etc) possibly found at the beginning of the input XML file.

Field Summary

Fields inherited from class com.xmlmind.w2x.processor.ProcessStep

stepName

Constructor Summary

Constructors

Constructor and Description
LoadStep(String stepName) Constructs a LoadStep having specified name.

Method Summary

Modifier and Type	Method and Description
void	process(Object[] state, Map<String,String> parameters, int[] stepCounter, ProgressMonitor monitor) Execute this processing step.

Methods inherited from class com.xmlmind.w2x.processor.ProcessStep

debugParameters, equals, getAllParameters, getBooleanParameter, getFileParameter, getIntParameter, getParameter, getURLParameter, hashCode, illegalState, joinAllParameters, missingParameter, parameterName, progress, toString, urlOrFile

Methods inherited from class java.lang.Object

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

Constructor Detail

LoadStep

public LoadStep(String stepName)

Constructs a LoadStep having specified name.

Method Detail

process

public void process(Object[] state,
                    Map<String,String> parameters,
                    int[] stepCounter,
                    ProgressMonitor monitor)
             throws Exception

Execute this processing step.

state[0] contains:

• Before this method is executed: input XML file.
• After this method is executed: loaded XML document.

Specified by:

process in class ProcessStep

Parameters:

state - contains the current state of processing: a Document or a File.

This object is used as the input of this step and thus, is processed by this step.

After its execution, this method generally updates the state array with a new Document or File to pass the result/output of this step to the next step.

parameters - all the parameters passed to the Processor owning and thus executing this process step.

Parameters which are relevant to this processing step are prefixed with "ProcessStep.stepName.".

stepCounter - contains the rank of previously executed processing step. Must be incremented by this method.

monitor - used to monitor the progress of the processing steps

Invoking convenience method ProcessStep.progress(java.lang.String, int[], com.xmlmind.util.ProgressMonitor) suffices to make good use of both monitor and stepCounter.

Throws:

Exception - if for any reason, this method fails