wt.enterprise.tabularresults
Class StdDataFormatService

java.lang.Object
  wt.enterprise.BasicTemplateProcessor
      wt.enterprise.tabularresults.StdDataFormatService

All Implemented Interfaces:

ContextHolder, ContextTranslator, DataFormatService, Evolvable, Externalizable, Serializable, TemplateProcessor

public class StdDataFormatService

extends BasicTemplateProcessor

implements DataFormatService

This is a concrete implementation of the DataFormatService. The current implementation is a little sloppy and ad-hoc. It is designed to be used with the 2.0 release and provide only the required functionality that is needed for the 7 templates that it supports. In the future, it is likely that this class or at least it implementation will be replaced with a PropertyValueDelegate of some sort. Currently, a number of if statements are used to decide how to present a class and any future classes or customization will need to be hardcoded.

Supported API: false

Extensible: false

See Also:

, Serialized Form

Field Summary

private static String	CODEBASE
(package private) Object	contextObj
protected String[]	HTMLFonts
protected String[]	HTMLTextFormats
(package private) Locale	locale
(package private) PrintWriter	out
private static String	RESOURCE
private static boolean	VERBOSE

Fields inherited from class wt.enterprise.BasicTemplateProcessor

ACTION, ADD_HELP_ICON, ALL_CABINETS, BLANK_SPACE, BREAK_SEPARATOR, BREAK_TAG, CLASS, componentFactory, CONTAINER_NAME, CONTENT_RESOURCE, contextClass, DEFAULT_CHARSET, DEFAULT_HELP_ICON_SELECTOR, DEFAULT_HELP_LABEL, DEFAULT_PREFERENCE_CONTEXT, DOCFROMTEMPLATE, ENABLE_HELP_ICON_PROPERTY_NAME, ENTERPRISE_SEARCH, EXTERNALIZATION_VERSION_UID, FEDERATION_SEARCH, GLOBAL_NAVIGATION_ENABLE_HELP_ICON, globalNavBarHelpIconEnabledDefault, HELP_CONTEXT, HELP_ICON_POSITION, HELP_ICON_SELECTOR, HELP_LABEL, HELP_LABEL_RESOURCE, HELP_WINDOW_NAME, helpContext, helpIconEnabled, helpIconEnabledDefault, HOMEPAGE, IDPREFIX, IMPORT, INTEGRATED_SEARCH, isDndMicroAppletEnabled, isDndMicroAppletEnabledInitialized, LABEL_SEPARATOR, LINE_FEED_DELIMITER, linkPrefix, LOCAL_SEARCH, OID, OLD_FORMAT_VERSION_UID, pageContext, PDMLINK_INSTALL_KEY, PERSONAL_CABINET, PREF_WINDOW_NAME, PREFERENCE_CONTEXT, PRESENT_HELP_LABEL, PROJECTLINK_INSTALL_KEY, SEARCH, SHARE_ICON, TEXT_RESOURCE_BUNDLE, URL_RESOURCE, WORKLIST, wtAttribute, WTCORE_IMAGE_DIR

Fields inherited from interface wt.templateutil.processor.ContextTranslator

CONTEXT_LIST_IN, CONTEXT_LIST_OUT

Fields inherited from interface wt.templateutil.processor.ContextHolder

CONTEXT_ACTION, CONTEXT_CLASS_NAME, CONTEXT_OBJ, CONTEXT_PROPERTIES, FORM_DATA, QUERY_DATA, RESPONSE_EXCEPTIONS, RESPONSE_FOOTERS, RESPONSE_HEADERS, RESPONSE_MESSAGES, RESPONSE_STRING, STATUS

Constructor Summary

StdDataFormatService()
Supported API: false

Method Summary

String	addImage(Object imageObj, String label) Supported API: false
String	addLink(Object linkObj, String action, String label) Supported API: false
String	adornBaseData(String baseDataEntry, Object context_obj, Properties properties) Supported API: false
Object	getContextObj() Supported API: false
Locale	getLocale() Supported API: false
String	getTableCell(Object new_context_obj, Locale new_locale, Properties properties) Supported API: false
void	handleRequest(HTTPRequest req, HTTPResponse resp) Required method to extend BasicTemplateProcessor Supported API: false
String	objectPropertyName(Class contextClass, Properties parameters, Locale locale) Supported API: false
String	objectPropertyName(Object contextObj, Properties parameters, Locale locale) Supported API: false
String	objectPropertyName(Properties parameters, Locale locale) Supported API: false
void	printAttributes(Properties parameters, Locale locale, OutputStream os) This call can be made from an HTML template and results in all of the attibrutes of the current context object being printed out, using introspection.
void	setContextObj(Object new_context_obj) Supported API: false
void	setLocale(Locale data_locale) Supported API: false
void	setOutput(PrintWriter data_out) Supported API: false

Methods inherited from class wt.enterprise.BasicTemplateProcessor

AccessOK, addHiddenProperty, addHTMLHelpLink, addToResponseExceptions, addToResponseFooters, addToResponseHeaders, addToResponseMessages, allVersions, bcwti, buildFormProcessorURL, buildFormProcessorURL, comment, createActionsBar, createFederationNavigationBar, createGlobalNavigationBar, createNavigationBar, createParentFolderLink, currentTimestamp, displayAllCabinets, displayAttributeName, displayAttributesTable, displayAttributeValue, displayFolderContents, displayFolderObject, displayFolderTrail, displayGoToLatestLink, displayOrganizationIdentifier, displayPendingChangeIndicator, displayStyleSheetAttributesTable, displayVisualData, formatDate, getActionPairs, getAllCabinetsURL, getBaselineItems, getCharsetEncoding, getCheckedOutFolderURL, getClassIcon, getClassInfo, getContextAction, getContextClass, getContextClassName, getContextListIn, getContextListOut, getContextProperties, getContextServiceName, getDisplayName, getDomainPath, getEnabledVersion, getEncoding, getFederationSearchURL, getFolderLocation, getFolderPath, getFormData, getGenericInstanceIconImgTag, getGlyphImageTag, getGlyphsArray, getGlyphTagsNoDnD, getHelpContext, getHomepageURL, getHTMLComponentFactory, getHTMLHelpLink, getHTMLHelpURL, getHTMLHelpURL, getHTMLTableService, getIconResource, getIconResource, getIconResource, getIconSelector, getId, getJavaScriptManager, getLocalizedDateFormatMessage, getLocalizedMessage, getLocalizedPrintWriter, getLocalizedString, getObjectDnDIcon, getObjectIcon, getObjectIconDnDTag, getObjectIconGlyphs, getObjectIconImgTag, getObjectIconImgTag, getObjectIconImgTag, getObjectIconImgTag, getObjectIconImgTag, getObjectIconImgTag, getObjectPropertyValueString, getObjectPropertyValueString, getPageContext, getParentFolderLink, getPersonalCabinet, getPersonalCabinetURL, getPreferenceValue, getPrincipalEmailLink, getPrincipalEmailLink, getPrintWriter, getPropertyFromPropertyFile, getQuery, getQueryData, getReferenceString, getReferenceString, getResourceString, getResourceString, getResponseExceptions, getResponseFooters, getResponseHeaders, getResponseMessages, getResponseString, getSearchCriteriaURL, getSearchCriteriaURL, getSearchResultsURL, getShareImage, getShareImage, getState, getStatus, getStringFromResourceBundle, getStringFromResourceBundle, getTemplateDisplayGeneral, getTrailId, getTrlIdAttribute, getURLActions, getURLActions, getURLActions, getURLActions, getURLActionsString, getURLActionsString, getURLFactory, getURLFromDelegate, getURLProcessorLink, getURLProcessorLink, getURLProcessorLink, getURLProcessorLinkWithLabel, getUsedByLinks, getWCColor, getWCColor, getWCColorDec, getWCColorDec, getWCFontFamily, getWCFontFamily, getWorklistURL, getWTAttribute, getWTContainerByName, getWTContainerRef, handleExceptionTP, handleExceptionTP, handleProcessorException, hiddenContextString, include, initJavaScriptManager, isDndMicroAppletEnabled, isEqual, listContent, objectActionLink, objectActionLinkAux, objectActionLinkAux, objectActionLinkAux, objectActionLinkAux, objectActionLinkAux, objectActionLinkAux, objectActionLinkAux, objectBackground, objectIdentification, objectIdentifier, objectProperties, objectPropertyName, objectPropertyNameAux, objectPropertyNameAux2, objectPropertyValue, objectPropertyValueAux, objectPropertyValueAux2, objectPropertyValueString, outputLink, outputPropertyFromPropertyFile, parameterValue, partUsedBy, PDMLinkIsInstalled, printQueryTable, printTable, printTextArea, processSubTemplate, readContext, readExternal, readVersion, setColumnProperties, setContextAction, setContextClass, setContextClassName, setContextListIn, setContextListOut, setContextProperties, setFormData, setHelpContext, setHTMLTableService, setJavaScriptManager, setPageContext, setQueryData, setResponseExceptions, setResponseFooters, setResponseHeaders, setResponseMessages, setResponseString, setState, setStatus, showResponseExceptions, showResponseFooters, showResponseHeaders, showResponseMessage, showResponseMessages, showVersions, sortQueryResult, splitStringIntoTokens, tableService, translateToHtml, useProcessorService, visualizationIsEnabled, writeExternal, writeHiddenContext, writeQueryStringContext

Methods inherited from class java.lang.Object

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

Field Detail

CODEBASE

private static String CODEBASE

VERBOSE

private static boolean VERBOSE

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

HTMLTextFormats

protected String[] HTMLTextFormats

HTMLFonts

protected String[] HTMLFonts

locale

Locale locale

out

PrintWriter out

contextObj

Object contextObj

Constructor Detail

StdDataFormatService

public StdDataFormatService()

Supported API: false

Method Detail

setLocale

public void setLocale(Locale data_locale)

Supported API: false

Parameters:

data_locale - The new locale value

getLocale

public Locale getLocale()

Supported API: false

Returns:

Locale

setOutput

public void setOutput(PrintWriter data_out)

Supported API: false

Parameters:

data_out - The PrintWriter stream to the HTTP connnection for the webpage

setContextObj

public void setContextObj(Object new_context_obj)

Supported API: false

Specified by:

setContextObj in interface ContextHolder

Overrides:

setContextObj in class BasicTemplateProcessor

Parameters:

new_context_obj -

getContextObj

public Object getContextObj()

Supported API: false

Specified by:

getContextObj in interface ContextHolder

Overrides:

getContextObj in class BasicTemplateProcessor

Returns:

Object Returns the current context object

getTableCell

public String getTableCell(Object new_context_obj,
                           Locale new_locale,
                           Properties properties)

Supported API: false

Specified by:

getTableCell in interface DataFormatService

Parameters:

new_context_obj - The contect object that will drive the presentation

new_locale - The new locale to determine location sensitive output

properties - The parameters that will determine what is output and how it is output

Returns:

String a String that contains the HTML to place in an HTML Table Cell

addLink

public String addLink(Object linkObj,
                      String action,
                      String label)

Supported API: false

Parameters:

linkObj - the object used to create the HTTP parameter "oid"

action - the "action" parameter in the HTTP GET URL

label - The label to present to in the Browser

Returns:

String

addImage

public String addImage(Object imageObj,
                       String label)

Supported API: false

adornBaseData

public String adornBaseData(String baseDataEntry,
                            Object context_obj,
                            Properties properties)

Supported API: false

Parameters:

baseDataEntry - The original string to be modified with additional HTML attributes

context_obj - the object to be used as the "context object"

properties - has the HTML attribute values to be used

Returns:

String has HTML code that has been modfied to have the HTML attributes specified in properties

printAttributes

public void printAttributes(Properties parameters,
                            Locale locale,
                            OutputStream os)
                     throws WTException,
                            PropertyVetoException,
                            InvocationTargetException,
                            IllegalAccessException

This call can be made from an HTML template and results in all of the attibrutes of the current context object being printed out, using introspection. There is also other information provided from the PropertyDescriptor of the attribute.

Supported API: false

Parameters:

parameters -

locale -

os -

Throws:

WTException

PropertyVetoException

InvocationTargetException

IllegalAccessException

handleRequest

public void handleRequest(HTTPRequest req,
                          HTTPResponse resp)
                   throws WTException

Required method to extend BasicTemplateProcessor

Supported API: false

Specified by:

handleRequest in interface TemplateProcessor

Parameters:

req -

resp -

Throws:

WTException

objectPropertyName

public String objectPropertyName(Properties parameters,
                                 Locale locale)

Supported API: false

objectPropertyName

public String objectPropertyName(Object contextObj,
                                 Properties parameters,
                                 Locale locale)

Supported API: false

objectPropertyName

public String objectPropertyName(Class contextClass,
                                 Properties parameters,
                                 Locale locale)

Supported API: false