com.asakusafw.vocabulary.batch

Class WorkDescription

java.lang.Object

com.asakusafw.vocabulary.batch.WorkDescription

Direct Known Subclasses:

JobFlowWorkDescription, ScriptWorkDescription

public abstract class WorkDescription
extends Object

A description of Unit-of-Work in batch.

See Also:

Work, BatchDescription

Constructor Summary

Constructors

Constructor and Description
WorkDescription()

Method Summary

Modifier and Type	Method and Description
abstract String	getName() Returns the identifier of this work.
protected static boolean	isValidName(String name) Returns whether the name is valid identifier or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkDescription

public WorkDescription()

Method Detail

getName

public abstract String getName()

Returns the identifier of this work.

The ID must be identical in the batch, and its name can be following format:

Name :
    NameStart NamePart*
NameStart: one of
    A-Z
    a-z
    _
NamePart: one of
    NameStart
    0-9

Returns:

the ID of this work

isValidName

protected static boolean isValidName(String name)

Returns whether the name is valid identifier or not.

Parameters:

name - the name

Returns:

true if the name is valid identifier, or false if it is not valid