com.asakusafw.vocabulary.directio

Class DirectFileOutputDescription

java.lang.Object

com.asakusafw.vocabulary.directio.DirectFileOutputDescription

All Implemented Interfaces:

ExporterDescription

public abstract class DirectFileOutputDescription
extends Object
implements ExporterDescription

An abstract super class that describes a direct output target. 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.4.0

Constructor Summary

Constructors

Constructor and Description
DirectFileOutputDescription()

Method Summary

Modifier and Type	Method and Description
abstract String	getBasePath() Returns the base path of target output.
List<String>	getDeletePatterns() Returns the resource path pattern to delete before output.
abstract Class<? extends DataFormat<?>>	getFormat() Returns an implementation of DataFormat class.
List<String>	getOrder() Returns record order in each output file.
abstract String	getResourcePattern() Returns the resource path pattern of target output.

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.ExporterDescription

getModelType

Constructor Detail

DirectFileOutputDescription

public DirectFileOutputDescription()

Method Detail

getBasePath

public abstract String getBasePath()

Returns the base path of target output. On testing, the target path will be deleted by the framework. In the same jobflow, other inputs or output must not contain this path. This path can include variables as ${<variable-name>}.

Returns:

target base path

getResourcePattern

public abstract String getResourcePattern()

Returns the resource path pattern of target output. The framework will output files using this pattern on the base path. The pattern can include following characters:

• normal characters
  • just represents a path
  • excepts "\", "$", "*", "?", "#", "|", "{", "}", "[", "]"
• ${variable-name} (variables)
  • replaced in runtime with barch arguments
• {<property-name>} (placeholders)
  • generates path fragment from the specified property
  • each property name should be represented in snake_case
• [<lower-bound>..<upper-bound>] (random-number)
  • generates a random number between lower-bound and upper-bound (inclusive)
  • this muset be 0 <= lower-bound < upper-bound
• * (wildcard)
  • generates a random string from execution context
  • IMPORTANT: If there are wildcard in resource pattern, you CANNOT use neither placeholders nor random-numbers. Additionally getOrder() must be returns empty list.

This path can include variables as ${<variable-name>}, but replacement can only contains normal characters.

Returns:

the resource path pattern

getOrder

public List<String> getOrder()

Returns record order in each output file. Each element is in form of +<property-name> or -<property-name>, and each property name should be represented in snake_case.

Returns:

record order

getDeletePatterns

public List<String> getDeletePatterns()

Returns the resource path pattern to delete before output. The framework will delete files using this pattern on the base path. Each pattern can include following characters:

• normal characters
  • just represents a path
  • excepts "\", "$", "*", "?", "#", "|", "{", "}", "[", "]"
• ${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)

Returns:

the list of delete patterns

Since:

0.4.0

getFormat

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

Returns an implementation of DataFormat class.

Returns:

the class of DataFormat