org.apache.shale.clay.config
Class Globals

java.lang.Object
  org.apache.shale.clay.config.Globals

public class Globals
extends Object

A Globals contains static constants used throughout the clay plug-in.

Field Summary

static String	ADD_ACTION_LISTENER_COMMAND_NAME This command is invoked to add a actionListener to a component that implements the ActionSource interface.
static String	ADD_COMPONENT_COMMAND_NAME The command name used to add a component.
static String	ADD_CONVERTER_COMMAND_NAME This command is invoked to add a converter to a component implementing the ValueHolder interface.
static String	ADD_VALIDATOR_COMMAND_NAME This command is invoked to add a validator to a component implementing the EditableValueHolder interface.
static String	ADD_VALUE_CHANGE_LISTENER_COMMAND_NAME This command is invoked to add a valueChangeListener to a component that implements the EditableValueHolder interface.
static String	AUTO_RELOAD_CLAY_FILES The name of the initialization parameter defined in the web deployment descriptor that's value will determine if the configuration files defined by CLAY_CONFIG_FILES will be watched for changes.
static String	BUILDER_CATALOG_NAME The catalog name used by BuilderFactory to define the rules that map an HTML element to a Builder.
static String	BUILDER_RESOURCE_NAME The config file used by the BuilderFactory to assemble the rule finder chain.
static String	CLASSPATH_PREFIX Configuration file prefix, "classpath*:", denotes that the resource should be loaded from the class path versus the context root.
static String	CLAY_CATALOG_NAME The default catalog name used to configure the chain workflow for building the clay subtree from a object graph of metadata.
static String	CLAY_COMMON_CONFIG_FILES Name of the initialization parameter in the web deployment descriptor containing additional registered configuration files.
static String	CLAY_CONFIG_FILES Deprecated. use CLAY_COMMON_CONFIG_FILES
static String	CLAY_CUSTOM_BUILDER_XMLNS The request scope key that will be populated with the unknow namespace when parsing an HTML document.
static String	CLAY_CUSTOMIZATION_CATALOG_NAME The customization catalog name used to configure the chain workflow for building the clay subtree from a object graph of metadata.
static String	CLAY_DEFAULT_HTML_TEMPLATE_SUFFIX The default full html view template suffix identifier if one is not specified.
static String	CLAY_DEFAULT_XML_TEMPLATE_SUFFIX The default full XML template view suffix identifier if one is not specified.
static String	CLAY_FULL_VIEW_RESTORE_IND The key value used as a reqest scope indicator to determine a view has been restored.
static String	CLAY_FULL_VIEW_SUFFIX The key value used to cache the original view suffix in request scope for full clay views.
static String	CLAY_FULLXML_CONFIG_FILES Name of the initialization parameter in the web deployment descriptor containing additional registered configuration files.
static String	CLAY_HTML_CHARSET The name of the initializtion parameter in the web deployment descriptor that defines the default charset for all html templates.
static String	CLAY_HTML_TEMPLATE_SUFFIX The name of the initialization parameter defined in the web deployment descriptor that's value will define a suffix identifier used by the TemplateConfigBean.
static String	CLAY_JSPID_ATTRIBUTE The key value used to store clay's version of the jspid.
static String	CLAY_RESERVED_ATTRIBUTE The clay component attribute name that will capture the ComponentBean representing the root of the subtree.
static String	CLAY_RESOURCE_NAME The config file used by Clay component to load the ADD_COMPONENT_COMMAND_NAME from the CLAY_CATALOG_NAME.
static String	CLAY_XML_TEMPLATE_SUFFIX The name of the initialization parameter defined in the web deployment descriptor that's value will define a suffix identifier used by the TemplateComponentConfigBean.
static String	DEFAULT_CLAY_CONFIG_FILE The default subview configuration file containing the base supported components.
static String	DEFAULT_COMPONENT_CONFIG_WATCHDOG The Map key used by the ComponentConfigBean to identify the ComponentConfigBean.WatchDog for the XML configuration files.
static String	FIND_DEFAULT_BUILDER_COMMAND_NAME Command name in the BUILDER_CATALOG_NAME used to invoke a command chain of rule commands that locates a Builder for the default namespace.
static String	FIND_UNKNOWN_BUILDER_COMMAND_NAME Command name in the BUILDER_CATALOG_NAME used to invoke a command chain of rule commands that locates a Builder for a unknown namespace.
static String	MANAGED_BEAN_MNEMONIC EL properties will replaced the literal value of this constant with the mapped ViewController bean before the expression is evaluated.
static String	RUNTIME_ELEMENT_ID The literal string used to identify that a clay subtree should be built at runtime.
static String	SET_ATTRIBUTE_COMMAND_NAME Chain subchain command invoked by the AssignPropertiesCommand to assign the attributes to the components.

Constructor Summary

Globals()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

MANAGED_BEAN_MNEMONIC

public static final String MANAGED_BEAN_MNEMONIC

EL properties will replaced the literal value of this constant with the mapped ViewController bean before the expression is evaluated.

See Also:

Constant Field Values

CLAY_CONFIG_FILES

public static final String CLAY_CONFIG_FILES

Deprecated. use CLAY_COMMON_CONFIG_FILES

Name of the initialization param in the web deployment descriptor containing additional registered config files. The list of files should be comma delimited and the path relative to the context root.
The configuration files should conform to the clay-config_x_x.dtd

See Also:

Constant Field Values

CLAY_COMMON_CONFIG_FILES

public static final String CLAY_COMMON_CONFIG_FILES

Name of the initialization parameter in the web deployment descriptor containing additional registered configuration files. These files represent common component definitions that are not full view XML templates. Common component definitions should have jsfid's that don't have a ".xml" or ".html" suffix. The list of files should be comma delimited and the path relative to the context root.
The configuration files should conform to the clay-config_x_x.dtd.

See Also:

Constant Field Values

CLAY_FULLXML_CONFIG_FILES

public static final String CLAY_FULLXML_CONFIG_FILES

Name of the initialization parameter in the web deployment descriptor containing additional registered configuration files. These files represent common component definitions that are full view XML templates. The list of files should be comma delimited and the path relative to the context root.
The configuration files should conform to the clay-config_x_x.dtd.

See Also:

Constant Field Values

CLAY_HTML_TEMPLATE_SUFFIX

public static final String CLAY_HTML_TEMPLATE_SUFFIX

The name of the initialization parameter defined in the web deployment descriptor that's value will define a suffix identifier used by the TemplateConfigBean. This suffix identifies a jsfid that uses HTML to define page composition.

See Also:

Constant Field Values

CLAY_XML_TEMPLATE_SUFFIX

public static final String CLAY_XML_TEMPLATE_SUFFIX

The name of the initialization parameter defined in the web deployment descriptor that's value will define a suffix identifier used by the TemplateComponentConfigBean. This suffix identifies a jsfid that uses full XML views to define page composition.

See Also:

Constant Field Values

AUTO_RELOAD_CLAY_FILES

public static final String AUTO_RELOAD_CLAY_FILES

The name of the initialization parameter defined in the web deployment descriptor that's value will determine if the configuration files defined by CLAY_CONFIG_FILES will be watched for changes. The default value is true meaning that the config files will be automatically reloaded if a change occures.

See Also:

Constant Field Values

CLAY_DEFAULT_HTML_TEMPLATE_SUFFIX

public static final String CLAY_DEFAULT_HTML_TEMPLATE_SUFFIX

The default full html view template suffix identifier if one is not specified. Override using the CLAY_HTML_TEMPLATE_SUFFIX web init param parameter.

See Also:

Constant Field Values

CLAY_DEFAULT_XML_TEMPLATE_SUFFIX

public static final String CLAY_DEFAULT_XML_TEMPLATE_SUFFIX

The default full XML template view suffix identifier if one is not specified. Override using the CLAY_HTML_TEMPLATE_SUFFIX web init param parameter.

See Also:

Constant Field Values

CLASSPATH_PREFIX

public static final String CLASSPATH_PREFIX

Configuration file prefix, "classpath*:", denotes that the resource should be loaded from the class path versus the context root.

See Also:

Constant Field Values

CLAY_HTML_CHARSET

public static final String CLAY_HTML_CHARSET

The name of the initializtion parameter in the web deployment descriptor that defines the default charset for all html templates. If not specified, the "file.encoding" system parameter is the default. The charset can be overridden for each template file using a special comment directive, "<!-- ### clay:page charset="UTF-8" /### -->".

See Also:

Constant Field Values

DEFAULT_CLAY_CONFIG_FILE

public static final String DEFAULT_CLAY_CONFIG_FILE

The default subview configuration file containing the base supported components.

See Also:

Constant Field Values

RUNTIME_ELEMENT_ID

public static final String RUNTIME_ELEMENT_ID

The literal string used to identify that a clay subtree should be built at runtime. This value "RUNTIME" will be placed in the jsfid attribute. The subtree construction should be build by providing implementation for the "shapeValidator" component event.

See Also:

Constant Field Values

CLAY_CATALOG_NAME

public static final String CLAY_CATALOG_NAME

The default catalog name used to configure the chain workflow for building the clay subtree from a object graph of metadata.

See Also:

Constant Field Values

CLAY_CUSTOMIZATION_CATALOG_NAME

public static final String CLAY_CUSTOMIZATION_CATALOG_NAME

The customization catalog name used to configure the chain workflow for building the clay subtree from a object graph of metadata.

See Also:

Constant Field Values

SET_ATTRIBUTE_COMMAND_NAME

public static final String SET_ATTRIBUTE_COMMAND_NAME

Chain subchain command invoked by the AssignPropertiesCommand to assign the attributes to the components. There are five subcommands under this chain that handle the associated attributes.

See Also:

Constant Field Values

ADD_COMPONENT_COMMAND_NAME

public static final String ADD_COMPONENT_COMMAND_NAME

The command name used to add a component. There are several subchains that will be invoked. This command is invoked recursively for each child component.

See Also:

Constant Field Values

ADD_CONVERTER_COMMAND_NAME

public static final String ADD_CONVERTER_COMMAND_NAME

This command is invoked to add a converter to a component implementing the ValueHolder interface.

See Also:

Constant Field Values

ADD_VALIDATOR_COMMAND_NAME

public static final String ADD_VALIDATOR_COMMAND_NAME

This command is invoked to add a validator to a component implementing the EditableValueHolder interface.

See Also:

Constant Field Values

ADD_VALUE_CHANGE_LISTENER_COMMAND_NAME

public static final String ADD_VALUE_CHANGE_LISTENER_COMMAND_NAME

This command is invoked to add a valueChangeListener to a component that implements the EditableValueHolder interface.

See Also:

Constant Field Values

ADD_ACTION_LISTENER_COMMAND_NAME

public static final String ADD_ACTION_LISTENER_COMMAND_NAME

This command is invoked to add a actionListener to a component that implements the ActionSource interface.

See Also:

Constant Field Values

BUILDER_CATALOG_NAME

public static final String BUILDER_CATALOG_NAME

The catalog name used by BuilderFactory to define the rules that map an HTML element to a Builder.

See Also:

Constant Field Values

FIND_DEFAULT_BUILDER_COMMAND_NAME

public static final String FIND_DEFAULT_BUILDER_COMMAND_NAME

Command name in the BUILDER_CATALOG_NAME used to invoke a command chain of rule commands that locates a Builder for the default namespace.

See Also:

Constant Field Values

FIND_UNKNOWN_BUILDER_COMMAND_NAME

public static final String FIND_UNKNOWN_BUILDER_COMMAND_NAME

Command name in the BUILDER_CATALOG_NAME used to invoke a command chain of rule commands that locates a Builder for a unknown namespace.

See Also:

Constant Field Values

CLAY_RESOURCE_NAME

public static final String CLAY_RESOURCE_NAME

The config file used by Clay component to load the ADD_COMPONENT_COMMAND_NAME from the CLAY_CATALOG_NAME.

See Also:

Constant Field Values

BUILDER_RESOURCE_NAME

public static final String BUILDER_RESOURCE_NAME

The config file used by the BuilderFactory to assemble the rule finder chain.

See Also:

Constant Field Values

DEFAULT_COMPONENT_CONFIG_WATCHDOG

public static final String DEFAULT_COMPONENT_CONFIG_WATCHDOG

The Map key used by the ComponentConfigBean to identify the ComponentConfigBean.WatchDog for the XML configuration files.

See Also:

Constant Field Values

CLAY_FULL_VIEW_SUFFIX

public static final String CLAY_FULL_VIEW_SUFFIX

The key value used to cache the original view suffix in request scope for full clay views.

See Also:

Constant Field Values

CLAY_FULL_VIEW_RESTORE_IND

public static final String CLAY_FULL_VIEW_RESTORE_IND

The key value used as a reqest scope indicator to determine a view has been restored.

See Also:

Constant Field Values

CLAY_RESERVED_ATTRIBUTE

public static final String CLAY_RESERVED_ATTRIBUTE

The clay component attribute name that will capture the ComponentBean representing the root of the subtree. The root is capture for enhanced error reporting.

See Also:

Constant Field Values

CLAY_CUSTOM_BUILDER_XMLNS

public static final String CLAY_CUSTOM_BUILDER_XMLNS

The request scope key that will be populated with the unknow namespace when parsing an HTML document. Custom builders can be registed by the namespace uri by the commons chains.

For example:
<catalog name="clayCustomization" >
<chain name="http://www.acme.com/jsf/mywidgets">
<command className="org.apache.shale.clay.parser.builder.chain.JsfDefaultBuilderRule" prefix="w"/>
</chain>

See Also:

Constant Field Values

CLAY_JSPID_ATTRIBUTE

public static final String CLAY_JSPID_ATTRIBUTE

The key value used to store clay's version of the jspid. This custom id is added to the UIComponent's attributes map.

See Also:

Constant Field Values

Constructor Detail

Globals

public Globals()