org.pentaho.di.core.annotations

Annotation Type Step

@Documented
 @Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface Step

An alternate way of defining steps. Classes annotated with "Step" are automatically recognized and registered as a step. Important: The XML definitions alienate annotated steps and the two methods of definition are therefore mutually exclusive.

Author:

Alex Silva

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	id
String	name

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	casesUrl
String	categoryDescription
String	classLoaderGroup
String	description
String	documentationUrl
String	forumUrl
String	i18nPackageName
String	image
boolean	isSeparateClassLoaderNeeded

Element Detail

id

public abstract String id

Returns:

The ID of the step. You can specify more than one ID in a comma separated format: id1,id2,id3 for deprecation purposes.

name

public abstract String name

description

public abstract String description

Default:

""

image

public abstract String image

Returns:

The image resource path

Default:

""

isSeparateClassLoaderNeeded

public abstract boolean isSeparateClassLoaderNeeded

Returns:

True if a separate class loader is needed every time this class is instantiated

Default:

false

classLoaderGroup

public abstract String classLoaderGroup

Default:

""

categoryDescription

public abstract String categoryDescription

Default:

""

i18nPackageName

public abstract String i18nPackageName

Default:

""

documentationUrl

public abstract String documentationUrl

Returns:

The documentation url

Default:

""

casesUrl

public abstract String casesUrl

Returns:

The cases url

Default:

""

forumUrl

public abstract String forumUrl

Returns:

The forum url

Default:

""