org.pentaho.di.trans.steps.excelwriter
Class ExcelWriterStepMeta

java.lang.Object
  org.pentaho.di.trans.step.BaseStepMeta
      org.pentaho.di.trans.steps.excelwriter.ExcelWriterStepMeta

All Implemented Interfaces:

Cloneable, StepAttributesInterface, StepMetaInterface

public class ExcelWriterStepMeta
extends BaseStepMeta
implements StepMetaInterface

Field Summary

static String	IF_FILE_EXISTS_CREATE_NEW
static String	IF_FILE_EXISTS_REUSE
static String	IF_SHEET_EXISTS_CREATE_NEW
static String	IF_SHEET_EXISTS_REUSE
static String	ROW_WRITE_OVERWRITE
static String	ROW_WRITE_PUSH_DOWN

Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta

loggingObject, STEP_ATTRIBUTES_FILE

Constructor Summary

ExcelWriterStepMeta()

Method Summary

void	allocate(int nrfields)
String	buildFilename(VariableSpace space, int stepnr, int splitnr)
void	check(List<CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepMeta, RowMetaInterface prev, String[] input, String[] output, RowMetaInterface info) Checks the settings of this step and puts the findings in a remarks List.
Object	clone() Make an exact copy of this step, make sure to explicitly copy Collections etc.
String	exportResources(VariableSpace space, Map<String,ResourceDefinition> definitions, ResourceNamingInterface resourceNamingInterface, Repository repository) Since the exported transformation that runs this will reside in a ZIP file, we can't reference files relatively.
int	getAppendEmpty()
int	getAppendOffset()
String	getDateTimeFormat()
String	getExtension()
void	getFields(RowMetaInterface r, String name, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space) Get the fields that are emitted by this step
String	getFileName()
String[]	getFiles(VariableSpace space)
String	getIfFileExists()
String	getIfSheetExists()
String	getNewLine(String fformat)
ExcelWriterStepField[]	getOutputFields()
String	getPassword()
String	getProtectedBy()
String	getRowWritingMethod()
String	getSheetname()
int	getSplitEvery()
String	getStartingCell()
StepInterface	getStep(StepMeta stepMeta, StepDataInterface stepDataInterface, int cnr, TransMeta transMeta, Trans trans) Get the executing step, needed by Trans to launch a step.
StepDataInterface	getStepData() Get a new instance of the appropriate data class.
String	getTemplateFileName()
String	getTemplateSheetName()
String[]	getUsedLibraries()
String	getXML() Produces the XML string that describes this step's information.
boolean	isAddToResultFiles()
boolean	isAppendLines()
boolean	isAppendOmitHeader()
boolean	isAutoSizeColums()
boolean	isDateInFilename()
boolean	isDoNotOpenNewFileInit()
boolean	isFooterEnabled()
boolean	isForceFormulaRecalculation()
boolean	isHeaderEnabled()
boolean	isLeaveExistingStylesUnchanged()
boolean	isMakeSheetActive()
boolean	isSheetProtected()
boolean	isSpecifyFormat()
boolean	isStepNrInFilename()
boolean	isTemplateEnabled()
boolean	isTemplateSheetEnabled()
boolean	isTimeInFilename()
void	loadXML(Node stepnode, List<DatabaseMeta> databases, Map<String,Counter> counters) Load the values for this step from an XML Node
void	readRep(Repository rep, ObjectId id_step, List<DatabaseMeta> databases, Map<String,Counter> counters) Read the steps information from a Kettle repository
void	saveRep(Repository rep, ObjectId id_transformation, ObjectId id_step) Save the steps data into a Kettle repository
void	setAddToResultFiles(boolean addtoresultfilenamesin)
void	setAppendEmpty(int appendEmpty)
void	setAppendLines(boolean append)
void	setAppendOffset(int appendOffset)
void	setAppendOmitHeader(boolean appendOmitHeader)
void	setAutoSizeColums(boolean autosizecolums)
void	setDateInFilename(boolean dateInFilename)
void	setDateTimeFormat(String date_time_format)
void	setDefault() Set default values
void	setDoNotOpenNewFileInit(boolean doNotOpenNewFileInit)
void	setExtension(String extension)
void	setFileName(String fileName)
void	setFooterEnabled(boolean footer)
void	setForceFormulaRecalculation(boolean forceFormulaRecalculation)
void	setHeaderEnabled(boolean header)
void	setIfFileExists(String ifFileExists)
void	setIfSheetExists(String ifSheetExists)
void	setLeaveExistingStylesUnchanged(boolean leaveExistingStylesUnchanged)
void	setMakeSheetActive(boolean makeSheetActive)
void	setOutputFields(ExcelWriterStepField[] outputFields)
void	setPassword(String password)
void	setProtectedBy(String protectedBy)
void	setProtectSheet(boolean protectsheet)
void	setRowWritingMethod(String rowWritingMethod)
void	setSheetname(String sheetname)
void	setSpecifyFormat(boolean SpecifyFormat)
void	setSplitEvery(int splitEvery)
void	setStartingCell(String startingCell)
void	setStepNrInFilename(boolean stepNrInFilename)
void	setTemplateEnabled(boolean template)
void	setTemplateFileName(String templateFileName)
void	setTemplateSheetEnabled(boolean templateSheetEnabled)
void	setTemplateSheetName(String templateSheetName)
void	setTimeInFilename(boolean timeInFilename)

Methods inherited from class org.pentaho.di.trans.step.BaseStepMeta

analyseImpact, cancelQueries, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, findAttribute, findParent, getDescription, getDialogClassName, getLog, getLogChannelId, getName, getObjectCopy, getObjectId, getObjectRevision, getObjectType, getOptionalStreams, getParent, getParentStepMeta, getRepCode, getRepositoryDirectory, getRequiredFields, getRequiredFields, getResourceDependencies, getSQLStatements, getStepInjectionMetadataEntries, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getTooltip, getUsedArguments, getUsedDatabaseConnections, getXmlCode, handleStreamSelection, hasChanged, hasRepositoryReferences, isBasic, isDebug, isDetailed, isRowLevel, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, lookupRepositoryReferences, resetStepIoMeta, searchInfoAndTargetSteps, setChanged, setChanged, setParentStepMeta, supportsErrorHandling

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pentaho.di.trans.step.StepMetaInterface

analyseImpact, cancelQueries, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, getDialogClassName, getOptionalStreams, getParentStepMeta, getRequiredFields, getResourceDependencies, getSQLStatements, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedDatabaseConnections, handleStreamSelection, hasRepositoryReferences, lookupRepositoryReferences, resetStepIoMeta, searchInfoAndTargetSteps, setParentStepMeta, supportsErrorHandling

Field Detail

IF_FILE_EXISTS_REUSE

public static final String IF_FILE_EXISTS_REUSE

See Also:

Constant Field Values

IF_FILE_EXISTS_CREATE_NEW

public static final String IF_FILE_EXISTS_CREATE_NEW

See Also:

Constant Field Values

IF_SHEET_EXISTS_REUSE

public static final String IF_SHEET_EXISTS_REUSE

See Also:

Constant Field Values

IF_SHEET_EXISTS_CREATE_NEW

public static final String IF_SHEET_EXISTS_CREATE_NEW

See Also:

Constant Field Values

ROW_WRITE_OVERWRITE

public static final String ROW_WRITE_OVERWRITE

See Also:

Constant Field Values

ROW_WRITE_PUSH_DOWN

public static final String ROW_WRITE_PUSH_DOWN

See Also:

Constant Field Values

Constructor Detail

ExcelWriterStepMeta

public ExcelWriterStepMeta()

Method Detail

getAppendOffset

public int getAppendOffset()

setAppendOffset

public void setAppendOffset(int appendOffset)

getAppendEmpty

public int getAppendEmpty()

setAppendEmpty

public void setAppendEmpty(int appendEmpty)

isDateInFilename

public boolean isDateInFilename()

Returns:

Returns the dateInFilename.

setDateInFilename

public void setDateInFilename(boolean dateInFilename)

Parameters:

dateInFilename - The dateInFilename to set.

isAppendOmitHeader

public boolean isAppendOmitHeader()

setAppendOmitHeader

public void setAppendOmitHeader(boolean appendOmitHeader)

getStartingCell

public String getStartingCell()

setStartingCell

public void setStartingCell(String startingCell)

getRowWritingMethod

public String getRowWritingMethod()

setRowWritingMethod

public void setRowWritingMethod(String rowWritingMethod)

getIfFileExists

public String getIfFileExists()

setIfFileExists

public void setIfFileExists(String ifFileExists)

getIfSheetExists

public String getIfSheetExists()

setIfSheetExists

public void setIfSheetExists(String ifSheetExists)

getProtectedBy

public String getProtectedBy()

setProtectedBy

public void setProtectedBy(String protectedBy)

getExtension

public String getExtension()

Returns:

Returns the extension.

setExtension

public void setExtension(String extension)

Parameters:

extension - The extension to set.

getFileName

public String getFileName()

Returns:

Returns the fileName.

getPassword

public String getPassword()

Returns:

Returns the password.

getSheetname

public String getSheetname()

Returns:

Returns the sheet name.

setSheetname

public void setSheetname(String sheetname)

Parameters:

sheetname - The sheet name.

setFileName

public void setFileName(String fileName)

Parameters:

fileName - The fileName to set.

setPassword

public void setPassword(String password)

Parameters:

password - teh passwoed to set.

isFooterEnabled

public boolean isFooterEnabled()

Returns:

Returns the footer.

setFooterEnabled

public void setFooterEnabled(boolean footer)

Parameters:

footer - The footer to set.

isAutoSizeColums

public boolean isAutoSizeColums()

Returns:

Returns the autosizecolums.

setAutoSizeColums

public void setAutoSizeColums(boolean autosizecolums)

Parameters:

autosizecolums - The autosizecolums to set.

isHeaderEnabled

public boolean isHeaderEnabled()

Returns:

Returns the header.

setHeaderEnabled

public void setHeaderEnabled(boolean header)

Parameters:

header - The header to set.

isSpecifyFormat

public boolean isSpecifyFormat()

setSpecifyFormat

public void setSpecifyFormat(boolean SpecifyFormat)

getDateTimeFormat

public String getDateTimeFormat()

setDateTimeFormat

public void setDateTimeFormat(String date_time_format)

getSplitEvery

public int getSplitEvery()

Returns:

Returns the splitEvery.

isAddToResultFiles

public boolean isAddToResultFiles()

Returns:

Returns the add to result filesname.

setAddToResultFiles

public void setAddToResultFiles(boolean addtoresultfilenamesin)

Parameters:

addtoresultfilenamesin - The addtoresultfilenames to set.

setSplitEvery

public void setSplitEvery(int splitEvery)

Parameters:

splitEvery - The splitEvery to set.

isStepNrInFilename

public boolean isStepNrInFilename()

Returns:

Returns the stepNrInFilename.

setStepNrInFilename

public void setStepNrInFilename(boolean stepNrInFilename)

Parameters:

stepNrInFilename - The stepNrInFilename to set.

isTimeInFilename

public boolean isTimeInFilename()

Returns:

Returns the timeInFilename.

isSheetProtected

public boolean isSheetProtected()

Returns:

Returns the protectsheet.

setTimeInFilename

public void setTimeInFilename(boolean timeInFilename)

Parameters:

timeInFilename - The timeInFilename to set.

setProtectSheet

public void setProtectSheet(boolean protectsheet)

Parameters:

protectsheet - the value to set.

getOutputFields

public ExcelWriterStepField[] getOutputFields()

Returns:

Returns the outputFields.

setOutputFields

public void setOutputFields(ExcelWriterStepField[] outputFields)

Parameters:

outputFields - The outputFields to set.

isTemplateEnabled

public boolean isTemplateEnabled()

Returns:

Returns the template.

setTemplateEnabled

public void setTemplateEnabled(boolean template)

Parameters:

template - The template to set.

isTemplateSheetEnabled

public boolean isTemplateSheetEnabled()

setTemplateSheetEnabled

public void setTemplateSheetEnabled(boolean templateSheetEnabled)

getTemplateFileName

public String getTemplateFileName()

Returns:

Returns the templateFileName.

setTemplateFileName

public void setTemplateFileName(String templateFileName)

Parameters:

templateFileName - The templateFileName to set.

getTemplateSheetName

public String getTemplateSheetName()

setTemplateSheetName

public void setTemplateSheetName(String templateSheetName)

isDoNotOpenNewFileInit

public boolean isDoNotOpenNewFileInit()

Returns:

Returns the "do not open new file at init" flag.

setDoNotOpenNewFileInit

public void setDoNotOpenNewFileInit(boolean doNotOpenNewFileInit)

Parameters:

doNotOpenNewFileInit - The "do not open new file at init" flag to set.

isAppendLines

public boolean isAppendLines()

Returns:

Returns the appendLines.

setAppendLines

public void setAppendLines(boolean append)

Parameters:

appendLines - The appendLines to set.

setMakeSheetActive

public void setMakeSheetActive(boolean makeSheetActive)

isMakeSheetActive

public boolean isMakeSheetActive()

isForceFormulaRecalculation

public boolean isForceFormulaRecalculation()

setForceFormulaRecalculation

public void setForceFormulaRecalculation(boolean forceFormulaRecalculation)

isLeaveExistingStylesUnchanged

public boolean isLeaveExistingStylesUnchanged()

setLeaveExistingStylesUnchanged

public void setLeaveExistingStylesUnchanged(boolean leaveExistingStylesUnchanged)

loadXML

public void loadXML(Node stepnode,
                    List<DatabaseMeta> databases,
                    Map<String,Counter> counters)
             throws KettleXMLException

Description copied from interface: StepMetaInterface

Load the values for this step from an XML Node

Specified by:

loadXML in interface StepMetaInterface

Parameters:

stepnode - the Node to get the info from

databases - The available list of databases to reference to

counters - Counters to reference.

Throws:

KettleXMLException - When an unexpected XML error occurred. (malformed etc.)

allocate

public void allocate(int nrfields)

clone

public Object clone()

Description copied from interface: StepMetaInterface

Make an exact copy of this step, make sure to explicitly copy Collections etc.

Specified by:

clone in interface StepMetaInterface

Overrides:

clone in class BaseStepMeta

Returns:

an exact copy of this step

getNewLine

public String getNewLine(String fformat)

setDefault

public void setDefault()

Description copied from interface: StepMetaInterface

Set default values

Specified by:

setDefault in interface StepMetaInterface

getFiles

public String[] getFiles(VariableSpace space)

buildFilename

public String buildFilename(VariableSpace space,
                            int stepnr,
                            int splitnr)

getFields

public void getFields(RowMetaInterface r,
                      String name,
                      RowMetaInterface[] info,
                      StepMeta nextStep,
                      VariableSpace space)

Description copied from interface: StepMetaInterface

Get the fields that are emitted by this step

Specified by:

getFields in interface StepMetaInterface

Overrides:

getFields in class BaseStepMeta

Parameters:

r - The fields that are entering the step. These are changed to reflect the output metadata.

name - The name of the step to be used as origin

info - The input rows metadata that enters the step through the specified channels in the same order as in method getInfoSteps(). The step metadata can then choose what to do with it: ignore it or not. Interesting is also that in case of database lookups, the layout of the target database table is put in info[0]

nextStep - if this is a non-null value, it's the next step in the transformation. The one who's asking, the step where the data is targetted towards.

space - TODO

getXML

public String getXML()

Description copied from class: BaseStepMeta

Produces the XML string that describes this step's information.

Specified by:

getXML in interface StepMetaInterface

Overrides:

getXML in class BaseStepMeta

Returns:

String containing the XML describing this step.

readRep

public void readRep(Repository rep,
                    ObjectId id_step,
                    List<DatabaseMeta> databases,
                    Map<String,Counter> counters)
             throws KettleException

Description copied from interface: StepMetaInterface

Read the steps information from a Kettle repository

Specified by:

readRep in interface StepMetaInterface

Parameters:

rep - The repository to read from

id_step - The step ID

databases - The databases to reference

counters - The counters to reference

Throws:

KettleException - When an unexpected error occurred (database, network, etc)

saveRep

public void saveRep(Repository rep,
                    ObjectId id_transformation,
                    ObjectId id_step)
             throws KettleException

Description copied from interface: StepMetaInterface

Save the steps data into a Kettle repository

Specified by:

saveRep in interface StepMetaInterface

Parameters:

rep - The Kettle repository to save to

id_transformation - The transformation ID

id_step - The step ID

Throws:

KettleException - When an unexpected error occurred (database, network, etc)

check

public void check(List<CheckResultInterface> remarks,
                  TransMeta transMeta,
                  StepMeta stepMeta,
                  RowMetaInterface prev,
                  String[] input,
                  String[] output,
                  RowMetaInterface info)

Description copied from interface: StepMetaInterface

Checks the settings of this step and puts the findings in a remarks List.

Specified by:

check in interface StepMetaInterface

Parameters:

remarks - The list to put the remarks in @see org.pentaho.di.core.CheckResult

stepMeta - The stepMeta to help checking

prev - The fields coming from the previous step

input - The input step names

output - The output step names

info - The fields that are used as information by the step

exportResources

public String exportResources(VariableSpace space,
                              Map<String,ResourceDefinition> definitions,
                              ResourceNamingInterface resourceNamingInterface,
                              Repository repository)
                       throws KettleException

Since the exported transformation that runs this will reside in a ZIP file, we can't reference files relatively. So what this does is turn the name of the base path into an absolute path.

Specified by:

exportResources in interface StepMetaInterface

Overrides:

exportResources in class BaseStepMeta

Parameters:

space - the variable space to use

repository - The repository to optionally load other resources from (to be converted to XML)

Returns:

the filename of the exported resource

Throws:

KettleException

getStep

public StepInterface getStep(StepMeta stepMeta,
                             StepDataInterface stepDataInterface,
                             int cnr,
                             TransMeta transMeta,
                             Trans trans)

Description copied from interface: StepMetaInterface

Get the executing step, needed by Trans to launch a step.

Specified by:

getStep in interface StepMetaInterface

Parameters:

stepMeta - The step info

stepDataInterface - the step data interface linked to this step. Here the step can store temporary data, database connections, etc.

cnr - The copy nr to get

transMeta - The transformation info

trans - The launching transformation

getStepData

public StepDataInterface getStepData()

Description copied from interface: StepMetaInterface

Get a new instance of the appropriate data class. This data class implements the StepDataInterface. It basically contains the persisting data that needs to live on, even if a worker thread is terminated.

Specified by:

getStepData in interface StepMetaInterface

Returns:

The appropriate StepDataInterface class.

getUsedLibraries

public String[] getUsedLibraries()

Specified by:

getUsedLibraries in interface StepMetaInterface

Overrides:

getUsedLibraries in class BaseStepMeta

Returns:

the libraries that this step or plug-in uses.