com.bowstreet.builders.webapp.methods
Class BuilderHelperUtil

java.lang.Object
  com.bowstreet.builders.webapp.methods.BuilderHelperUtil

All Implemented Interfaces:

com.bowstreet.builders.webapp.foundation.PhaseCompleteObserver

public class BuilderHelperUtil
extends java.lang.Object
implements com.bowstreet.builders.webapp.foundation.PhaseCompleteObserver

Builder helper utility class. Use this to create a helper LJO with support for indirect references and properties. The helper class must extend BuilderHelper.

Constructor Summary

BuilderHelperUtil(WebApp webApp, java.lang.String helperName, java.lang.String className, BuilderInputs builderInputs)
Constructor - This is used by builder during regen.

Method Summary

void	addIndirectReference(java.lang.String name, java.lang.String runtimeType) Builders can call this during regen to add indirect references that can be requested during execution (using getIndirectValue method).
void	addIndirectReference(java.lang.String name, java.lang.String referenceValue, java.lang.String runtimeType) Builders can call this during regen to add indirect references that can be requested during execution (using getIndirectValue method).
java.lang.Object	callReferenceResolver(WebAppAccess webAppAccess, java.lang.String name) Fetches an indirect value during execution.
java.lang.Object	getHelperProperty(java.lang.String propertyName) Return a property value, which must have been set during regen using setHelperProperty.
void	phaseCompleted()
void	setHelperProperty(java.lang.String propertyName) Initializes a property in the helper LJO.
void	setHelperProperty(java.lang.String propertyName, java.lang.Object inputValue) Initializes a property in the helper LJO.
java.lang.String	toString() Override toString, to show generated reference resolver map in WebApp view

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BuilderHelperUtil

public BuilderHelperUtil(WebApp webApp,
                         java.lang.String helperName,
                         java.lang.String className,
                         BuilderInputs builderInputs)

Constructor - This is used by builder during regen.

Parameters:

webApp - The WebApp object under construction

helperName - The name to use for the helper LJO

className - The classname for the helper LJO (must extend BuilderHelper)

builderInputs - The BuilderInputs for this builder call

Method Detail

addIndirectReference

public void addIndirectReference(java.lang.String name,
                                 java.lang.String runtimeType)

Builders can call this during regen to add indirect references that can be requested during execution (using getIndirectValue method). This gets the specified input directly from the builder inputs.

Parameters:

name - Name of the builder input, also used later as the argument to getIndirectValue.

runtimeType - The runtime type of the reference (e.g. String, IXml, etc.)

addIndirectReference

public void addIndirectReference(java.lang.String name,
                                 java.lang.String referenceValue,
                                 java.lang.String runtimeType)

Builders can call this during regen to add indirect references that can be requested during execution (using getIndirectValue method).

Parameters:

name - Name that will be used to fetch the value (using getIndirectValue).

referenceValue - The indirect reference String input.

runtimeType - The runtime type of the reference (e.g. String, IXml, etc.)

callReferenceResolver

public java.lang.Object callReferenceResolver(WebAppAccess webAppAccess,
                                              java.lang.String name)

Fetches an indirect value during execution. Value must have been added during regen using addIndirectReference. This is called automatically by the BuilderHelper code and should generally not be called by builders directly.

Parameters:

webAppAccess - The WebAppAccess

name - The name of the indirect reference

Returns:

The value of the reference

getHelperProperty

public java.lang.Object getHelperProperty(java.lang.String propertyName)

Return a property value, which must have been set during regen using setHelperProperty.

Parameters:

propertyName - The property name.

Returns:

The property value.

phaseCompleted

public void phaseCompleted()

Specified by:

phaseCompleted in interface com.bowstreet.builders.webapp.foundation.PhaseCompleteObserver

setHelperProperty

public void setHelperProperty(java.lang.String propertyName)

Initializes a property in the helper LJO. The property value comes from the builder input of the same name. The property can be retrieved using getProperty from the builder helper LJO.

Parameters:

propertyName - The builder input name and property name.

setHelperProperty

public void setHelperProperty(java.lang.String propertyName,
                              java.lang.Object inputValue)

Initializes a property in the helper LJO. The property value is passed as an argument. The property can be retrieved using getProperty from the builder helper LJO.

Parameters:

propertyName - The property name.

inputValue - The property value.

toString

public java.lang.String toString()

Override toString, to show generated reference resolver map in WebApp view

Overrides:

toString in class java.lang.Object