org.opencms.workplace.explorer
Class CmsNewCsvFile

java.lang.Object
  extended byorg.opencms.workplace.CmsWorkplace
      extended byorg.opencms.workplace.tools.CmsToolDialog
          extended byorg.opencms.workplace.CmsDialog
              extended byorg.opencms.workplace.list.A_CmsListDialog
                  extended byorg.opencms.workplace.list.A_CmsListResourceTypeDialog
                      extended byorg.opencms.workplace.explorer.CmsNewResource
                          extended byorg.opencms.workplace.explorer.CmsNewResourceUpload
                              extended byorg.opencms.workplace.explorer.CmsNewCsvFile

public class CmsNewCsvFile
extends CmsNewResourceUpload

The new resource upload dialog handles the upload of CSV (Comma Separated Values) files.

CSV files are converted in a first step to xml and in a second step transformed using a xsl stylesheet.

The following files use this class:

Since:
6.0.0
Version:
$Revision: 1.34 $
Author:
Jan Baudisch

Field Summary
static java.lang.String BEST_DELIMITER
          Constant for automatically selecting the best fitting delimiter.
static java.lang.String FRAMEHEIGHT
          Constant for the height of the dialog frame.
static java.lang.String PARAM_CSVCONTENT
          Request parameter name for the CSV content.
static java.lang.String PARAM_DELIMITER
          Request parameter name for the delimiter.
static java.lang.String PARAM_XSLTFILE
          Request parameter name for the XSLT file.
static java.lang.String TABLE_XSLT_SUFFIX
          Constant for the xslt file suffix for table transformations.
static java.lang.String TABULATOR
          Constant for the tab-value inside delimiter the select.
 
Fields inherited from class org.opencms.workplace.explorer.CmsNewResourceUpload
ACTION_APPLET, ACTION_APPLET_CHECK_OVERWRITE, ACTION_NEWFORM2, ACTION_SHOWERROR, ACTION_SUBMITFORM2, APPLET_FILEFILTER_IMAGES, APPLET_FILEFILTER_OFFICE, APPLET_FILEFILTER_WEB, DEFAULT_APPLET_WINDOW_COLORS, DIALOG_CHECK_OVERWRITE, DIALOG_SHOWERROR, DIALOG_SUBMITFORM2, PARAM_CLIENTFOLDER, PARAM_NEWRESOURCENAME, PARAM_REDIRECTURL, PARAM_TARGETFRAME, PARAM_UNZIPFILE, PARAM_UPLOADERROR, PARAM_UPLOADFILE, PARAM_UPLOADFOLDER
 
Fields inherited from class org.opencms.workplace.explorer.CmsNewResource
ACTION_NEWFORM, ACTION_SUBMITFORM, BUTTON_NEXT, DEFAULT_SUFFIX, DELIM_PROPERTYVALUES, DIALOG_ADVANCED, DIALOG_NEWFORM, DIALOG_SUBMITFORM, DIALOG_TYPE, LIST_COLUMN_URI, PARAM_APPENDSUFFIXHTML, PARAM_CURRENTFOLDER, PARAM_NEWFORMURI, PARAM_NEWRESOURCEEDITPROPS, PARAM_NEWRESOURCETYPE, PARAM_NEWRESOURCEURI, SESSION_ATTR_ADVANCED, SESSION_ATTR_PAGE, VALUE_DEFAULT
 
Fields inherited from class org.opencms.workplace.list.A_CmsListResourceTypeDialog
LIST_ACTION_SEL, LIST_COLUMN_ICON, LIST_COLUMN_NAME, LIST_COLUMN_SELECT, LIST_DETAIL_DESCRIPTION, LIST_ID, PARAM_SELECTED_TYPE
 
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_CONTINUE, ACTION_DEFAULT, ACTION_LOCKS_CONFIRMED, 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_LOCKS_CONFIRMED, 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_ORIGINALPARAMS, PARAM_PREACTIONDONE, 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
CmsNewCsvFile(CmsJspActionElement jsp)
          Public constructor with JSP action element.
CmsNewCsvFile(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
          Public constructor with JSP variables.
 
Method Summary
 void actionUpload()
          Uploads the specified file and transforms it to HTML.
 java.lang.String buildDelimiterSelect()
          Builds a html select for Delimiters.
 java.lang.String buildXsltSelect()
          Builds a html select for the XSLT files.
 byte[] getFileContentFromUpload()
          Returns the content of the file upload and sets the resource name.
 java.lang.String getHeadFrameSetHeight()
          Returns the height of the head frameset.
 java.lang.String getParamCsvContent()
          Returns the pasted csv content.
 java.lang.String getParamDelimiter()
          Returns the delimiter to separate the CSV values.
 java.lang.String getParamXsltFile()
          Returns the xslt file to transform the xml with.
 java.util.List getXsltFiles()
          Returns a list of CmsResources with the xslt files in the modules folder.
 void setParamCsvContent(java.lang.String csvContent)
          Sets the pasted csv content.
 void setParamDelimiter(java.lang.String delimiter)
          Sets the delimiter to separate the CSV values.
 void setParamXsltFile(java.lang.String xsltFile)
          Sets the path to the xslt file.
 
Methods inherited from class org.opencms.workplace.explorer.CmsNewResourceUpload
actionCloseDialog, actionUpdateFile, buildTypeList, buildTypeList, createAppletCode, getParamClientFolder, getParamNewResourceName, getParamRedirectUrl, getParamTargetFrame, getParamUnzipFile, getParamUploadError, getParamUploadFile, getParamUploadFolder, handleUploadOverwriteCheckRequest, initWorkplaceMembers, initWorkplaceRequestValues, setAppletWindowColors, setParamClientFolder, setParamNewResourceName, setParamRedirectUrl, setParamTargetFrame, setParamUnzipFile, setParamUploadError, setParamUploadFile, setParamUploadFolder, unzipUpload
 
Methods inherited from class org.opencms.workplace.explorer.CmsNewResource
actionCreateResource, actionDialog, actionEditProperties, actionSelect, appendSuffixHtml, clearSession, computeFullResourceName, computeNewTitleProperty, computeNewTitleProperty, createPropertyObject, createResourceProperties, createResourceProperties, customHtmlStart, dialogButtons, dialogButtonsAdvancedNextCancel, dialogButtonsHtml, dialogButtonsNextCancel, getListItems, getNewResourceHandler, getParamAppendSuffixHtml, getParamCurrentFolder, getParamDialogmode, getParamNewFormUri, getParamNewResourceEditProps, getParamNewResourceType, getParamNewResourceUri, getParamPage, getSuffixHtml, getTitle, isCreateIndexMode, isResourceCreated, paramsAsHidden, setColumns, setInitialResourceName, setParamAppendSuffixHtml, setParamCurrentFolder, setParamDialogmode, setParamNewFormUri, setParamNewResourceEditProps, setParamNewResourceType, setParamNewResourceUri, setParamPage, setResourceCreated
 
Methods inherited from class org.opencms.workplace.list.A_CmsListResourceTypeDialog
customHtmlBeforeList, customHtmlEnd, defaultActionHtmlContent, executeListMultiActions, executeListSingleActions, fillDetails, getParamSelectedType, paramsAsHidden, setIndependentActions, setMultiActions, setParamSelectedType
 
Methods inherited from class org.opencms.workplace.list.A_CmsListDialog
defaultActionHtml, defaultActionHtmlEnd, defaultActionHtmlStart, displayDialog, displayDialog, executeDefaultActions, executeListIndepActions, executeSearch, executeSelectPage, executeSort, fillList, getList, getListId, getListObject, getListState, getMetadata, getMetadata, getParamFormName, getParamListAction, getParamSearchFilter, getParamSelItems, getParamSortCol, getSelectedItem, getSelectedItems, initializeDetail, isActive, listRecovery, listSave, refreshList, removeList, setList, setListObject, setParamFormName, setParamListAction, setParamSearchFilter, setParamSelItems, setParamSortCol, setSearchAction, throwListUnsupportedActionException, validateParamaters, writeDialog
 
Methods inherited from class org.opencms.workplace.CmsDialog
appendDelimiter, buildAjaxResultContainer, buildAjaxWaitMessage, buildLockAdditionalOptions, buildLockConfirmationMessageJS, buildLockDialog, buildLockDialog, buildLockHeaderBox, checkResourcePermissions, checkResourcePermissions, computeCurrentFolder, dialog, dialogBlock, dialogBlockEnd, dialogBlockStart, dialogButtonRow, dialogButtonRowEnd, dialogButtonRowStart, dialogButtons, dialogButtonsClose, dialogButtonsClose, dialogButtonsCloseDetails, dialogButtonsOk, dialogButtonsOk, dialogButtonsOkCancel, dialogButtonsOkCancel, dialogButtonsOkCancelAdvanced, dialogButtonsSetOkCancel, dialogContent, dialogContentEnd, dialogContentStart, dialogEnd, dialogHead, dialogHorizontalSpacer, dialogLockButtons, 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, getParamOriginalParams, getParamPreActionDone, getParamRedirect, getParamResource, getParamTitle, getState, hasCorrectLockstate, hasSiblings, htmlStart, htmlStart, htmlStart, htmlStartStyle, includeErrorpage, initCmsDialog, isPopup, isPreEditor, pageHtml, pageHtml, setAction, setOnlineHelpUriCustom, setParamAction, setParamCloseLink, setParamDialogtype, setParamFramename, setParamIsPopup, setParamMessage, setParamOriginalParams, setParamPreActionDone, 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, checkLock, checkLock, checkRole, decodeParamValue, fillParamValues, fillParamValues, getBroadcastMessageString, getCms, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStyleUri, getStyleUri, getStyleUri, getTemporaryFileName, htmlEnd, initMessages, initSettings, initTimeWarp, initUserSettings, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, isTemporaryFile, isTemporaryFileName, key, key, keyDefault, nullToEmpty, 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

BEST_DELIMITER

public static final java.lang.String BEST_DELIMITER
Constant for automatically selecting the best fitting delimiter.

See Also:
Constant Field Values

FRAMEHEIGHT

public static final java.lang.String FRAMEHEIGHT
Constant for the height of the dialog frame.

See Also:
Constant Field Values

PARAM_CSVCONTENT

public static final java.lang.String PARAM_CSVCONTENT
Request parameter name for the CSV content.

See Also:
Constant Field Values

PARAM_DELIMITER

public static final java.lang.String PARAM_DELIMITER
Request parameter name for the delimiter.

See Also:
Constant Field Values

PARAM_XSLTFILE

public static final java.lang.String PARAM_XSLTFILE
Request parameter name for the XSLT file.

See Also:
Constant Field Values

TABLE_XSLT_SUFFIX

public static final java.lang.String TABLE_XSLT_SUFFIX
Constant for the xslt file suffix for table transformations.

See Also:
Constant Field Values

TABULATOR

public static final java.lang.String TABULATOR
Constant for the tab-value inside delimiter the select.

See Also:
Constant Field Values
Constructor Detail

CmsNewCsvFile

public CmsNewCsvFile(CmsJspActionElement jsp)
Public constructor with JSP action element.

Parameters:
jsp - an initialized JSP action element

CmsNewCsvFile

public CmsNewCsvFile(javax.servlet.jsp.PageContext context,
                     javax.servlet.http.HttpServletRequest req,
                     javax.servlet.http.HttpServletResponse res)
Public constructor with JSP variables.

Parameters:
context - the JSP page context
req - the JSP request
res - the JSP response
Method Detail

actionUpload

public void actionUpload()
                  throws javax.servlet.jsp.JspException
Uploads the specified file and transforms it to HTML.

Overrides:
actionUpload in class CmsNewResourceUpload
Throws:
javax.servlet.jsp.JspException - if inclusion of error dialog fails

buildDelimiterSelect

public java.lang.String buildDelimiterSelect()
Builds a html select for Delimiters.

Returns:
html select code with the possible available xslt files

buildXsltSelect

public java.lang.String buildXsltSelect()
Builds a html select for the XSLT files.

Returns:
html select code with the possible available xslt files

getFileContentFromUpload

public byte[] getFileContentFromUpload()
                                throws CmsWorkplaceException
Returns the content of the file upload and sets the resource name.

Returns:
the byte content of the uploaded file
Throws:
CmsWorkplaceException - if the filesize if greater that maxFileSizeBytes or if the upload file cannot be found

getHeadFrameSetHeight

public java.lang.String getHeadFrameSetHeight()
Returns the height of the head frameset.

Returns:
the height of the head frameset

getParamCsvContent

public java.lang.String getParamCsvContent()
Returns the pasted csv content.

Returns:
the csv content

getParamDelimiter

public java.lang.String getParamDelimiter()
Returns the delimiter to separate the CSV values.

Returns:
the delimiter to separate the CSV values

getParamXsltFile

public java.lang.String getParamXsltFile()
Returns the xslt file to transform the xml with.

Returns:
the path to the xslt file to transform the xml with or null if it is not set

getXsltFiles

public java.util.List getXsltFiles()
Returns a list of CmsResources with the xslt files in the modules folder.

Returns:
a list of the available xslt files

setParamCsvContent

public void setParamCsvContent(java.lang.String csvContent)
Sets the pasted csv content.

Parameters:
csvContent - the csv content to set

setParamDelimiter

public void setParamDelimiter(java.lang.String delimiter)
Sets the delimiter to separate the CSV values.

Parameters:
delimiter - the delimiter to separate the CSV values.

setParamXsltFile

public void setParamXsltFile(java.lang.String xsltFile)
Sets the path to the xslt file.

Parameters:
xsltFile - the file to transform the xml with.