Package com.softwaremining.ui

Class XMLScreenDefReader

java.lang.Object

com.softwaremining.ui.XMLScreenDefReader

All Implemented Interfaces:

IScreenConstants

Direct Known Subclasses:

HpScreenDefReader, ILEScreenDefReader

public class XMLScreenDefReader
extends Object
implements IScreenConstants

This is helper, designed for reading of XML screen definition from the resources and parsing. For example, for class com.softwaremining.examples.Loan, A XMLScreenDefReader will be constructed for file /com/softwaremining/examples/loan/xml/screens/Loan.xml

Field Summary

Fields inherited from interface com.softwaremining.ui.web.IScreenConstants

SCREEN_ATTRIBUTE__ARRAY_INDEX, SCREEN_ATTRIBUTE__ARRAY_SIZE, SCREEN_ATTRIBUTE__DELIMITOR, SCREEN_ATTRIBUTE__ILE_CHANGE_INDICATOR, SCREEN_ATTRIBUTE__ILE_INPUT_WITH_INICATOR, SCREEN_ATTRIBUTE__INPUT, SCREEN_ATTRIBUTE__LENGTH, SCREEN_ATTRIBUTE__OWNER, SCREEN_ATTRIBUTE__PARAM, SCREEN_ATTRIBUTE__PICTURE, SCREEN_ATTRIBUTE__PRESENT_WHEN, SCREEN_ATTRIBUTE__SUM, SCREEN_ATTRIBUTE__TEXT_FROM, SCREEN_ATTRIBUTE__TO, SCREEN_ATTRIBUTE__TYPE, SCREEN_ATTRIBUTE__USING, SCREEN_ATTRIBUTE__VALUE, SCREEN_JSP_FILE_EXTENTION, SCREEN_XML_FILE_EXTENTION

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	XMLScreenDefReader()
	XMLScreenDefReader(String screenSourceName)	default constructor

Method Summary

Modifier and Type	Method	Description
protected void	addEntryHandler(String tagName, EntryHandler handler)
protected void	addScreenHandler(String tagName, ScreenHandler handler)
protected void	applyEntryHandlers(RequestEntry entry, Element entryTag)
protected RequestEntry	buildRequestEntry(Element entryTag)
protected void	checkInteger(Element tag, RequestEntry entry, int target)
protected RequestEntry	createRequestEntry()
DisplayRequest	getAcceptRequest(String screenName)	List of fields in the Screen.XML which have beed defined as INPUT (or TO)
DisplayRequest	getAllRequest(String screenName)
DisplayRequest	getDisplayRequest(String screenName)	List of fields in the Screen.XML which have been defined by anything other than INPUT - EG Static text from.
protected EntryHandler	getEntryHandler(String tagName)
protected Document	getParsedDocument(String screenSourceName)
ScreenDefinition	getScreenDefinition(String _screenName)
String[]	getScreenDefinitionNames()
protected ScreenHandler	getScreenHandler(String tagName)
static String	getScreenXMLFileName(String className, String screenFileName)	Method used internally by SoftwareMining Framework return a fully qualified name of the Screen.XML, e.g /com/softwaremining/examples/xml/screens/Loan.xml
void	processScreenXML(String screenSourceName)
protected void	registerHandlers()	independent screen handlers are constructed for the following elements line, column, entry , image , foreground-color , background-color ...

Methods inherited from class java.lang.Object

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

Constructor Details

XMLScreenDefReader

protected XMLScreenDefReader()

XMLScreenDefReader

public XMLScreenDefReader(String screenSourceName)

default constructor

Parameters:

screenSourceName - - e.g. /com/softwaremining/examples/loan/xml/screens/Loan.xml

owner - - e.g. instance of com.softwaremining.examples.loan.Loan

Method Details

processScreenXML

public void processScreenXML(String screenSourceName)

getParsedDocument

protected Document getParsedDocument(String screenSourceName)

registerHandlers

protected void registerHandlers()

independent screen handlers are constructed for the following elements line, column, entry , image , foreground-color , background-color ...

createRequestEntry

protected RequestEntry createRequestEntry()

addEntryHandler

protected void addEntryHandler(String tagName,
 EntryHandler handler)

getEntryHandler

protected EntryHandler getEntryHandler(String tagName)

addScreenHandler

protected void addScreenHandler(String tagName,
 ScreenHandler handler)

getScreenHandler

protected ScreenHandler getScreenHandler(String tagName)

buildRequestEntry

protected RequestEntry buildRequestEntry(Element entryTag)

applyEntryHandlers

protected void applyEntryHandlers(RequestEntry entry,
 Element entryTag)

checkInteger

protected void checkInteger(Element tag,
 RequestEntry entry,
 int target)

getDisplayRequest

public DisplayRequest getDisplayRequest(String screenName)

List of fields in the Screen.XML which have been defined by anything other than INPUT - EG Static text from.

Parameters:

screenName -

Returns:

getAcceptRequest

public DisplayRequest getAcceptRequest(String screenName)

List of fields in the Screen.XML which have beed defined as INPUT (or TO)

Parameters:

screenName -

Returns:

getAllRequest

public DisplayRequest getAllRequest(String screenName)

getScreenDefinitionNames

public String[] getScreenDefinitionNames()

getScreenDefinition

public ScreenDefinition getScreenDefinition(String _screenName)

getScreenXMLFileName

public static String getScreenXMLFileName(String className,
 String screenFileName)

Method used internally by SoftwareMining Framework return a fully qualified name of the Screen.XML, e.g /com/softwaremining/examples/xml/screens/Loan.xml

Parameters:

className - : name of the baseService: e.g. com.softwaremining.examples.Loan

screenName - : In certain situations (e.g. ILE Screens), the program can different screen. e.g. DDS-SCREEN-1. When not null it causes the method to return /com/softwaremining/examples/xml/screens/DDS-SCREEN-1.xml