org.dlese.dpc.schemedit.autoform

Class RendererHelper

java.lang.Object

org.dlese.dpc.schemedit.autoform.RendererHelper

public class RendererHelper
extends java.lang.Object

Manages global rhelper information for a Renderer Instance as well as providing a renderer factory for instantiating new renderer objects.

See Renderer and it's concrete subclasses.

Author:

ostwald

Field Summary

Fields

Modifier and Type	Field and Description
int	counter Keeps track of number of Renderer instantiations to guard against infinite loops
static int	DEFAULT_TEXT_INPUT_SIZE
boolean	showElementDebugInfo Causes debugging information about each element to be shown in editor
boolean	showLabelDebugInfo Causes debugging information about the element labels to be shown in editor

Constructor Summary

Constructors

Constructor and Description
RendererHelper(org.dom4j.Element root, MetaDataFramework framework, java.lang.String formBeanName) Constructor for the RendererHelper object
RendererHelper(org.dom4j.Element root, MetaDataFramework framework, java.lang.String formBeanName, java.lang.String renderer) Constructor for the RendererHelper object with renderer class name explicitly specified.

Method Summary

Modifier and Type	Method and Description
org.dom4j.Element	acceptsNewChioceTest(java.lang.String path) NOT YET DOCUMENTED
org.dom4j.Element	acceptsNewSiblingTest(java.lang.String path) NOT YET DOCUMENTED
void	attachElementDebugInfo(org.dom4j.Element target, java.lang.String displayText, java.lang.String borderColor) NOT YET DOCUMENTED
void	attachMessages(org.dom4j.Element container, java.lang.String xpath) Description of the Method
void	attachToolHelp(org.dom4j.Element e, java.lang.String helpMsg) Attach a pop-up tool help message to an element
void	destroy() NOT YET DOCUMENTED
void	embedDebugInfo(org.dom4j.Element e, java.lang.String s) NOT YET DOCUMENTED
static java.lang.String	encodeIndexId(java.lang.String xpath) Given a "siblingPath" (xpath with no indexing on leaf node), create a javascript variable to use for indexed elements.
int	getBaseLevel() Gets the baseLevel attribute of the RendererHelper object.
FieldInfoReader	getFieldInfo(java.lang.String xpath) returns the FieldInfoReader for the given xpath, or null if one does not exist
java.lang.String	getFormBeanName() Gets the formBeanName attribute of the RendererHelper object
MetaDataFramework	getFramework() Gets the framework attribute of the RendererHelper object
java.lang.String	getInputHelperFile(java.lang.String xpath) Returns the configured inputHelper value for the provided xpath (inputHelper value is relative to the /editor/input_helper directory in the deployed app
int	getMaxLen(java.lang.String xpath) Gets the maxLen attribute of the RendererHelper object
RendererImpl	getRenderer(java.lang.String xpath, org.dom4j.Element parent) Renderer factory returns a Renderer instance for the schemaNode at xpath.
RendererImpl	getRenderer(java.lang.String xpath, org.dom4j.Element parent, GlobalDef typeDef) Renderer factory returns a Renderer instance for the schemaNode at xpath, possibly with a "proxy dataType" (if provided) that will override the dataType associated with the schemaNode.
java.lang.String	getRendererClassName() Gets the rendererClassName attribute of the RendererHelper object
org.dom4j.Element	getRoot() Gets the root attribute of the RendererHelper object
SchemaHelper	getSchemaHelper() Gets the schemaHelper attribute of the RendererHelper object
java.lang.String	getToolHelp(java.lang.String s) Attempts to return a metadata vocab field definition for the input string assuming it is an xpath.
boolean	hasFieldInfo(java.lang.String xpath) Description of the Method
boolean	hasInputHelper(java.lang.String xpath) Returns true if the provided path is configured with an inputHelper
boolean	hasMuiGroupInfo(java.lang.String xpath) Return if there is Mui Grouping Information available for this field.
boolean	hasVocabLayout(java.lang.String xpath) NOT YET DOCUMENTED
static org.dom4j.Element	jspInclude(java.lang.String page) NOT YET DOCUMENTED
static java.lang.String	jspQuotedString(java.lang.String s) returns the input string surrounded by a string that is replaced with a quotation mark when the rendered Element is writen to disk.
org.dom4j.Element	nodeExistsTest(java.lang.String path) Creates a test for the existence of a node in the instance document at the given path
org.dom4j.Element	nodeHasChildrenTest(java.lang.String path) NOT YET DOCUMENTED
org.dom4j.Element	nodeHasMembersTest(java.lang.String path) NOT YET DOCUMENTED
org.dom4j.Element	nodeHasNoMembersTest(java.lang.String path) NOT YET DOCUMENTED
org.dom4j.Element	nodeNotExistsTest(java.lang.String path) Creates an element that tests for the NON-existence of an instance document node at the given path
static java.lang.String	normalizeXPath(java.lang.String encodedXPpath) Removes any and all indexing information from an XPath.
org.dom4j.Element	parentNodeExistsTest(java.lang.String xpath) Creates a test for the existance of the parentNode of the node being rendered
org.dom4j.Element	parentNodeNotExistsTest(java.lang.String xpath) NOT YET DOCUMENTED
static void	setDebug(boolean bool) Sets the debug attribute of the RendererHelper class
void	setFormBeanName(java.lang.String beanName) Sets the formBeanName attribute of the RendererHelper object
static void	setLogging(boolean verbose) Sets the logging attribute of the RendererHelper class
org.dom4j.Element	viewNodeTest(java.lang.String xpath) Used by the viewing classes (not the editing classes) to test that a node exists and has content.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TEXT_INPUT_SIZE

public static final int DEFAULT_TEXT_INPUT_SIZE

See Also:

Constant Field Values

showElementDebugInfo

public boolean showElementDebugInfo

Causes debugging information about each element to be shown in editor

showLabelDebugInfo

public boolean showLabelDebugInfo

Causes debugging information about the element labels to be shown in editor

counter

public int counter

Keeps track of number of Renderer instantiations to guard against infinite loops

Constructor Detail

RendererHelper

public RendererHelper(org.dom4j.Element root,
                      MetaDataFramework framework,
                      java.lang.String formBeanName,
                      java.lang.String renderer)

Constructor for the RendererHelper object with renderer class name explicitly specified. Used by View Renders, such as EditorViewerRenderer, for which the renderer cannot be obtained from the MetaDataFramework.

Parameters:

root - Description of the Parameter

framework - Description of the Parameter

formBeanName - Description of the Parameter

renderer - Description of the Parameter

RendererHelper

public RendererHelper(org.dom4j.Element root,
                      MetaDataFramework framework,
                      java.lang.String formBeanName)

Constructor for the RendererHelper object

Parameters:

root - root Element to be rendered

framework - MetaDataFramework representing the XML Schema to be used

formBeanName - Description of the Parameter

Method Detail

attachElementDebugInfo

public void attachElementDebugInfo(org.dom4j.Element target,
                                   java.lang.String displayText,
                                   java.lang.String borderColor)

NOT YET DOCUMENTED

Parameters:

target - NOT YET DOCUMENTED

displayText - NOT YET DOCUMENTED

borderColor - NOT YET DOCUMENTED

embedDebugInfo

public void embedDebugInfo(org.dom4j.Element e,
                           java.lang.String s)

NOT YET DOCUMENTED

Parameters:

e - NOT YET DOCUMENTED

s - NOT YET DOCUMENTED

getRenderer

public final RendererImpl getRenderer(java.lang.String xpath,
                                      org.dom4j.Element parent)

Renderer factory returns a Renderer instance for the schemaNode at xpath.

Parameters:

xpath - xpath for node to be rendered

parent - parent element to which to attach rendered node

Returns:

The renderer value

getRenderer

public final RendererImpl getRenderer(java.lang.String xpath,
                                      org.dom4j.Element parent,
                                      GlobalDef typeDef)

Renderer factory returns a Renderer instance for the schemaNode at xpath, possibly with a "proxy dataType" (if provided) that will override the dataType associated with the schemaNode.

Parameters:

xpath - xpath for node to be rendered

parent - parent element to which to attach rendered node

typeDef - NOT YET DOCUMENTED

Returns:

The renderer value

normalizeXPath

public static java.lang.String normalizeXPath(java.lang.String encodedXPpath)

Removes any and all indexing information from an XPath. In particular, cleans up any JSP-encoding, including curly bracketed indexing (e.g., ${indexId+1}). This form of XPath is necessary for accessing schemaNodes, which contain no indexing.

Parameters:

encodedXPpath - Description of the Parameter

Returns:

Xpath duitable for finding a SchemaNode

getRendererClassName

public java.lang.String getRendererClassName()

Gets the rendererClassName attribute of the RendererHelper object

Returns:

The rendererClassName value

getMaxLen

public int getMaxLen(java.lang.String xpath)

Gets the maxLen attribute of the RendererHelper object

Parameters:

xpath - NOT YET DOCUMENTED

Returns:

The maxLen value

getFormBeanName

public java.lang.String getFormBeanName()

Gets the formBeanName attribute of the RendererHelper object

Returns:

The formBeanName value

setFormBeanName

public void setFormBeanName(java.lang.String beanName)

Sets the formBeanName attribute of the RendererHelper object

Parameters:

beanName - The new formBeanName value

getSchemaHelper

public SchemaHelper getSchemaHelper()

Gets the schemaHelper attribute of the RendererHelper object

Returns:

The schemaHelper value

getFramework

public MetaDataFramework getFramework()

Gets the framework attribute of the RendererHelper object

Returns:

The framework value

getRoot

public org.dom4j.Element getRoot()

Gets the root attribute of the RendererHelper object

Returns:

The root value

hasMuiGroupInfo

public boolean hasMuiGroupInfo(java.lang.String xpath)

Return if there is Mui Grouping Information available for this field. Mui Group Information is specified in the groups files of the MetadataVocab object, and stored in the MetaDataFramework object.

Parameters:

xpath - NOT YET DOCUMENTED

Returns:

NOT YET DOCUMENTED

hasVocabLayout

public boolean hasVocabLayout(java.lang.String xpath)

NOT YET DOCUMENTED

Parameters:

xpath - NOT YET DOCUMENTED

Returns:

NOT YET DOCUMENTED

hasFieldInfo

public boolean hasFieldInfo(java.lang.String xpath)

Description of the Method

Parameters:

xpath - Description of the Parameter

Returns:

Description of the Return Value

getFieldInfo

public FieldInfoReader getFieldInfo(java.lang.String xpath)

returns the FieldInfoReader for the given xpath, or null if one does not exist

Parameters:

xpath - Description of the Parameter

Returns:

The fieldInfo value

hasInputHelper

public boolean hasInputHelper(java.lang.String xpath)

Returns true if the provided path is configured with an inputHelper

Parameters:

xpath - NOT YET DOCUMENTED

Returns:

NOT YET DOCUMENTED

getInputHelperFile

public java.lang.String getInputHelperFile(java.lang.String xpath)

Returns the configured inputHelper value for the provided xpath (inputHelper value is relative to the /editor/input_helper directory in the deployed app

Parameters:

xpath - NOT YET DOCUMENTED

Returns:

The inputHelperFile value

getBaseLevel

public int getBaseLevel()

Gets the baseLevel attribute of the RendererHelper object. The baseLevel determines at which level in the schema we are rendering for the individual pages.

Returns:

The baseLevel value

encodeIndexId

public static final java.lang.String encodeIndexId(java.lang.String xpath)

Given a "siblingPath" (xpath with no indexing on leaf node), create a javascript variable to use for indexed elements. Replace colons in index id with underscore to avoid javascript problems with qualified names. Then add a string ("Index") and indexId index, if required, to avoid name collisions.

Parameters:

xpath - NOT YET DOCUMENTED

Returns:

NOT YET DOCUMENTED

jspQuotedString

public static final java.lang.String jspQuotedString(java.lang.String s)

returns the input string surrounded by a string that is replaced with a quotation mark when the rendered Element is writen to disk. This is necessary because dom4J turns quotation marks and appostrophies into entities, which then cause the JSP processer to barf when the jsp page is rendered

Parameters:

s - Description of the Parameter

Returns:

Description of the Return Value

jspInclude

public static org.dom4j.Element jspInclude(java.lang.String page)

NOT YET DOCUMENTED

Parameters:

page - NOT YET DOCUMENTED

Returns:

NOT YET DOCUMENTED

parentNodeExistsTest

public org.dom4j.Element parentNodeExistsTest(java.lang.String xpath)

Creates a test for the existance of the parentNode of the node being rendered

Parameters:

xpath - NOT YET DOCUMENTED

Returns:

An Element representing the test for the existance of a parent node

parentNodeNotExistsTest

public org.dom4j.Element parentNodeNotExistsTest(java.lang.String xpath)

NOT YET DOCUMENTED

Parameters:

xpath - NOT YET DOCUMENTED

Returns:

NOT YET DOCUMENTED

nodeExistsTest

public org.dom4j.Element nodeExistsTest(java.lang.String path)

Creates a test for the existence of a node in the instance document at the given path

Parameters:

path - Description of the Parameter

Returns:

Element that performs test when embedded in JSP

nodeHasChildrenTest

public org.dom4j.Element nodeHasChildrenTest(java.lang.String path)

NOT YET DOCUMENTED

Parameters:

path - NOT YET DOCUMENTED

Returns:

NOT YET DOCUMENTED

nodeHasMembersTest

public org.dom4j.Element nodeHasMembersTest(java.lang.String path)

NOT YET DOCUMENTED

Parameters:

path - NOT YET DOCUMENTED

Returns:

NOT YET DOCUMENTED

nodeHasNoMembersTest

public org.dom4j.Element nodeHasNoMembersTest(java.lang.String path)

NOT YET DOCUMENTED

Parameters:

path - NOT YET DOCUMENTED

Returns:

NOT YET DOCUMENTED

acceptsNewSiblingTest

public org.dom4j.Element acceptsNewSiblingTest(java.lang.String path)

NOT YET DOCUMENTED

Parameters:

path - NOT YET DOCUMENTED

Returns:

NOT YET DOCUMENTED

acceptsNewChioceTest

public org.dom4j.Element acceptsNewChioceTest(java.lang.String path)

NOT YET DOCUMENTED

Parameters:

path - NOT YET DOCUMENTED

Returns:

NOT YET DOCUMENTED

nodeNotExistsTest

public org.dom4j.Element nodeNotExistsTest(java.lang.String path)

Creates an element that tests for the NON-existence of an instance document node at the given path

Parameters:

path - Description of the Parameter

Returns:

Element that performs test when embedded in JSP

viewNodeTest

public org.dom4j.Element viewNodeTest(java.lang.String xpath)

Used by the viewing classes (not the editing classes) to test that a node exists and has content.

NOTE: should this method be ABSTRACT here, and only instantiated in DcsView utils?? (it must be at least declared here, since it is referenced from the renderer, which has obtained utils as RenderUtils.

Parameters:

xpath - NOT YET DOCUMENTED

Returns:

NOT YET DOCUMENTED

attachMessages

public void attachMessages(org.dom4j.Element container,
                           java.lang.String xpath)

Description of the Method

Parameters:

container - Description of the Parameter

xpath - NOT YET DOCUMENTED

attachToolHelp

public void attachToolHelp(org.dom4j.Element e,
                           java.lang.String helpMsg)

Attach a pop-up tool help message to an element

Parameters:

e - The element to recieve the tool help

helpMsg - Description of the Parameter

getToolHelp

public java.lang.String getToolHelp(java.lang.String s)

Attempts to return a metadata vocab field definition for the input string assuming it is an xpath. The field definition is obtained from a FieldInfoReader for the xpath. If a FieldInfoReader cannot be found, return the input string (encoded so whether an xpath or a regular string, there won't be a javascript error)..

Parameters:

s - A string that may or may not corrrespond to a field that has metadata-vocab definition information

Returns:

A string to be used as ToolHelp which is the metadata field definition if possible.

setLogging

public static void setLogging(boolean verbose)

Sets the logging attribute of the RendererHelper class

Parameters:

verbose - The new logging value

destroy

public void destroy()

NOT YET DOCUMENTED

setDebug

public static void setDebug(boolean bool)

Sets the debug attribute of the RendererHelper class

Parameters:

bool - The new debug value