cascading.tap.type

Interface FileType<Config>

All Known Implementing Classes:

BasePartitionTap, FileAdaptorTap

public interface FileType<Config>

Interface FileType marks specific platform Tap classes as representing a file like interface.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CASCADING_SOURCE_PATH

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getChildIdentifiers(Config conf) Method getChildIdentifiers returns an array of child identifiers if this resource is a directory.
java.lang.String[]	getChildIdentifiers(Config conf, int depth, boolean fullyQualified) Method getChildIdentifiers returns an array of child identifiers if this resource is a directory.
java.lang.String[]	getChildIdentifiers(FlowProcess<? extends Config> flowProcess) Method getChildIdentifiers returns an array of child identifiers if this resource is a directory.
java.lang.String[]	getChildIdentifiers(FlowProcess<? extends Config> flowProcess, int depth, boolean fullyQualified) Method getChildIdentifiers returns an array of child identifiers if this resource is a directory.
long	getSize(Config conf) Method getSize returns the size of the file referenced by this tap.
long	getSize(FlowProcess<? extends Config> flowProcess) Method getSize returns the size of the file referenced by this tap.
boolean	isDirectory(Config conf) Method isDirectory returns true if the underlying resource represents a directory or folder instead of an individual file.
boolean	isDirectory(FlowProcess<? extends Config> flowProcess) Method isDirectory returns true if the underlying resource represents a directory or folder instead of an individual file.

Field Detail

CASCADING_SOURCE_PATH

static final java.lang.String CASCADING_SOURCE_PATH

See Also:

Constant Field Values

Method Detail

isDirectory

boolean isDirectory(FlowProcess<? extends Config> flowProcess)
             throws java.io.IOException

Method isDirectory returns true if the underlying resource represents a directory or folder instead of an individual file.

Parameters:

flowProcess -

Returns:

boolean

Throws:

java.io.IOException

isDirectory

boolean isDirectory(Config conf)
             throws java.io.IOException

Method isDirectory returns true if the underlying resource represents a directory or folder instead of an individual file.

Parameters:

conf - of Conf

Returns:

boolean

Throws:

java.io.IOException

getChildIdentifiers

java.lang.String[] getChildIdentifiers(FlowProcess<? extends Config> flowProcess)
                                throws java.io.IOException

Method getChildIdentifiers returns an array of child identifiers if this resource is a directory.

This method will skip Hadoop log directories (_log).

Parameters:

flowProcess - of type FlowProcess

Returns:

String[]

Throws:

java.io.IOException

getChildIdentifiers

java.lang.String[] getChildIdentifiers(Config conf)
                                throws java.io.IOException

Method getChildIdentifiers returns an array of child identifiers if this resource is a directory.

This method will skip Hadoop log directories (_log).

Parameters:

conf - of type Conf

Returns:

String[]

Throws:

java.io.IOException

getChildIdentifiers

java.lang.String[] getChildIdentifiers(FlowProcess<? extends Config> flowProcess,
                                       int depth,
                                       boolean fullyQualified)
                                throws java.io.IOException

Method getChildIdentifiers returns an array of child identifiers if this resource is a directory.

This method will skip Hadoop log directories (_log).

Note that all files encountered up to depth will be returned, and no directories unless the directory is the final path at max depth.

Parameters:

flowProcess -

depth -

fullyQualified -

Returns:

String{}

Throws:

java.io.IOException

getChildIdentifiers

java.lang.String[] getChildIdentifiers(Config conf,
                                       int depth,
                                       boolean fullyQualified)
                                throws java.io.IOException

Method getChildIdentifiers returns an array of child identifiers if this resource is a directory.

This method will skip Hadoop log directories (_log).

Note that all files encountered up to depth will be returned, and no directories unless the directory is the final path at max depth.

Parameters:

conf - of type Conf

depth - the max depth to return.

fullyQualified - true if the returned paths should be fully qualified

Returns:

String[]

Throws:

java.io.IOException

getSize

long getSize(FlowProcess<? extends Config> flowProcess)
      throws java.io.IOException

Method getSize returns the size of the file referenced by this tap.

Parameters:

flowProcess -

Returns:

The size of the file reference by this tap.

Throws:

java.io.IOException

getSize

long getSize(Config conf)
      throws java.io.IOException

Method getSize returns the size of the file referenced by this tap.

Parameters:

conf - of type Config

Returns:

The size of the file reference by this tap.

Throws:

java.io.IOException