com.taleo.integration.client.customstep.csv
Class ExportHeaderFooterPostStep

java.lang.Object
  extended by com.taleo.integration.client.step.BaseStep
      extended by com.taleo.integration.client.step.BaseCustomStep
          extended by com.taleo.integration.client.customstep.BaseCustomStep
              extended by com.taleo.integration.client.customstep.csv.BaseCustomCsvStep
                  extended by com.taleo.integration.client.customstep.csv.BaseCustomCsvPostStep
                      extended by com.taleo.integration.client.customstep.csv.BaseHeaderFooterPostStep
                          extended by com.taleo.integration.client.customstep.csv.ExportHeaderFooterPostStep
All Implemented Interfaces:
com.taleo.integration.client.step.CustomStep, com.taleo.integration.client.step.Step

public class ExportHeaderFooterPostStep
extends BaseHeaderFooterPostStep

Post-processing step to add a header and/or footer to a CSV file containing the results of an export.

This step takes all parameters from its base class BaseHeaderFooterPostStep.

The following variables are made available to build header/footer templates:

Example uses of these variables in the templates:

There are also other Velocity constructs that can be used. For reference, see Velocity User Guide.

This class is dependent on:

Here is an example of how to define this custom step in the TCC configuration file.

Author:
Romain Guay - Taleo Corporation

Field Summary
 
Fields inherited from class com.taleo.integration.client.customstep.BaseCustomStep
parameterNames
 
Fields inherited from class com.taleo.integration.client.step.BaseCustomStep
parameters
 
Fields inherited from class com.taleo.integration.client.step.BaseStep
commType, ERROR_NULL_GLOBAL_CONFIG, ERROR_NULL_PIPELINE, ERROR_NULL_STEP_CONFIG, productCode, tempFolder, type, version
 
Constructor Summary
ExportHeaderFooterPostStep()
           
 
Method Summary
protected  org.apache.velocity.VelocityContext createContext(java.io.File file, java.io.File targetFile)
          Create the Velocity context with the given file and the target results file.
 void execute(com.taleo.ws.integration.client.Pipeline pipeline)
           
 java.lang.String getDescription()
           
 java.lang.String getIdentifier()
           
 java.lang.String getName()
           
 
Methods inherited from class com.taleo.integration.client.customstep.csv.BaseHeaderFooterPostStep
execute, execute, getFooterTemplate, getFooterTemplateFile, getHeaderTemplate, getHeaderTemplateFile, init, setFooterTemplate, setFooterTemplateFile, setHeaderTemplate, setHeaderTemplateFile, writeFooter, writeHeader
 
Methods inherited from class com.taleo.integration.client.customstep.csv.BaseCustomCsvPostStep
getSupportedPipeline
 
Methods inherited from class com.taleo.integration.client.customstep.csv.BaseCustomCsvStep
getColumnIndex, getColumnName, getCsvDelimiter, getCsvQuoteCharacter, isCsvHeaderPresent, setCsvDelimiter, setCsvHeaderPresent, setCsvQuoteCharacter
 
Methods inherited from class com.taleo.integration.client.customstep.BaseCustomStep
createTempFile, createTempFile, getEncoding, getTempFolder, isActive, registerParameterName, setActive, setEncoding, validateParameterNames
 
Methods inherited from class com.taleo.integration.client.step.BaseCustomStep
getType, init
 
Methods inherited from class com.taleo.integration.client.step.BaseStep
getAllProcessSupportPipeline, getCurrentFile, getCurrentFile, getCurrentMessage, getPostProcessSupportPipeline, getPreProcessSupportPipeline, isOriginalFile, validateLastStepType, validateMessageType, validatePipeline
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.taleo.integration.client.step.Step
validatePipeline
 

Constructor Detail

ExportHeaderFooterPostStep

public ExportHeaderFooterPostStep()
Method Detail

getDescription

public java.lang.String getDescription()
Specified by:
getDescription in interface com.taleo.integration.client.step.CustomStep
Specified by:
getDescription in interface com.taleo.integration.client.step.Step
Specified by:
getDescription in class com.taleo.integration.client.step.BaseCustomStep

getIdentifier

public java.lang.String getIdentifier()
Specified by:
getIdentifier in interface com.taleo.integration.client.step.CustomStep
Specified by:
getIdentifier in interface com.taleo.integration.client.step.Step
Specified by:
getIdentifier in class com.taleo.integration.client.step.BaseCustomStep

getName

public java.lang.String getName()
Specified by:
getName in interface com.taleo.integration.client.step.CustomStep
Specified by:
getName in interface com.taleo.integration.client.step.Step
Specified by:
getName in class com.taleo.integration.client.step.BaseCustomStep

execute

public void execute(com.taleo.ws.integration.client.Pipeline pipeline)
             throws com.taleo.integration.client.step.StepException
Specified by:
execute in interface com.taleo.integration.client.step.Step
Overrides:
execute in class BaseCustomCsvStep
Throws:
com.taleo.integration.client.step.StepException

createContext

protected org.apache.velocity.VelocityContext createContext(java.io.File file,
                                                            java.io.File targetFile)
                                                     throws java.io.IOException
Create the Velocity context with the given file and the target results file.

Specified by:
createContext in class BaseHeaderFooterPostStep
Parameters:
file - The file containing the data before adding the header and footer.
targetFile - The target results file for this integration.
Returns:
The Velocity context.
Throws:
java.io.IOException