com.jalios.jcms.stat

Class RawDataExportHandler

java.lang.Object

com.jalios.jcms.stat.RawDataExportHandler

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

CSVExportRawDataHandler, XmlRawDataExportHandler

public abstract class RawDataExportHandler
extends java.lang.Object
implements java.lang.Cloneable

Abstract class of all Raw data export handler

Since:

JCMS 6.3

Author:

Ludovic SMADJA

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	filenameBase
protected java.lang.String	key
protected java.io.OutputStream	out
protected java.io.OutputStream	realOutput
static java.lang.String	REVISION
protected boolean	useCompressStream
protected java.lang.String	userLang

Constructor Summary

Constructors

Constructor and Description
RawDataExportHandler()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone()
abstract 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
abstract 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)
abstract void	end(java.io.OutputStream out) Process end of export (after any write)
abstract void	exportFooter(java.io.OutputStream out, java.lang.String[] columnNames) export footer of data
abstract void	exportHeader(java.io.OutputStream out, java.lang.String[] columnNames) Export header of data
abstract void	exportLine(java.io.OutputStream out, java.lang.String[] data) Export a line of data
abstract java.lang.String	getConfigurationFragmentPath() indicates the path of the jsp fragment with driver configuration fields
abstract java.lang.String	getContentType()
abstract java.lang.String	getFileExtension()
java.lang.String	getFilenameBase()
java.lang.String	getKey()
java.io.OutputStream	getOut()
java.lang.String	getUserLang()
abstract void	init(java.io.OutputStream out) Initialise the handler (before any write)
boolean	isUseCompressStream()
void	setFilenameBase(java.lang.String filenameBase)
void	setKey(java.lang.String key)
void	setOut(java.io.OutputStream out)
void	setParameters(JcmsContext context) update handler from parameters form
void	setUseCompressStream(boolean useCompressStream)
void	setUserLang(java.lang.String userLang)
boolean	validateParameters(JcmsContext context) validate current parameter.

Methods inherited from class java.lang.Object

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

Field Detail

REVISION

public static final java.lang.String REVISION

See Also:

Constant Field Values

out

protected java.io.OutputStream out

realOutput

protected java.io.OutputStream realOutput

useCompressStream

protected boolean useCompressStream

key

protected java.lang.String key

userLang

protected java.lang.String userLang

filenameBase

protected java.lang.String filenameBase

Constructor Detail

RawDataExportHandler

public RawDataExportHandler()

Method Detail

getUserLang

public java.lang.String getUserLang()

setUserLang

public void setUserLang(java.lang.String userLang)

getOut

public java.io.OutputStream getOut()

setOut

public void setOut(java.io.OutputStream out)

isUseCompressStream

public boolean isUseCompressStream()

setUseCompressStream

public void setUseCompressStream(boolean useCompressStream)

getKey

public java.lang.String getKey()

setKey

public void setKey(java.lang.String key)

getFilenameBase

public java.lang.String getFilenameBase()

setFilenameBase

public void setFilenameBase(java.lang.String filenameBase)

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

setParameters

public void setParameters(JcmsContext context)

update handler from parameters form

Parameters:

context - the current JcmsContext

validateParameters

public boolean validateParameters(JcmsContext context)

validate current parameter.

Parameters:

context - the JcmsContext

Returns:

true if parameters are valid, false otherwise

getConfigurationFragmentPath

public abstract java.lang.String getConfigurationFragmentPath()

indicates the path of the jsp fragment with driver configuration fields

Returns:

the fragment path

exportLine

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

Export a line of data

Parameters:

out - outputstream associated to this handler

data - the data array

Throws:

java.io.IOException

exportHeader

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

Export header of data

Parameters:

out - outputstream associated to this handler

columnNames - the names of columns

Throws:

java.io.IOException

exportFooter

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

export footer of data

Parameters:

out - outputstream associated to this handler

columnNames - footer data

Throws:

java.io.IOException

init

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

Initialise the handler (before any write)

Parameters:

out - outputstream associated to this handler

Throws:

java.io.IOException

end

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

Process end of export (after any write)

Parameters:

out - outputstream associated to this handler

Throws:

java.io.IOException

convertField

public abstract 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

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 abstract 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)

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

getFileExtension

public abstract java.lang.String getFileExtension()

Returns:

the file extension of generated file

getContentType

public abstract java.lang.String getContentType()

Returns:

the content type of the generated file