sapphire.ext

Class BaseSDCRenderer

java.lang.Object

com.labvantage.sapphire.BaseCustom

com.labvantage.sapphire.modules.configreport.renderer.BaseRenderer

sapphire.ext.BaseSDCRenderer

public class BaseSDCRenderer
extends com.labvantage.sapphire.modules.configreport.renderer.BaseRenderer

Created by IntelliJ IDEA. User: hgurla Date: Dec 4, 2008 Time: 1:21:50 PM To change this template use File | Settings | File Templates.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OPTION_SDC_CATEGORIES
static java.lang.String	OPTION_SDC_DETAILS
static java.lang.String	OPTION_SDC_SUMMARY
static java.lang.String	OPTION_TEMPLATES_ONLY
static java.lang.String	OPTIONID
static java.lang.String	OPTIONTITLE
protected BaseSDCRO	refSdcRO
protected boolean	reportCategories
protected boolean	reportDetails
boolean	reportSDIRoleMatrix Flag indicates whether SDIRoleMatrix is to be included in the report or not
protected boolean	reportSummary
protected boolean	reportTemplatesOnly
protected BaseSDCRO	sdcRO The reference to the RO created by the Controller, that loads the SDI data

Fields inherited from class com.labvantage.sapphire.modules.configreport.renderer.BaseRenderer

applicationRoot, chapterChanged, COLUMN_DISPLAYTITLE, COLUMN_OPTIONNO, COLUMN_SELECTEDVALUE, COLUMN_TYPE, COLUMN_VALUES, COLUMNVALUE_TYPE_DROPDOWN, COLUMNVALUE_TYPE_FOLDER, COLUMNVALUE_TYPE_TEXT, config, connection, database, diffOnly, folder, frames, ignoreDetailsDiffs, ignorePrimaryDiffs, includeDiffReport, refRO, sapphireConnection, sdisIncluded, sectionChangeInfo, sourceRO

Fields inherited from class com.labvantage.sapphire.BaseCustom

FAILURE, logger, logName, SUCCESS

Constructor Summary

Constructors

Constructor and Description
BaseSDCRenderer()

Method Summary

Modifier and Type	Method and Description
boolean	checkIfIgnore(BaseSDCRO sdcRO, BaseSDCRO refSdcRO)
void	createXMLReport()
ConfigReportContent	getCustomSectionContent(java.lang.String customSectionName) If the custom renderer has any non-SDI sections, override this method and return appropriate content for each custom section.
java.util.ArrayList	getCustomSectionNames() If the custom renderer has any non-SDI sections, override this method and return an ArrayList with the section names for the custom sections.
PropertyListCollection	getOptions()
static java.lang.String	getPrimaryValue(SDIData sdiData, java.lang.String columnName)
BaseSDCRO	getReferenceRO()
SDIData	getReferenceSDIData()
java.util.ArrayList	getSDIsIncluded()
ConfigReportContent	getSectionContent(BaseSDCRO sdcRO, BaseSDCRO refSdcRO, TranslationProcessor translationProcessor)
java.util.ArrayList	getSectionList()
java.util.ArrayList	getSectionTitleList()
BaseSDCRO	getSourceRO()
SDIData	getSourceSDIData()
protected ConfigReportContent	getSpecialContent(BaseSDCRO sdcRO, BaseSDCRO refSdcRO, TranslationProcessor translationProcessor)
protected ConfigReportContent	getSpecialContent(BaseSDCRO sdcRO, TranslationProcessor translationProcessor)
protected ConfigReportContent	getSpecialContent(SDIData sdiData, SDIData refSDIData, TranslationProcessor translationProcessor)
protected ConfigReportContent	getSpecialContent(SDIData sdiData, TranslationProcessor translationProcessor)
boolean	hasChapterChanged()
boolean	hasCustomSections() If the custom renderer has any non-SDI sections, override this method and return true
protected boolean	ignoreDiff(java.lang.String currCol)
void	initialize(com.labvantage.sapphire.services.SapphireConnection sapphireConnection, com.labvantage.sapphire.modules.configreport.ro.BaseRO srcRO, com.labvantage.sapphire.modules.configreport.ro.BaseRO refRO)
void	initialize(com.labvantage.sapphire.services.SapphireConnection sapphireConnection, PropertyList config, com.labvantage.sapphire.modules.configreport.ro.BaseRO srcRO, java.util.HashMap sdisIncluded, boolean includeSDIRoleMatrix)
void	initialize(com.labvantage.sapphire.services.SapphireConnection sapphireConnection, PropertyList config, BaseSDCRO srcRO, BaseSDCRO refRO, java.util.HashMap sdisIncluded, boolean includeDiffReport, boolean includeSDIRoleMatrix) Internal method.
DataSet	removeAuditColumns(DataSet orig)
void	renderAttributes(ConfigReportContent content)
protected ConfigReportContent	renderDetails(boolean reportDetailsTables, java.lang.String hideValueFor, TranslationProcessor translationProcessor) t This method can be called by the getSectionContent() to render the complete details of the SDI.
protected void	renderDetails(ConfigReportContent content, boolean reportDetailsTables, TranslationProcessor translationProcessor) This method can be called by the getSectionContent() to render the complete details of the SDI.
void	setIgnoreDiffs(PropertyListCollection ignorePrimaryDiffs, PropertyListCollection ignoreDetailsDiffs)
void	setOptions(DataSet options)
void	setOptions(PropertyListCollection options)

Methods inherited from class com.labvantage.sapphire.modules.configreport.renderer.BaseRenderer

createSubSectionInfo, getIgnoreDetailsDiffCols, getSectionChangeInfo, hasSectionChanged, initialize, initialize, isDeletedChapter, isNewChapter, updateSectionChangeInfo

Methods inherited from class com.labvantage.sapphire.BaseCustom

getAccessorErrorIds, getAccessorErrorMsgs, getActionProcessor, getConfigurationProcessor, getConnectionid, getConnectionId, getConnectionProcessor, getDAMProcessor, getDepartmentList, getHttpProcessor, getQueryProcessor, getRakFile, getSDCProcessor, getSDIProcessor, getSequenceProcessor, getTranslationProcessor, setConnectionId, setLanguage, setRakFile

Methods inherited from class java.lang.Object

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

Field Detail

reportSummary

protected boolean reportSummary

reportCategories

protected boolean reportCategories

reportDetails

protected boolean reportDetails

reportTemplatesOnly

protected boolean reportTemplatesOnly

OPTION_SDC_SUMMARY

public static final java.lang.String OPTION_SDC_SUMMARY

See Also:

Constant Field Values

OPTION_SDC_DETAILS

public static final java.lang.String OPTION_SDC_DETAILS

See Also:

Constant Field Values

OPTION_TEMPLATES_ONLY

public static final java.lang.String OPTION_TEMPLATES_ONLY

See Also:

Constant Field Values

OPTION_SDC_CATEGORIES

public static final java.lang.String OPTION_SDC_CATEGORIES

See Also:

Constant Field Values

sdcRO

protected BaseSDCRO sdcRO

The reference to the RO created by the Controller, that loads the SDI data

refSdcRO

protected BaseSDCRO refSdcRO

reportSDIRoleMatrix

public boolean reportSDIRoleMatrix

Flag indicates whether SDIRoleMatrix is to be included in the report or not

OPTIONID

public static final java.lang.String OPTIONID

See Also:

Constant Field Values

OPTIONTITLE

public static final java.lang.String OPTIONTITLE

See Also:

Constant Field Values

Constructor Detail

BaseSDCRenderer

public BaseSDCRenderer()

Method Detail

initialize

public void initialize(com.labvantage.sapphire.services.SapphireConnection sapphireConnection,
                       PropertyList config,
                       BaseSDCRO srcRO,
                       BaseSDCRO refRO,
                       java.util.HashMap sdisIncluded,
                       boolean includeDiffReport,
                       boolean includeSDIRoleMatrix)

Internal method. Do not override it or invoke it. Used by the controller to initialize the renderer.

Parameters:

sapphireConnection -

config -

srcRO -

sdisIncluded -

initialize

public void initialize(com.labvantage.sapphire.services.SapphireConnection sapphireConnection,
                       PropertyList config,
                       com.labvantage.sapphire.modules.configreport.ro.BaseRO srcRO,
                       java.util.HashMap sdisIncluded,
                       boolean includeSDIRoleMatrix)

initialize

public void initialize(com.labvantage.sapphire.services.SapphireConnection sapphireConnection,
                       com.labvantage.sapphire.modules.configreport.ro.BaseRO srcRO,
                       com.labvantage.sapphire.modules.configreport.ro.BaseRO refRO)

getSourceRO

public BaseSDCRO getSourceRO()

getReferenceRO

public BaseSDCRO getReferenceRO()

getSourceSDIData

public SDIData getSourceSDIData()

getReferenceSDIData

public SDIData getReferenceSDIData()

getOptions

public PropertyListCollection getOptions()

setOptions

public void setOptions(DataSet options)

setIgnoreDiffs

public void setIgnoreDiffs(PropertyListCollection ignorePrimaryDiffs,
                           PropertyListCollection ignoreDetailsDiffs)

setOptions

public void setOptions(PropertyListCollection options)

checkIfIgnore

public boolean checkIfIgnore(BaseSDCRO sdcRO,
                             BaseSDCRO refSdcRO)

getSectionContent

public ConfigReportContent getSectionContent(BaseSDCRO sdcRO,
                                             BaseSDCRO refSdcRO,
                                             TranslationProcessor translationProcessor)
                                      throws SapphireException

Throws:

SapphireException

getSpecialContent

protected ConfigReportContent getSpecialContent(BaseSDCRO sdcRO,
                                                BaseSDCRO refSdcRO,
                                                TranslationProcessor translationProcessor)
                                         throws SapphireException

Throws:

SapphireException

getSpecialContent

protected ConfigReportContent getSpecialContent(SDIData sdiData,
                                                SDIData refSDIData,
                                                TranslationProcessor translationProcessor)
                                         throws SapphireException

Throws:

SapphireException

getSpecialContent

protected ConfigReportContent getSpecialContent(BaseSDCRO sdcRO,
                                                TranslationProcessor translationProcessor)
                                         throws SapphireException

Throws:

SapphireException

getSpecialContent

protected ConfigReportContent getSpecialContent(SDIData sdiData,
                                                TranslationProcessor translationProcessor)
                                         throws SapphireException

Throws:

SapphireException

hasChapterChanged

public boolean hasChapterChanged()

Specified by:

hasChapterChanged in class com.labvantage.sapphire.modules.configreport.renderer.BaseRenderer

createXMLReport

public void createXMLReport()
                     throws SapphireException

Throws:

SapphireException

getSDIsIncluded

public java.util.ArrayList getSDIsIncluded()

getSectionList

public java.util.ArrayList getSectionList()

Specified by:

getSectionList in class com.labvantage.sapphire.modules.configreport.renderer.BaseRenderer

getSectionTitleList

public java.util.ArrayList getSectionTitleList()

Overrides:

getSectionTitleList in class com.labvantage.sapphire.modules.configreport.renderer.BaseRenderer

hasCustomSections

public boolean hasCustomSections()

If the custom renderer has any non-SDI sections, override this method and return true

Returns:

a boolean value indicating whether the renderer supports custom sections or not

getCustomSectionNames

public java.util.ArrayList getCustomSectionNames()

If the custom renderer has any non-SDI sections, override this method and return an ArrayList with the section names for the custom sections.

Returns:

An ArrayList with the names of custom sections

getCustomSectionContent

public ConfigReportContent getCustomSectionContent(java.lang.String customSectionName)

If the custom renderer has any non-SDI sections, override this method and return appropriate content for each custom section.

Parameters:

customSectionName - - The name of the custom section to be renderered by this method

Returns:

A String which has the html content generated for the custom Section identified by customSectionName

getPrimaryValue

public static java.lang.String getPrimaryValue(SDIData sdiData,
                                               java.lang.String columnName)

renderDetails

protected void renderDetails(ConfigReportContent content,
                             boolean reportDetailsTables,
                             TranslationProcessor translationProcessor)

This method can be called by the getSectionContent() to render the complete details of the SDI.

Parameters:

reportDetailsTables -

renderDetails

protected ConfigReportContent renderDetails(boolean reportDetailsTables,
                                            java.lang.String hideValueFor,
                                            TranslationProcessor translationProcessor)

t This method can be called by the getSectionContent() to render the complete details of the SDI.

Parameters:

reportDetailsTables -

Returns:

ignoreDiff

protected boolean ignoreDiff(java.lang.String currCol)

removeAuditColumns

public DataSet removeAuditColumns(DataSet orig)

renderAttributes

public void renderAttributes(ConfigReportContent content)