Package fr.ens.biologie.genomique.eoulsan.core

Class SimpleInputPort

java.lang.Object

fr.ens.biologie.genomique.eoulsan.core.AbstractPort

fr.ens.biologie.genomique.eoulsan.core.SimpleInputPort

All Implemented Interfaces:

InputPort, Port, Serializable

public class SimpleInputPort
extends AbstractPort
implements InputPort, Serializable

This class define an input port of a step.

Since:

2.0

Author:

Laurent Jourdren

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SimpleInputPort(String name, boolean list, DataFormat format, EnumSet<fr.ens.biologie.genomique.kenetre.io.CompressionType> compressionsAccepted, boolean requiredInWorkingDirectory)	Constructor.
protected	SimpleInputPort(String name, DataFormat format, EnumSet<fr.ens.biologie.genomique.kenetre.io.CompressionType> compressionsAccepted, boolean requiredInWorkingDirectory)	Constructor.

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.
String	toString()

Methods inherited from class fr.ens.biologie.genomique.eoulsan.core.AbstractPort

getFormat, getLinkedSteps, getName, isList

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.ens.biologie.genomique.eoulsan.core.Port

getFormat, getLinkedSteps, getName, isList

Constructor Detail

SimpleInputPort

protected SimpleInputPort(String name,
                          DataFormat format,
                          EnumSet<fr.ens.biologie.genomique.kenetre.io.CompressionType> compressionsAccepted,
                          boolean requiredInWorkingDirectory)

Constructor.

Parameters:

name - name of the port

format - format of the port

compressionsAccepted - compression accepted

requiredInWorkingDirectory - if data is required in working directory

SimpleInputPort

protected SimpleInputPort(String name,
                          boolean list,
                          DataFormat format,
                          EnumSet<fr.ens.biologie.genomique.kenetre.io.CompressionType> compressionsAccepted,
                          boolean requiredInWorkingDirectory)

Constructor.

Parameters:

name - name of the port

list - true if a list is excepted as port value

format - format of the port

compressionsAccepted - compression accepted

requiredInWorkingDirectory - if data is required in working directory

Method Detail

getCompressionsAccepted

public EnumSet<fr.ens.biologie.genomique.kenetre.io.CompressionType> getCompressionsAccepted()

Description copied from interface: InputPort

Test if the port accept a compressed input format.

Specified by:

getCompressionsAccepted in interface InputPort

Returns:

a set with the compression type allowed by the step for the port

isRequiredInWorkingDirectory

public boolean isRequiredInWorkingDirectory()

Description copied from interface: InputPort

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.

Specified by:

isRequiredInWorkingDirectory in interface InputPort

Returns:

true if the input data need to be copied in the working directory.

toString

public String toString()

Overrides:

toString in class Object