org.opencms.workplace.comparison
Class CmsPropertyComparisonList

java.lang.Object
  org.opencms.workplace.CmsWorkplace
      org.opencms.workplace.tools.CmsToolDialog
          org.opencms.workplace.CmsDialog
              org.opencms.workplace.list.A_CmsListDialog
                  org.opencms.workplace.comparison.CmsPropertyComparisonList

Direct Known Subclasses:

CmsAttributeComparisonList

public class CmsPropertyComparisonList
extends A_CmsListDialog

List for property comparison including columns for property name and the values.

Since:

6.0.0

Version:

$Revision: 1.5 $

Author:

Jan Baudisch

Field Summary

static String	LIST_ACTION_VIEW1 view first file action constant.
static String	LIST_ACTION_VIEW2 view second file action constant.
static String	LIST_COLUMN_ICON list action id constant.
static String	LIST_COLUMN_PROPERTY_NAME list column id constant.
static String	LIST_COLUMN_TYPE list action id constant.
static String	LIST_COLUMN_VERSION_1 list column id constant.
static String	LIST_COLUMN_VERSION_2 list column id constant.
static String	LIST_DEFACTION_VIEW list default action id constant.
static String	LIST_DETAIL_TYPE list independent action id constant.
static String	LIST_IACTION_SHOW list independent action id constant.
static String	LIST_ID List id constant.
static String	PARAM_COMPARE request parameter indicating whether attributes, elements or properties are compared.
protected static int	TRIM_AT_LENGTH The maximum length of properties and attributes to be displayed.

Fields inherited from class org.opencms.workplace.list.A_CmsListDialog

ACTION_LIST_INDEPENDENT_ACTION, ACTION_LIST_MULTI_ACTION, ACTION_LIST_SEARCH, ACTION_LIST_SELECT_PAGE, ACTION_LIST_SINGLE_ACTION, ACTION_LIST_SORT, ICON_ACTIVE, ICON_ADD, ICON_DELETE, ICON_DETAILS_HIDE, ICON_DETAILS_SHOW, ICON_DISABLED, ICON_INACTIVE, ICON_MINUS, ICON_MULTI_ACTIVATE, ICON_MULTI_ADD, ICON_MULTI_DEACTIVATE, ICON_MULTI_DELETE, ICON_MULTI_MINUS, LIST_INDEPENDENT_ACTION, LIST_MULTI_ACTION, LIST_SEARCH, LIST_SELECT_PAGE, LIST_SINGLE_ACTION, LIST_SORT, PARAM_FORMNAME, PARAM_LIST_ACTION, PARAM_PAGE, PARAM_SEARCH_FILTER, PARAM_SEL_ITEMS, PARAM_SORT_COL

Fields inherited from class org.opencms.workplace.CmsDialog

ACTION_CANCEL, ACTION_CLOSEPOPUP, ACTION_CLOSEPOPUP_SAVE, ACTION_CONFIRMED, ACTION_DEFAULT, ACTION_OK, ACTION_REPORT_BEGIN, ACTION_REPORT_END, ACTION_REPORT_UPDATE, ACTION_SET, ACTION_WAIT, ATTRIBUTE_THROWABLE, BUTTON_ADVANCED, BUTTON_BACK, BUTTON_CANCEL, BUTTON_CLOSE, BUTTON_CONTINUE, BUTTON_DETAILS, BUTTON_DISCARD, BUTTON_EDIT, BUTTON_OK, BUTTON_OK_NO_SUBMIT, BUTTON_SET, DIALOG_BACK, DIALOG_CANCEL, DIALOG_CONFIRMED, DIALOG_CONTINUE, DIALOG_INITIAL, DIALOG_OK, DIALOG_SET, DIALOG_WAIT, PARAM_ACTION, PARAM_CLOSELINK, PARAM_DIALOGTYPE, PARAM_ERRORSTACK, PARAM_FILE, PARAM_FRAMENAME, PARAM_ISPOPUP, PARAM_LOCK, PARAM_MESSAGE, PARAM_REDIRECT, PARAM_RESOURCE, PARAM_TARGET, PARAM_THREAD, PARAM_THREAD_HASNEXT, PARAM_TITLE, REPORT_BEGIN, REPORT_END, REPORT_UPDATE

Fields inherited from class org.opencms.workplace.tools.CmsToolDialog

PARAM_BASE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW

Fields inherited from class org.opencms.workplace.CmsWorkplace

DEBUG, DEFAULT_LANGUAGE, DEFAULT_LOCALE, DIALOG_PATH_COMMON, FILE_DIALOG_CLOSE, FILE_DIALOG_SCREEN_CONFIRM, FILE_DIALOG_SCREEN_ERROR, FILE_DIALOG_SCREEN_ERRORPAGE, FILE_DIALOG_SCREEN_WAIT, FILE_EXPLORER_FILELIST, FILE_REPORT_OUTPUT, HTML_END, HTML_START, PARAM_WP_EXPLORER_RESOURCE, PARAM_WP_PROJECT, PARAM_WP_SITE, PATH_DIALOGS, PATH_WORKPLACE, REQUEST_ATTRIBUTE_MULTIPART, REQUEST_ATTRIBUTE_RELOADTREE, RFS_PATH_RESOURCES, SESSION_WORKPLACE_CLASS, TEMP_FILE_PREFIX, VFS_DIR_DEFAULTBODIES, VFS_DIR_TEMPLATES, VFS_PATH_COMMONS, VFS_PATH_EDITORS, VFS_PATH_GALLERIES, VFS_PATH_LOCALES, VFS_PATH_MODULES, VFS_PATH_RESOURCES, VFS_PATH_SYSTEM, VFS_PATH_VIEWS, VFS_PATH_WORKPLACE

Constructor Summary

	CmsPropertyComparisonList(CmsJspActionElement jsp) Public constructor.
protected	CmsPropertyComparisonList(CmsJspActionElement jsp, String listId, CmsMessageContainer listName, String sortedColId, CmsListOrderEnum sortOrder, String searchableColId) Public constructor.
	CmsPropertyComparisonList(PageContext context, HttpServletRequest req, HttpServletResponse res) Public constructor with JSP variables.
protected	CmsPropertyComparisonList(String listId, CmsJspActionElement jsp) Protected constructor.

Method Summary

void	executeListMultiActions() This method should handle every defined list multi action, by comparing A_CmsListDialog.getParamListAction() with the id of the action to execute.
void	executeListSingleActions() This method should handle every defined list single action, by comparing A_CmsListDialog.getParamListAction() with the id of the action to execute.
protected void	fillDetails(String detailId) Lazy initialization for detail data.
CmsFile	getFile1() Returns the file1.
CmsFile	getFile2() Returns the file2.
protected List	getListItems() Should generate a list with the list items to be displayed.
String	getParamPath1() Returns the paramPath1.
String	getParamPath2() Returns the paramPath2.
String	getParamTagId1() Returns the paramTagId1.
String	getParamTagId2() Returns the paramTagId2.
String	getParamVersion1() Returns the paramNewversionid.
String	getParamVersion2() Returns the paramOldversionid.
int	getResourceType() Returns the resourceType.
protected void	initWorkplaceRequestValues(CmsWorkplaceSettings settings, HttpServletRequest request) Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.
protected void	setColumns(CmsListMetadata metadata) Should create the columns and add them to the given list metadata object.
protected void	setIndependentActions(CmsListMetadata metadata) Should add the independent actions to the given list metadata object.
protected void	setMultiActions(CmsListMetadata metadata) Should add the multi actions to the given list metadata object.
void	setParamPath1(String paramPath1) Sets the paramPath1.
void	setParamPath2(String paramPath2) Sets the paramPath2.
void	setParamTagId1(String paramTagId1) Sets the paramTagId1.
void	setParamTagId2(String paramTagId2) Sets the paramTagId2.
void	setParamVersion1(String paramNewversionid) Sets the paramNewversionid.
void	setParamVersion2(String paramOldversionid) Sets the paramOldversionid.

Methods inherited from class org.opencms.workplace.list.A_CmsListDialog

actionDialog, customHtmlEnd, customHtmlStart, defaultActionHtml, defaultActionHtmlContent, defaultActionHtmlEnd, defaultActionHtmlStart, displayDialog, displayDialog, executeDefaultActions, executeListIndepActions, executeSearch, executeSelectPage, executeSort, fillList, getList, getListId, getListObject, getMetadata, getParamFormName, getParamListAction, getParamPage, getParamSearchFilter, getParamSelItems, getParamSortCol, getSelectedItem, getSelectedItems, isActive, listRecovery, listSave, refreshList, removeList, setList, setListObject, setParamFormName, setParamListAction, setParamPage, setParamSearchFilter, setParamSelItems, setParamSortCol, setSearchAction, throwListUnsupportedActionException, validateParamaters, writeDialog

Methods inherited from class org.opencms.workplace.CmsDialog

actionCloseDialog, appendDelimiter, checkResourcePermissions, checkResourcePermissions, dialog, dialogBlock, dialogBlockEnd, dialogBlockStart, dialogButtonRow, dialogButtonRowEnd, dialogButtonRowStart, dialogButtons, dialogButtonsClose, dialogButtonsClose, dialogButtonsCloseDetails, dialogButtonsHtml, dialogButtonsOk, dialogButtonsOk, dialogButtonsOkCancel, dialogButtonsOkCancel, dialogButtonsOkCancelAdvanced, dialogButtonsSetOkCancel, dialogContent, dialogContentEnd, dialogContentStart, dialogEnd, dialogHead, dialogHorizontalSpacer, dialogRow, dialogRowEnd, dialogRowStart, dialogScriptSubmit, dialogSeparator, dialogSpacer, dialogStart, dialogStart, dialogSubheadline, dialogToggleStart, dialogWhiteBox, dialogWhiteBoxEnd, dialogWhiteBoxStart, getAction, getAdministrationBackLink, getCancelAction, getDialogRealUri, getDialogUri, getOnlineHelpUriCustom, getParamAction, getParamCloseLink, getParamDialogtype, getParamFramename, getParamIsPopup, getParamMessage, getParamRedirect, getParamResource, getParamTitle, getState, htmlStart, htmlStart, htmlStart, htmlStartStyle, includeErrorpage, initCmsDialog, isPopup, pageHtml, pageHtml, setAction, setOnlineHelpUriCustom, setParamAction, setParamCloseLink, setParamDialogtype, setParamFramename, setParamIsPopup, setParamMessage, setParamRedirect, setParamResource, setParamTitle

Methods inherited from class org.opencms.workplace.tools.CmsToolDialog

dialogTitle, getAdminTool, getCurrentToolPath, getParamBase, getParamPath, getParamRoot, getParamStyle, getParentPath, getToolManager, iconsBlockArea, iconsBlockAreaEnd, iconsBlockAreaStart, initAdminTool, pageBody, pageHtmlStyle, setParamBase, setParamPath, setParamRoot, setParamStyle, useNewStyle

Methods inherited from class org.opencms.workplace.CmsWorkplace

addMessages, addMessages, allParamsAsHidden, allParamsAsRequest, allParamValues, bodyEnd, bodyStart, bodyStart, buildSelect, buildSelect, button, button, buttonBar, buttonBar, buttonBarHorizontalLine, buttonBarLabel, buttonBarLabel, buttonBarLine, buttonBarLineSpacer, buttonBarSeparator, buttonBarSpacer, buttonBarStartTab, calendarIncludes, calendarIncludes, calendarInit, calendarInit, checkLock, checkLock, decodeParamValue, fillParamValues, fillParamValues, getBroadcastMessageString, getCalendarDate, getCalendarJavaDateFormat, getCalendarLocalizedTime, getCms, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStyleUri, getStyleUri, getStyleUri, htmlEnd, initMessages, initSettings, initUserSettings, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, key, key, keyDefault, nullToEmpty, paramsAsHidden, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, switchToCurrentProject, switchToTempProject

Methods inherited from class java.lang.Object

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

Field Detail

LIST_ACTION_VIEW1

public static final String LIST_ACTION_VIEW1

view first file action constant.

See Also:

Constant Field Values

LIST_ACTION_VIEW2

public static final String LIST_ACTION_VIEW2

view second file action constant.

See Also:

Constant Field Values

LIST_COLUMN_ICON

public static final String LIST_COLUMN_ICON

list action id constant.

See Also:

Constant Field Values

LIST_COLUMN_PROPERTY_NAME

public static final String LIST_COLUMN_PROPERTY_NAME

list column id constant.

See Also:

Constant Field Values

LIST_COLUMN_TYPE

public static final String LIST_COLUMN_TYPE

list action id constant.

See Also:

Constant Field Values

LIST_COLUMN_VERSION_1

public static final String LIST_COLUMN_VERSION_1

list column id constant.

See Also:

Constant Field Values

LIST_COLUMN_VERSION_2

public static final String LIST_COLUMN_VERSION_2

list column id constant.

See Also:

Constant Field Values

LIST_DEFACTION_VIEW

public static final String LIST_DEFACTION_VIEW

list default action id constant.

See Also:

Constant Field Values

LIST_DETAIL_TYPE

public static final String LIST_DETAIL_TYPE

list independent action id constant.

See Also:

Constant Field Values

LIST_IACTION_SHOW

public static final String LIST_IACTION_SHOW

list independent action id constant.

See Also:

Constant Field Values

LIST_ID

public static final String LIST_ID

List id constant.

See Also:

Constant Field Values

PARAM_COMPARE

public static final String PARAM_COMPARE

request parameter indicating whether attributes, elements or properties are compared.

See Also:

Constant Field Values

TRIM_AT_LENGTH

protected static final int TRIM_AT_LENGTH

The maximum length of properties and attributes to be displayed.

See Also:

Constant Field Values

Constructor Detail

CmsPropertyComparisonList

public CmsPropertyComparisonList(CmsJspActionElement jsp)

Public constructor.

Parameters:

jsp - an initialized JSP action element

CmsPropertyComparisonList

public CmsPropertyComparisonList(PageContext context,
                                 HttpServletRequest req,
                                 HttpServletResponse res)

Public constructor with JSP variables.

Parameters:

context - the JSP page context

req - the JSP request

res - the JSP response

CmsPropertyComparisonList

protected CmsPropertyComparisonList(CmsJspActionElement jsp,
                                    String listId,
                                    CmsMessageContainer listName,
                                    String sortedColId,
                                    CmsListOrderEnum sortOrder,
                                    String searchableColId)

Public constructor.

Parameters:

jsp - an initialized JSP action element

listId - the id of the displayed list

listName - the name of the list

sortedColId - the a priory sorted column

sortOrder - the order of the sorted column

searchableColId - the column to search into

CmsPropertyComparisonList

protected CmsPropertyComparisonList(String listId,
                                    CmsJspActionElement jsp)

Protected constructor.

Parameters:

listId - the id of the specialized list

jsp - an initialized JSP action element

Method Detail

executeListMultiActions

public void executeListMultiActions()

Description copied from class: A_CmsListDialog

This method should handle every defined list multi action, by comparing A_CmsListDialog.getParamListAction() with the id of the action to execute.

Specified by:

executeListMultiActions in class A_CmsListDialog

See Also:

A_CmsListDialog.executeListMultiActions()

executeListSingleActions

public void executeListSingleActions()
                              throws IOException,
                                     ServletException

Description copied from class: A_CmsListDialog

This method should handle every defined list single action, by comparing A_CmsListDialog.getParamListAction() with the id of the action to execute.

Specified by:

executeListSingleActions in class A_CmsListDialog

Throws:

IOException - in case of errors when including a required sub-element

ServletException - in case of errors when including a required sub-element

See Also:

A_CmsListDialog.executeListSingleActions()

getFile1

public CmsFile getFile1()

Returns the file1.

Returns:

the file1

getFile2

public CmsFile getFile2()

Returns the file2.

Returns:

the file2

getParamPath1

public String getParamPath1()

Returns the paramPath1.

Returns:

the paramPath1

getParamPath2

public String getParamPath2()

Returns the paramPath2.

Returns:

the paramPath2

getParamTagId1

public String getParamTagId1()

Returns the paramTagId1.

Returns:

the paramTagId1

getParamTagId2

public String getParamTagId2()

Returns the paramTagId2.

Returns:

the paramTagId2

getParamVersion1

public String getParamVersion1()

Returns the paramNewversionid.

Returns:

the paramNewversionid

getParamVersion2

public String getParamVersion2()

Returns the paramOldversionid.

Returns:

the paramOldversionid

getResourceType

public int getResourceType()

Returns the resourceType.

Returns:

the resourceType

setParamPath1

public void setParamPath1(String paramPath1)

Sets the paramPath1.

Parameters:

paramPath1 - the paramPath1 to set

setParamPath2

public void setParamPath2(String paramPath2)

Sets the paramPath2.

Parameters:

paramPath2 - the paramPath2 to set

setParamTagId1

public void setParamTagId1(String paramTagId1)

Sets the paramTagId1.

Parameters:

paramTagId1 - the paramTagId1 to set

setParamTagId2

public void setParamTagId2(String paramTagId2)

Sets the paramTagId2.

Parameters:

paramTagId2 - the paramTagId2 to set

setParamVersion1

public void setParamVersion1(String paramNewversionid)

Sets the paramNewversionid.

Parameters:

paramNewversionid - the paramNewversionid to set

setParamVersion2

public void setParamVersion2(String paramOldversionid)

Sets the paramOldversionid.

Parameters:

paramOldversionid - the paramOldversionid to set

fillDetails

protected void fillDetails(String detailId)

Description copied from class: A_CmsListDialog

Lazy initialization for detail data.

Should fill the given detail column for every list item in CmsHtmlList.getAllContent() Should not throw any kind of exception.

Specified by:

fillDetails in class A_CmsListDialog

Parameters:

detailId - the id of the detail to initialize

See Also:

A_CmsListDialog.fillDetails(java.lang.String)

getListItems

protected List getListItems()
                     throws CmsException

Description copied from class: A_CmsListDialog

Should generate a list with the list items to be displayed.

Specified by:

getListItems in class A_CmsListDialog

Returns:

a list of CmsListItems

Throws:

CmsException - if something goes wrong

See Also:

A_CmsListDialog.getListItems()

initWorkplaceRequestValues

protected void initWorkplaceRequestValues(CmsWorkplaceSettings settings,
                                          HttpServletRequest request)

Description copied from class: CmsWorkplace

Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.

Overrides:

initWorkplaceRequestValues in class A_CmsListDialog

Parameters:

settings - the workplace settings

request - the current request

See Also:

CmsWorkplace.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)

setColumns

protected void setColumns(CmsListMetadata metadata)

Description copied from class: A_CmsListDialog

Should create the columns and add them to the given list metadata object.

This method will be just executed once, the first time the constructor is called.

Specified by:

setColumns in class A_CmsListDialog

Parameters:

metadata - the list metadata

See Also:

A_CmsListDialog.setColumns(org.opencms.workplace.list.CmsListMetadata)

setIndependentActions

protected void setIndependentActions(CmsListMetadata metadata)

Description copied from class: A_CmsListDialog

Should add the independent actions to the given list metadata object.

This method will be just executed once, the first time the constructor is called.

Specified by:

setIndependentActions in class A_CmsListDialog

Parameters:

metadata - the list metadata

See Also:

A_CmsListDialog.setIndependentActions(org.opencms.workplace.list.CmsListMetadata)

setMultiActions

protected void setMultiActions(CmsListMetadata metadata)

Description copied from class: A_CmsListDialog

Should add the multi actions to the given list metadata object.

This method will be just executed once, the first time the constructor is called.

Specified by:

setMultiActions in class A_CmsListDialog

Parameters:

metadata - the list metadata

See Also:

A_CmsListDialog.setMultiActions(org.opencms.workplace.list.CmsListMetadata)