Package com.apgar.common.lib.ui.widget.foreignkeywidget

Class DisplayLinkToForeignKeyUIWidgetFactory

java.lang.Object

com.apgar.common.lib.ui.widget.foreignkeywidget.DisplayLinkToForeignKeyUIWidgetFactory

All Implemented Interfaces:

UIWidgetFactory<DisplayLinkToForeignKeyUIWidget>

public class DisplayLinkToForeignKeyUIWidgetFactory
extends Object
implements UIWidgetFactory<DisplayLinkToForeignKeyUIWidget>

Factory class for creating instances of DisplayLinkToForeignKeyUIWidget.

This factory implements UIWidgetFactory and is responsible for instantiating and setting up DisplayLinkToForeignKeyUIWidget, which draws a link to a foreign key field.

This class is defined as follows under the foreign key field in the XSD.

 <xs:element name="sampleField" minOccurs="0" maxOccurs="1">
     <xs:annotation>
         <xs:documentation xml:lang="en-US">
             <osd:label>Sample Field</osd:label>
         </xs:documentation>
         <xs:appinfo>
             <osd:defaultView>
                 <widget osd:class="com.apgar.common.lib.ui.widget.foreignkeywidget.DisplayLinkToForeignKeyUIWidgetFactory">
                      <branch>dataspaceName</branch>
                      <dataset>datasetName</dataset>
                      <tablePath>tablePath</tablePath>
                 </widget>
             </osd:defaultView>
         </xs:appinfo>
     </xs:annotation>
 </xs:element>
 

Author:

APGAR Consulting

Constructor Summary

Constructors

Constructor	Description
DisplayLinkToForeignKeyUIWidgetFactory()

Method Summary

Modifier and Type	Method	Description
DisplayLinkToForeignKeyUIWidget	newInstance(WidgetFactoryContext pContext)	Creates a new instance of DisplayLinkToForeignKeyUIWidget using the provided WidgetFactoryContext.
void	setBranch(String pBranch)	Sets the branch field which corresponds to the dataspace name of the FK field
void	setDataset(String pDataset)	Sets the dataset field which corresponds to the dataset name of the FK field
void	setTablePath(String pTablePath)	Sets the tablePath field which corresponds to the path of the table containing the foreign key
void	setup(WidgetFactorySetupContext pContext)	Sets up the DisplayLinkToForeignKeyUIWidgetFactory during its initialization phase.

Methods inherited from class java.lang.Object

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

Constructor Details

DisplayLinkToForeignKeyUIWidgetFactory

public DisplayLinkToForeignKeyUIWidgetFactory()

Method Details

newInstance

public DisplayLinkToForeignKeyUIWidget newInstance(WidgetFactoryContext pContext)

Creates a new instance of DisplayLinkToForeignKeyUIWidget using the provided WidgetFactoryContext.

Specified by:

newInstance in interface UIWidgetFactory<DisplayLinkToForeignKeyUIWidget>

Parameters:

pContext - the context providing information necessary for widget creation, including the path to the field that this widget will represent

Returns:

a new instance of DisplayLinkToForeignKeyUIWidget associated with the specified path

setup

public void setup(WidgetFactorySetupContext pContext)

Sets up the DisplayLinkToForeignKeyUIWidgetFactory during its initialization phase.

Specified by:

setup in interface UIWidgetFactory<DisplayLinkToForeignKeyUIWidget>

Parameters:

pContext - the setup context used to alarm in case of missing parameters

setBranch

public void setBranch(String pBranch)

Sets the branch field which corresponds to the dataspace name of the FK field

Parameters:

pBranch - String representing the dataspace name

setDataset

public void setDataset(String pDataset)

Sets the dataset field which corresponds to the dataset name of the FK field

Parameters:

pDataset - String representing the dataset name

setTablePath

public void setTablePath(String pTablePath)

Sets the tablePath field which corresponds to the path of the table containing the foreign key

Parameters:

pTablePath - String representing the table path