com.jalios.jcms.stat

Class XmlRawDataExportHandler

java.lang.Object

com.jalios.jcms.stat.RawDataExportHandler

com.jalios.jcms.stat.XmlRawDataExportHandler

All Implemented Interfaces:

java.lang.Cloneable

public class XmlRawDataExportHandler
extends RawDataExportHandler

Export data to XML format

Author:

Ludovic SMADJA

Field Summary

Fields inherited from class com.jalios.jcms.stat.RawDataExportHandler

filenameBase, key, out, realOutput, REVISION, useCompressStream, userLang

Constructor Summary

Constructors

Constructor and Description
XmlRawDataExportHandler()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	convertField(java.lang.String name, java.lang.Class<?> clazz, java.util.Set<?> valueSet, java.lang.String extraFieldName, java.lang.String userLang) convert field to handler data
java.util.List<java.lang.String>	duplicateHeader(java.lang.String string, java.lang.Class<?> clazz) indicate if a field have other representation (like member have id and also a name)
void	end(java.io.OutputStream out) Process end of export (after any write)
void	exportFooter(java.io.OutputStream out, java.lang.String[] columnNames) export footer of data
void	exportHeader(java.io.OutputStream out, java.lang.String[] columnNames) Export header of data
void	exportLine(java.io.OutputStream out, java.lang.String[] columnNames) Export a line of data
java.lang.String	getConfigurationFragmentPath() indicates the path of the jsp fragment with driver configuration fields
java.lang.String	getContentType()
java.lang.String	getFileExtension()
void	init(java.io.OutputStream out) Initialise the handler (before any write)

Methods inherited from class com.jalios.jcms.stat.RawDataExportHandler

clone, getFilenameBase, getKey, getOut, getUserLang, isUseCompressStream, setFilenameBase, setKey, setOut, setParameters, setUseCompressStream, setUserLang, validateParameters

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlRawDataExportHandler

public XmlRawDataExportHandler()

Method Detail

convertField

public java.lang.String convertField(java.lang.String name,
                            java.lang.Class<?> clazz,
                            java.util.Set<?> valueSet,
                            java.lang.String extraFieldName,
                            java.lang.String userLang)

Description copied from class: RawDataExportHandler

convert field to handler data

Specified by:

convertField in class RawDataExportHandler

Parameters:

name - the name of the field (see StatEntry.STAT_FIELDS)

clazz - the class of the field (see StatEntry.STAT_FIELDS_CLASS)

valueSet - the Set of value

extraFieldName - the duplicate field name if used

userLang - the current language

Returns:

the converted value to export

duplicateHeader

public java.util.List<java.lang.String> duplicateHeader(java.lang.String string,
                                               java.lang.Class<?> clazz)

Description copied from class: RawDataExportHandler

indicate if a field have other representation (like member have id and also a name)

Specified by:

duplicateHeader in class RawDataExportHandler

Parameters:

string - the name of the field (see StatEntry.STAT_FIELDS)

clazz - the class of the field (see StatEntry.STAT_FIELDS_CLASS)

Returns:

the List of other representation name

init

public void init(java.io.OutputStream out)
          throws java.io.IOException

Description copied from class: RawDataExportHandler

Initialise the handler (before any write)

Specified by:

init in class RawDataExportHandler

Parameters:

out - outputstream associated to this handler

Throws:

java.io.IOException

exportFooter

public void exportFooter(java.io.OutputStream out,
                java.lang.String[] columnNames)
                  throws java.io.IOException

Description copied from class: RawDataExportHandler

export footer of data

Specified by:

exportFooter in class RawDataExportHandler

Parameters:

out - outputstream associated to this handler

columnNames - footer data

Throws:

java.io.IOException

exportHeader

public void exportHeader(java.io.OutputStream out,
                java.lang.String[] columnNames)
                  throws java.io.IOException

Description copied from class: RawDataExportHandler

Export header of data

Specified by:

exportHeader in class RawDataExportHandler

Parameters:

out - outputstream associated to this handler

columnNames - the names of columns

Throws:

java.io.IOException

exportLine

public void exportLine(java.io.OutputStream out,
              java.lang.String[] columnNames)
                throws java.io.IOException

Description copied from class: RawDataExportHandler

Export a line of data

Specified by:

exportLine in class RawDataExportHandler

Parameters:

out - outputstream associated to this handler

columnNames - the data array

Throws:

java.io.IOException

getConfigurationFragmentPath

public java.lang.String getConfigurationFragmentPath()

Description copied from class: RawDataExportHandler

indicates the path of the jsp fragment with driver configuration fields

Specified by:

getConfigurationFragmentPath in class RawDataExportHandler

Returns:

the fragment path

end

public void end(java.io.OutputStream out)
         throws java.io.IOException

Description copied from class: RawDataExportHandler

Process end of export (after any write)

Specified by:

end in class RawDataExportHandler

Parameters:

out - outputstream associated to this handler

Throws:

java.io.IOException

getFileExtension

public java.lang.String getFileExtension()

Specified by:

getFileExtension in class RawDataExportHandler

Returns:

the file extension of generated file

getContentType

public java.lang.String getContentType()

Specified by:

getContentType in class RawDataExportHandler

Returns:

the content type of the generated file