com.bowstreet.builders.webapp.api
Class LookupTable

java.lang.Object
  com.bowstreet.builders.BaseBuilderAPI
      com.bowstreet.builders.webapp.api.LookupTable

public class LookupTable
extends com.bowstreet.builders.BaseBuilderAPI

High-level builder for accessing lookup table data (tables with name/value pairs)
Note: this is a builder API wrapper class, intended to be called by the regen logic of a builder. It can be used to programmatically add a call to the LookupTable builder to a model.

Nested Class Summary

static interface

LookupTable.BuilderStaticValues Constant values imported from the builder definition file.

Constructor Summary

LookupTable(BuilderCall parent, GenContext gc)

Method Summary

boolean	getAddBlankSelection() Add a blank selection to the list of choices.
IXml	getAdditionalLabelsValues() Specify additional label/value pairs to be included in the lookup table Legal values: UseOriginalValue (Use Original Value), UseThisValue (Use This Value)
java.lang.String	getAdditionalXmlData() The indirect reference that provides additional XML data to augment the lookup table content defined above
java.lang.String	getConcurrency() The concurrency mode for the ResultSet, if any, generated by the statement Legal values: (), ReadOnly (Read Only), Updatable (Updatable)
java.lang.String	getDataServiceData() Specify a DataService Operation that provides the XML data for the lookup table content
java.lang.String	getDataServiceLabelElementName() The name of the SQL column or XML element that contains labels for the lookup table
java.lang.String	getDataServiceValueElementName() The name of the SQL column or XML element that contains values for the lookup table
java.lang.String	getDataType() What type of lookup table to use for this builder Legal values: DatabaseQuery (Database Query), XmlData (XML Data), NewXmlData (New XML Data), DataServiceData (Data Service)
java.lang.String	getGetDataFrom() Specifies where the builder is to find the additional label/value pairs Legal values: BuilderInput (Builder Input), XmlData (XML Data)
java.lang.String	getLabelElementName() The name of the SQL column or XML element that contains labels for the lookup table
java.lang.String	getLabelValueFilterMode() Choose how to filter data based on presence of the label and/or value elements Legal values: None (None: use all elements), LabelValue (Use elements with both label and value elements)
java.lang.String	getName() Specify name of this builder call (required and must contain only alphanumeric characters and underscores)
java.lang.String	getNewXmlData() The XML data to be used for the lookup table
java.lang.String	getParentElementName() The name of the XML element (defaults to "UserAddition") to be used for new label/value pairs added to the table.
java.lang.String	getRefreshInterval() Enter the time in seconds that the data used for the lookup table should be retained in the cache (leave blank to disable caching)
java.lang.String	getScrollType() The type of ResultSet, if any, generated by the statement Legal values: (), Forward (Forward), Insensitive (Insensitive), Sensitive (Sensitive)
java.lang.String	getSqlDataSource() Name of the JDBC DataSource for which to build the Lookup Table Legal values:
java.lang.String	getSqlStatement() SQL statement to generate the lookup table (for example, "SELECT DISTINCT id, state_name from STATE")
java.lang.String	getTablePosition() Where new pairs are placed in the lookup table (the default is in front of original pairs) Legal values: InFront (In Front), InBack (In Back)
java.lang.String	getValueElementName() The name of the SQL column or XML element that contains values for the lookup table
java.lang.String	getValueSet() Enter either comma-delimited text or a reference to an XML list or comma-delimited text.
java.lang.String	getVariableType() VariableType Legal values: ValueTagLabelTag (Value Tag and Label Tag), ResourceBundle (Resource Bundle Style)
java.lang.String	getXmlData() The indirect reference that provides the XML data for the lookup table content
void	initializeBuilderInputs()
void	setAddBlankSelection(boolean value) Add a blank selection to the list of choices.
void	setAdditionalLabelsValues(IXml value) Specify additional label/value pairs to be included in the lookup table Legal values: UseOriginalValue (Use Original Value), UseThisValue (Use This Value)
void	setAdditionalXmlData(java.lang.String value) The indirect reference that provides additional XML data to augment the lookup table content defined above
void	setConcurrency(java.lang.String value) The concurrency mode for the ResultSet, if any, generated by the statement Legal values: (), ReadOnly (Read Only), Updatable (Updatable)
void	setDataServiceData(java.lang.String value) Specify a DataService Operation that provides the XML data for the lookup table content
void	setDataServiceLabelElementName(java.lang.String value) The name of the SQL column or XML element that contains labels for the lookup table
void	setDataServiceValueElementName(java.lang.String value) The name of the SQL column or XML element that contains values for the lookup table
void	setDataType(java.lang.String value) What type of lookup table to use for this builder Legal values: DatabaseQuery (Database Query), XmlData (XML Data), NewXmlData (New XML Data), DataServiceData (Data Service)
void	setGetDataFrom(java.lang.String value) Specifies where the builder is to find the additional label/value pairs Legal values: BuilderInput (Builder Input), XmlData (XML Data)
void	setLabelElementName(java.lang.String value) The name of the SQL column or XML element that contains labels for the lookup table
void	setLabelValueFilterMode(java.lang.String value) Choose how to filter data based on presence of the label and/or value elements Legal values: None (None: use all elements), LabelValue (Use elements with both label and value elements)
void	setName(java.lang.String value) Specify name of this builder call (required and must contain only alphanumeric characters and underscores)
void	setNewXmlData(java.lang.String value) The XML data to be used for the lookup table
void	setParentElementName(java.lang.String value) The name of the XML element (defaults to "UserAddition") to be used for new label/value pairs added to the table.
void	setRefreshInterval(java.lang.String value) Enter the time in seconds that the data used for the lookup table should be retained in the cache (leave blank to disable caching)
void	setScrollType(java.lang.String value) The type of ResultSet, if any, generated by the statement Legal values: (), Forward (Forward), Insensitive (Insensitive), Sensitive (Sensitive)
void	setSqlDataSource(java.lang.String value) Name of the JDBC DataSource for which to build the Lookup Table Legal values:
void	setSqlStatement(java.lang.String value) SQL statement to generate the lookup table (for example, "SELECT DISTINCT id, state_name from STATE")
void	setTablePosition(java.lang.String value) Where new pairs are placed in the lookup table (the default is in front of original pairs) Legal values: InFront (In Front), InBack (In Back)
void	setValueElementName(java.lang.String value) The name of the SQL column or XML element that contains values for the lookup table
void	setValueSet(java.lang.String value) Enter either comma-delimited text or a reference to an XML list or comma-delimited text.
void	setVariableType(java.lang.String value) VariableType Legal values: ValueTagLabelTag (Value Tag and Label Tag), ResourceBundle (Resource Bundle Style)
void	setXmlData(java.lang.String value) The indirect reference that provides the XML data for the lookup table content

Methods inherited from class com.bowstreet.builders.BaseBuilderAPI

getBuilderCall, getBuilderInputs, invokeBuilder, invokeBuilderBC, setBuilderInputs

Methods inherited from class java.lang.Object

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

Constructor Detail

LookupTable

public LookupTable(BuilderCall parent,
                   GenContext gc)

Method Detail

getAddBlankSelection

public boolean getAddBlankSelection()

Add a blank selection to the list of choices.

getAdditionalLabelsValues

public IXml getAdditionalLabelsValues()

Specify additional label/value pairs to be included in the lookup table
Legal values: UseOriginalValue (Use Original Value), UseThisValue (Use This Value)

getAdditionalXmlData

public java.lang.String getAdditionalXmlData()

The indirect reference that provides additional XML data to augment the lookup table content defined above

getConcurrency

public java.lang.String getConcurrency()

The concurrency mode for the ResultSet, if any, generated by the statement
Legal values: (), ReadOnly (Read Only), Updatable (Updatable)

getDataServiceData

public java.lang.String getDataServiceData()

Specify a DataService Operation that provides the XML data for the lookup table content

getDataServiceLabelElementName

public java.lang.String getDataServiceLabelElementName()

The name of the SQL column or XML element that contains labels for the lookup table

getDataServiceValueElementName

public java.lang.String getDataServiceValueElementName()

The name of the SQL column or XML element that contains values for the lookup table

getDataType

public java.lang.String getDataType()

What type of lookup table to use for this builder
Legal values: DatabaseQuery (Database Query), XmlData (XML Data), NewXmlData (New XML Data), DataServiceData (Data Service)

getGetDataFrom

public java.lang.String getGetDataFrom()

Specifies where the builder is to find the additional label/value pairs
Legal values: BuilderInput (Builder Input), XmlData (XML Data)

getLabelElementName

public java.lang.String getLabelElementName()

The name of the SQL column or XML element that contains labels for the lookup table

getLabelValueFilterMode

public java.lang.String getLabelValueFilterMode()

Choose how to filter data based on presence of the label and/or value elements
Legal values: None (None: use all elements), LabelValue (Use elements with both label and value elements)

getName

public java.lang.String getName()

Specify name of this builder call (required and must contain only alphanumeric characters and underscores)

getNewXmlData

public java.lang.String getNewXmlData()

The XML data to be used for the lookup table

getParentElementName

public java.lang.String getParentElementName()

The name of the XML element (defaults to "UserAddition") to be used for new label/value pairs added to the table.

getRefreshInterval

public java.lang.String getRefreshInterval()

Enter the time in seconds that the data used for the lookup table should be retained in the cache (leave blank to disable caching)

getScrollType

public java.lang.String getScrollType()

The type of ResultSet, if any, generated by the statement
Legal values: (), Forward (Forward), Insensitive (Insensitive), Sensitive (Sensitive)

getSqlDataSource

public java.lang.String getSqlDataSource()

Name of the JDBC DataSource for which to build the Lookup Table
Legal values:

getSqlStatement

public java.lang.String getSqlStatement()

SQL statement to generate the lookup table (for example, "SELECT DISTINCT id, state_name from STATE")

getTablePosition

public java.lang.String getTablePosition()

Where new pairs are placed in the lookup table (the default is in front of original pairs)
Legal values: InFront (In Front), InBack (In Back)

getValueElementName

public java.lang.String getValueElementName()

The name of the SQL column or XML element that contains values for the lookup table

getValueSet

public java.lang.String getValueSet()

Enter either comma-delimited text or a reference to an XML list or comma-delimited text.

getVariableType

public java.lang.String getVariableType()

VariableType
Legal values: ValueTagLabelTag (Value Tag and Label Tag), ResourceBundle (Resource Bundle Style)

getXmlData

public java.lang.String getXmlData()

The indirect reference that provides the XML data for the lookup table content

initializeBuilderInputs

public void initializeBuilderInputs()

Overrides:

initializeBuilderInputs in class com.bowstreet.builders.BaseBuilderAPI

setAddBlankSelection

public void setAddBlankSelection(boolean value)

Add a blank selection to the list of choices.

setAdditionalLabelsValues

public void setAdditionalLabelsValues(IXml value)

Specify additional label/value pairs to be included in the lookup table
Legal values: UseOriginalValue (Use Original Value), UseThisValue (Use This Value)

setAdditionalXmlData

public void setAdditionalXmlData(java.lang.String value)

The indirect reference that provides additional XML data to augment the lookup table content defined above

setConcurrency

public void setConcurrency(java.lang.String value)

The concurrency mode for the ResultSet, if any, generated by the statement
Legal values: (), ReadOnly (Read Only), Updatable (Updatable)

setDataServiceData

public void setDataServiceData(java.lang.String value)

Specify a DataService Operation that provides the XML data for the lookup table content

setDataServiceLabelElementName

public void setDataServiceLabelElementName(java.lang.String value)

The name of the SQL column or XML element that contains labels for the lookup table

setDataServiceValueElementName

public void setDataServiceValueElementName(java.lang.String value)

The name of the SQL column or XML element that contains values for the lookup table

setDataType

public void setDataType(java.lang.String value)

What type of lookup table to use for this builder
Legal values: DatabaseQuery (Database Query), XmlData (XML Data), NewXmlData (New XML Data), DataServiceData (Data Service)

setGetDataFrom

public void setGetDataFrom(java.lang.String value)

Specifies where the builder is to find the additional label/value pairs
Legal values: BuilderInput (Builder Input), XmlData (XML Data)

setLabelElementName

public void setLabelElementName(java.lang.String value)

The name of the SQL column or XML element that contains labels for the lookup table

setLabelValueFilterMode

public void setLabelValueFilterMode(java.lang.String value)

Choose how to filter data based on presence of the label and/or value elements
Legal values: None (None: use all elements), LabelValue (Use elements with both label and value elements)

setName

public void setName(java.lang.String value)

Specify name of this builder call (required and must contain only alphanumeric characters and underscores)

setNewXmlData

public void setNewXmlData(java.lang.String value)

The XML data to be used for the lookup table

setParentElementName

public void setParentElementName(java.lang.String value)

The name of the XML element (defaults to "UserAddition") to be used for new label/value pairs added to the table.

setRefreshInterval

public void setRefreshInterval(java.lang.String value)

Enter the time in seconds that the data used for the lookup table should be retained in the cache (leave blank to disable caching)

setScrollType

public void setScrollType(java.lang.String value)

The type of ResultSet, if any, generated by the statement
Legal values: (), Forward (Forward), Insensitive (Insensitive), Sensitive (Sensitive)

setSqlDataSource

public void setSqlDataSource(java.lang.String value)

Name of the JDBC DataSource for which to build the Lookup Table
Legal values:

setSqlStatement

public void setSqlStatement(java.lang.String value)

SQL statement to generate the lookup table (for example, "SELECT DISTINCT id, state_name from STATE")

setTablePosition

public void setTablePosition(java.lang.String value)

Where new pairs are placed in the lookup table (the default is in front of original pairs)
Legal values: InFront (In Front), InBack (In Back)

setValueElementName

public void setValueElementName(java.lang.String value)

The name of the SQL column or XML element that contains values for the lookup table

setValueSet

public void setValueSet(java.lang.String value)

Enter either comma-delimited text or a reference to an XML list or comma-delimited text.

setVariableType

public void setVariableType(java.lang.String value)

VariableType
Legal values: ValueTagLabelTag (Value Tag and Label Tag), ResourceBundle (Resource Bundle Style)

setXmlData

public void setXmlData(java.lang.String value)

The indirect reference that provides the XML data for the lookup table content