com.asakusafw.vocabulary.directio

Class DirectFileInputDescription

java.lang.Object

com.asakusafw.vocabulary.directio.DirectFileInputDescription

All Implemented Interfaces:

ImporterDescription

public abstract class DirectFileInputDescription
extends Object
implements ImporterDescription

An abstract super class that describes a direct input source. Each subclass must satisfy following requirements:

• declared as public
• not declared as abstract
• not declared type parameters
• not declared any explicit constructors

Since:

0.2.5

Version:

0.7.3

Nested Class Summary

Nested classes/interfaces inherited from interface com.asakusafw.vocabulary.external.ImporterDescription

ImporterDescription.DataSize

Constructor Summary

Constructors

Constructor and Description
DirectFileInputDescription()

Method Summary

Modifier and Type	Method and Description
abstract String	getBasePath() Returns the base path of target input.
Class<? extends DataFilter<?>>	getFilter() Returns an implementation of DataFilter class.
abstract Class<? extends DataFormat<?>>	getFormat() Returns an implementation of DataFormat class.
abstract String	getResourcePattern() Returns the resource path pattern of target input.
boolean	isOptional() Returns whether the target input is optional or not.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.asakusafw.vocabulary.external.ImporterDescription

getDataSize, getModelType

Constructor Detail

DirectFileInputDescription

public DirectFileInputDescription()

Method Detail

getBasePath

public abstract String getBasePath()

Returns the base path of target input. On testing, the target path will be deleted by the framework. This path can include variables as ${<variable-name>}.

Returns:

target base path

getResourcePattern

public abstract String getResourcePattern()

Returns the resource path pattern of target input. The framework will search for input files using this pattern from the base path. The pattern can include following characters:

• normal characters
  • just represents a path
  • excepts "\", "*", "$", "?", "#", "|", "{", "}", "[", "]"
• {alter1|alter2|alter3} (selection)
  • represents selection
  • each alternative must be consist of normal characters (NO wildcards, variables)
• ${variable-name} (variables)
  • replaced in runtime with barch arguments
• * (wildcard character)
  • represents wildcard of file/directory name
• ** (wildcard segment)
  • represents all directories and files includes sub directories and files
  • this must be an alternative of file/directory name; for example, **.csv is NOT accepted (**/*.csv instead)

Examples of Resource Pattern

Expression	Description
a/b/c.csv	just a/b/c.csv
{2011/12|2012/01|2012/02}/*.csv	any CSV files in "2011/12", "2012/01", or "2012/02"
*	any files in target directory
**	any files in target directory (recursive)
*.csv	any CSV files in target directory
**/*.csv	any CSV files in target directory (recursive)

Returns:

the resource path pattern

See Also:

FilePattern

getFormat

public abstract Class<? extends DataFormat<?>> getFormat()

Returns an implementation of DataFormat class.

Returns:

DataFormat implementation

getFilter

public Class<? extends DataFilter<?>> getFilter()

Returns an implementation of DataFilter class.

Returns:

DataFilter implementation, or null if filter is not required

Since:

0.7.3

isOptional

public boolean isOptional()

Returns whether the target input is optional or not. Optional input allow executing jobs even if there are no files for the input.

Returns:

true if the target input is optional, otherwise false

Since:

0.6.1