com.uwyn.rife.engine.annotations
Annotation Type Elem

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

Declares that a Java class is a RIFE element.

If id() isn't specified, the short class name (without the package) will be used as the element's ID. The ID will be interpreted relative to the ID of the sub-site in which the element is defined.

For example, a site with ID MY.SITE, and an element with class mypackage.FooStuff, will result in the following absolute ID for the element: MY.SITE.FooStuff.

If url() isn't specified, the lower-case short class name will be used. For example the class mypackage.FooStuff, will result in the foostuff URL.

Since:

1.5

Version:

$Revision: 3634 $

Author:

Geert Bevin (gbevin[remove] at uwyn dot com)

Optional Element Summary

Autolink[]	autolinks This element's auto links.
ChildTrigger[]	childTriggers This element's child triggers.
String	contentType The content type of this element's output.
Datalink[]	datalinks This element's data links.
Exit[]	exits This element's exits.
Flowlink[]	flowlinks This element's flow links.
String	id The ID of this element.
InBean[]	inbeans This element's input beans.
InCookie[]	incookies This element's incookies.
Class	inheritsClass The Java class of the element whose behavior should be inherited.
String	inheritsClassIdPrefix The prefix that will be added to the inheritsClass ID.
String	inheritsId The ID of the element whose behavior should be inherited.
Input[]	inputs This element's inputs.
OutBean[]	outbeans This element's output beans.
OutCookie[]	outcookies This element's outcookies.
Output[]	outputs This element's outputs.
Pathinfo	pathinfo This element's pathinfo specifications.
Class	preClass The Java class of the element that should precede this element.
String	preClassIdPrefix The prefix that will be added to the preClass ID.
String	preId The ID of the element that should precede this element.
Submission[]	submissions This element's submissions.
String	url The URL of this element.

id

public abstract String id

The ID of this element.

If the ID isn't specified, a default will be generated based on the short class name. See the class documentation for more information.

Since:

1.5

Default:

""

url

public abstract String url

The URL of this element.

If the URL isn't specified, a default will be generated based on the lower-cased short class name. See the class documentation for more information.

To explicit specify that no URL should be used, provide an empty string.

Since:

1.5

Default:

"[default url]"

inheritsId

public abstract String inheritsId

The ID of the element whose behavior should be inherited.

If inheritsClass is provided, it will override the inheritsId value.

Since:

1.5

See Also:

inheritsClass()

Default:

""

inheritsClass

public abstract Class inheritsClass

The Java class of the element whose behavior should be inherited. This class should at least have an Elem annotation.

If inheritsClass is provided, it will override the inheritsId value.

The ID will be evaluated locally to the current subsite. If you have to refer to an ID in another subsite, you have to use the inheritsClassIdPrefix().

Since:

1.5

See Also:

inheritsId(), inheritsClassIdPrefix()

Default:

void.class

inheritsClassIdPrefix

public abstract String inheritsClassIdPrefix

The prefix that will be added to the inheritsClass ID.

This makes it possible to refer to an ID in another subsite. Note that this prefix is not validated individually, it is merely added as a string to build the final ID that will be used.

Since:

1.5

See Also:

inheritsClass()

Default:

""

preId

public abstract String preId

The ID of the element that should precede this element.

If preClass is provided, it will override the preId value.

Since:

1.5

See Also:

preClass()

Default:

""

preClass

public abstract Class preClass

The Java class of the element that should precede this element. This class should at least have an Elem annotation.

If preClass is provided, it will override the preId value.

The ID will be evaluated locally to the current subsite. If you have to refer to an ID in another subsite, you have to use the preClassIdPrefix().

Since:

1.5

See Also:

preId(), preClassIdPrefix()

Default:

void.class

preClassIdPrefix

public abstract String preClassIdPrefix

The prefix that will be added to the preClass ID.

This makes it possible to refer to an ID in another subsite. Note that this prefix is not validated individually, it is merely added as a string to build the final ID that will be used.

Since:

1.5

See Also:

preClass()

Default:

""

contentType

public abstract String contentType

The content type of this element's output. By default this will be whatever is specified by RifeConfig.Engine.getDefaultContentType()

If you want to use a dynamic content type, set it to an empty string ("") here, and use ElementSupport.setContentType(String) during the element logic.

Since:

1.5

Default:

"[default content type]"

inputs

public abstract Input[] inputs

This element's inputs.

Since:

1.5

Default:

{}

inbeans

public abstract InBean[] inbeans

This element's input beans.

Since:

1.5

Default:

{}

incookies

public abstract InCookie[] incookies

This element's incookies.

Since:

1.5

Default:

{}

outputs

public abstract Output[] outputs

This element's outputs.

Since:

1.5

Default:

{}

outbeans

public abstract OutBean[] outbeans

This element's output beans.

Since:

1.5

Default:

{}

outcookies

public abstract OutCookie[] outcookies

This element's outcookies.

Since:

1.5

Default:

{}

submissions

public abstract Submission[] submissions

This element's submissions.

Since:

1.5

Default:

{}

exits

public abstract Exit[] exits

This element's exits.

Since:

1.5

Default:

{}

childTriggers

public abstract ChildTrigger[] childTriggers

This element's child triggers.

Since:

1.5

Default:

{}

pathinfo

public abstract Pathinfo pathinfo

This element's pathinfo specifications.

Since:

1.5

Default:

@com.uwyn.rife.engine.annotations.Pathinfo(mappings={})

flowlinks

public abstract Flowlink[] flowlinks

This element's flow links.

Since:

1.5

Default:

{}

datalinks

public abstract Datalink[] datalinks

This element's data links.

Since:

1.5

Default:

{}

autolinks

public abstract Autolink[] autolinks

This element's auto links.

Since:

1.5.1

Default:

{}