org.opencms.workplace.explorer
Class CmsNewCsvFile

java.lang.Object
  org.opencms.workplace.CmsWorkplace
      org.opencms.workplace.tools.CmsToolDialog
          org.opencms.workplace.CmsDialog
              org.opencms.workplace.explorer.CmsNewResource
                  org.opencms.workplace.explorer.CmsNewResourceUpload
                      org.opencms.workplace.explorer.CmsNewCsvFile

public class CmsNewCsvFile

extends CmsNewResourceUpload

The new resource upload dialog handles the upload of cvs files. They are converted in a first step to xml and in a second step transformed via a xsl stylesheet.

The following files use this class:

• /commons/newcvsfile_upload.jsp

Since:

6.0.0

Version:

$Revision: 1.14 $

Author:

Jan Baudisch

Field Summary

static String	BEST_DELIMITER Constant for automatically selecting the best fitting delimiter.
static String	FRAMEHEIGHT Constant for the height of the dialog frame.
static String	PARAM_CSVCONTENT Request parameter name for the CSV content.
static String	PARAM_DELIMITER Request parameter name for the delimiter.
static String	PARAM_XSLTFILE Request parameter name for the XSLT file.
static String	TABLE_XSLT_SUFFIX Constant for the xslt file suffix for table transformations.
static String	TABULATOR Constant for the tab-value inside delimiter the select.
static char	TEXT_DELIMITER The delimiter to separate the text.

Fields inherited from class org.opencms.workplace.explorer.CmsNewResourceUpload

ACTION_APPLET, ACTION_NEWFORM2, ACTION_SHOWERROR, ACTION_SUBMITFORM2, DIALOG_SHOWERROR, DIALOG_SUBMITFORM2, 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, DIALOG_NEWFORM, DIALOG_SUBMITFORM, DIALOG_TYPE, PARAM_CURRENTFOLDER, PARAM_NEWRESOURCEEDITPROPS, PARAM_NEWRESOURCETYPE, PARAM_NEWRESOURCEURI

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_PATH, PARAM_ROOT, PARAM_STYLE

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, 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_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(PageContext context, HttpServletRequest req, HttpServletResponse res)
Public constructor with JSP variables.

Method Summary

void	actionUpload() Uploads the specified file and transforms it to HTML.
String	applyXslTransformation(String xsltFile, String xmlContent) Applies a XSLT Transformation to the xmlContent.
String	buildDelimiterSelect() Builds a html select for Delimiters.
String	buildXsltSelect() Builds a html select for the XSLT files.
static String	convertCsvToXml(String csvData, String delimiter) Converts CSV data to xml.
byte[]	getFileContentFromUpload() Returns the content of the file upload and sets the resource name.
String	getHeadFrameSetHeight() Returns the height of the head frameset.
String	getParamCsvContent() Returns the pasted csv content.
String	getParamDelimiter() Returns the delimiter to separate the CSV values.
String	getParamXsltFile() Returns the xslt file to transform the xml with.
String	getPreferredDelimiter(String csvData) returns the Delimiter that most often occures in the CSV content.
List	getXsltFiles() Returns a list of CmsResources with the xslt files in the modules folder.
void	setParamCsvContent(String csvContent) Sets the pasted csv content.
void	setParamDelimiter(String delimiter) Sets the delimiter to separate the CSV values.
void	setParamXsltFile(String xsltFile) Sets the path to the xslt file.

Methods inherited from class org.opencms.workplace.explorer.CmsNewResourceUpload

actionCloseDialog, actionUpdateFile, buildTypeList, createAppletCode, getParamNewResourceName, getParamRedirectUrl, getParamTargetFrame, getParamUnzipFile, getParamUploadError, getParamUploadFile, getParamUploadFolder, initWorkplaceRequestValues, setParamNewResourceName, setParamRedirectUrl, setParamTargetFrame, setParamUnzipFile, setParamUploadError, setParamUploadFile, setParamUploadFolder, unzipUpload

Methods inherited from class org.opencms.workplace.explorer.CmsNewResource

actionCreateResource, actionEditProperties, actionSelect, buildNewList, computeCurrentFolder, computeFullResourceName, computeNewTitleProperty, createPropertyObject, createResourceProperties, dialogButtonsHtml, dialogButtonsNextCancel, getNewResourceHandler, getParamCurrentFolder, getParamNewResourceEditProps, getParamNewResourceType, getParamNewResourceUri, getParamPage, isResourceCreated, setParamCurrentFolder, setParamNewResourceEditProps, setParamNewResourceType, setParamNewResourceUri, setParamPage, setResourceCreated

Methods inherited from class org.opencms.workplace.CmsDialog

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

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

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

Methods inherited from class org.opencms.workplace.CmsWorkplace

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, getBroadcastMessageString, getCalendarDate, getCalendarJavaDateFormat, getCalendarLocalizedTime, getCms, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStyleUri, getStyleUri, getStyleUri, htmlEnd, initMessages, initUserSettings, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, key, key, key, nullToEmpty, paramsAsHidden, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, 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 String BEST_DELIMITER

Constant for automatically selecting the best fitting delimiter.

See Also:

Constant Field Values

FRAMEHEIGHT

public static final String FRAMEHEIGHT

Constant for the height of the dialog frame.

See Also:

Constant Field Values

PARAM_CSVCONTENT

public static final String PARAM_CSVCONTENT

Request parameter name for the CSV content.

See Also:

Constant Field Values

PARAM_DELIMITER

public static final String PARAM_DELIMITER

Request parameter name for the delimiter.

See Also:

Constant Field Values

PARAM_XSLTFILE

public static final String PARAM_XSLTFILE

Request parameter name for the XSLT file.

See Also:

Constant Field Values

TABLE_XSLT_SUFFIX

public static final String TABLE_XSLT_SUFFIX

Constant for the xslt file suffix for table transformations.

See Also:

Constant Field Values

TABULATOR

public static final String TABULATOR

Constant for the tab-value inside delimiter the select.

See Also:

Constant Field Values

TEXT_DELIMITER

public static final char TEXT_DELIMITER

The delimiter to separate the text.

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(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

Method Detail

convertCsvToXml

public static String convertCsvToXml(String csvData,
                                     String delimiter)
                              throws IOException

Converts CSV data to xml.

Parameters:

csvData - the csv data to convert

delimiter - the delimiter to separate the values with

Returns:

a XML representation of the csv data

Throws:

IOException - if there is an IO problem

actionUpload

public void actionUpload()
                  throws JspException

Uploads the specified file and transforms it to HTML.

Overrides:

actionUpload in class CmsNewResourceUpload

Throws:

JspException - if inclusion of error dialog fails

applyXslTransformation

public String applyXslTransformation(String xsltFile,
                                     String xmlContent)

Applies a XSLT Transformation to the xmlContent.

Parameters:

xsltFile - the XSLT transformation file

xmlContent - the XML content to transform

Returns:

the transformed xml

buildDelimiterSelect

public String buildDelimiterSelect()

Builds a html select for Delimiters.

Returns:

html select code with the possible available xslt files

buildXsltSelect

public 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 String getHeadFrameSetHeight()

Returns the height of the head frameset.

Returns:

the height of the head frameset

getParamCsvContent

public String getParamCsvContent()

Returns the pasted csv content.

Returns:

the csv content

getParamDelimiter

public String getParamDelimiter()

Returns the delimiter to separate the CSV values.

Returns:

the delimiter to separate the CSV values

getParamXsltFile

public 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

getPreferredDelimiter

public String getPreferredDelimiter(String csvData)

returns the Delimiter that most often occures in the CSV content.

Parameters:

csvData - the comma separated values

Returns:

the delimiter, that is best applicable for the csvData

getXsltFiles

public 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(String csvContent)

Sets the pasted csv content.

Parameters:

csvContent - the csv content to set

setParamDelimiter

public void setParamDelimiter(String delimiter)

Sets the delimiter to separate the CSV values.

Parameters:

delimiter - the delimiter to separate the CSV values.

setParamXsltFile

public void setParamXsltFile(String xsltFile)

Sets the path to the xslt file.

Parameters:

xsltFile - the file to transform the xml with.