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

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.AbstractSortStep
                      extended by com.taleo.integration.client.customstep.csv.HierarchicalSortStep
All Implemented Interfaces:
com.taleo.integration.client.step.CustomStep, com.taleo.integration.client.step.Step

public class HierarchicalSortStep
extends AbstractSortStep

Processing step to sort CSV data based on parent/child relationship.

This step takes all parameters from its base class AbstractSortStep and the following additional parameters:

Record key does not have to be unique, many rows with the same key will be sorted equal. However, two rows with the same key but different parents, will cause an error.

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
HierarchicalSortStep()
          Constructor without arguments.
 
Method Summary
protected  java.util.Comparator getComparator(java.io.File file)
          Get the comparator for the CSV rows.
 java.lang.String getDescription()
           
 java.lang.String getIdentifier()
           
 java.lang.String getKeyField()
          Get the key field.
 java.lang.String getName()
           
 java.lang.String getParentKeyField()
          Get the parent key field.
 void init(com.taleo.ws.integration.client.GlobalConfig config)
           
 boolean isTopDown()
          Get the topDown flag.
 void setKeyField(java.lang.String keyField)
          Set the key field.
 void setParentKeyField(java.lang.String parentKeyField)
          Set the parent key field.
 void setTopDown(boolean topDown)
          Set the topDown flag.
 
Methods inherited from class com.taleo.integration.client.customstep.csv.AbstractSortStep
execute, execute
 
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
getSupportedPipeline, 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

HierarchicalSortStep

public HierarchicalSortStep()
Constructor without arguments.

Method Detail

getKeyField

public java.lang.String getKeyField()
Get the key field.

Returns:

setKeyField

public void setKeyField(java.lang.String keyField)
Set the key field.

Parameters:
keyField -

getParentKeyField

public java.lang.String getParentKeyField()
Get the parent key field.

Returns:

setParentKeyField

public void setParentKeyField(java.lang.String parentKeyField)
Set the parent key field.

Parameters:
parentKeyField -

isTopDown

public boolean isTopDown()
Get the topDown flag.

Returns:

setTopDown

public void setTopDown(boolean topDown)
Set the topDown flag.

Parameters:
topDown -

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

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

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

init

public void init(com.taleo.ws.integration.client.GlobalConfig config)
Overrides:
init in class BaseCustomCsvStep

getComparator

protected java.util.Comparator getComparator(java.io.File file)
                                      throws java.io.IOException,
                                             InvalidCSVFileFormat
Description copied from class: AbstractSortStep
Get the comparator for the CSV rows.

The comparator must take String[] or List as arguments, each representing a CSV row.

Specified by:
getComparator in class AbstractSortStep
Parameters:
file - The CSV file.
Returns:
Throws:
java.io.IOException
InvalidCSVFileFormat