InputPort (Eoulsan 2.7.1 API)

All Superinterfaces:: Port

All Known Implementing Classes:: SimpleInputPort

public interface InputPort extends Port

This interface define an input port of a step.

Since:: 2.0
Author:: Laurent Jourdren

Method Summary

Modifier and Type

Method

Description

EnumSet<fr.ens.biologie.genomique.kenetre.io.CompressionType>

getCompressionsAccepted()

Test if the port accept a compressed input format.

boolean

isRequiredInWorkingDirectory()

Test if input data of the port is required in the working directory.

Methods inherited from interface fr.ens.biologie.genomique.eoulsan.core.Port
getFormat, getLinkedSteps, getName, isList

Method Details
- getCompressionsAccepted
  
  EnumSet<fr.ens.biologie.genomique.kenetre.io.CompressionType> getCompressionsAccepted()
  
  Test if the port accept a compressed input format.
  
  Returns:
  
  a set with the compression type allowed by the step for the port
- isRequiredInWorkingDirectory
  
  boolean isRequiredInWorkingDirectory()
  
  Test if input data of the port is required in the working directory. This method allow to declare the input data that need to be copied in the working directory before starting the step. As an example, it is used to copy files from a local file system to a distributed file system like HDFS. After that mapreduce jobs can be efficiency launched.
  
  Returns:
  
  true if the input data need to be copied in the working directory.