org.pentaho.di.trans.steps.exceloutput
Class ExcelOutputMeta

java.lang.Object
  extended by org.pentaho.di.trans.step.BaseStepMeta
      extended by org.pentaho.di.trans.steps.exceloutput.ExcelOutputMeta
All Implemented Interfaces:
Cloneable, StepAttributesInterface, StepMetaInterface

public class ExcelOutputMeta
extends BaseStepMeta
implements StepMetaInterface

Metadata of the Excel Output step.

Since:
on 6-sep-2006
Author:
Matt

Field Summary
static int DEFAULT_FONT_SIZE
           
static int DEFAULT_ROW_HEIGHT
           
static int DEFAULT_ROW_WIDTH
           
static int FONT_ALIGNMENT_CENTER
           
static String[] font_alignment_code
           
static String[] font_alignment_desc
           
static int FONT_ALIGNMENT_FILL
           
static int FONT_ALIGNMENT_GENERAL
           
static int FONT_ALIGNMENT_JUSTIFY
           
static int FONT_ALIGNMENT_LEFT
           
static int FONT_ALIGNMENT_RIGHT
           
static int FONT_COLOR_AQUA
           
static int FONT_COLOR_BLACK
           
static int FONT_COLOR_BLUE
           
static int FONT_COLOR_BLUE_GREY
           
static int FONT_COLOR_BRIGHT_GREEN
           
static int FONT_COLOR_BROWN
           
static String[] font_color_code
           
static int FONT_COLOR_CORAL
           
static int FONT_COLOR_DARK_BLUE
           
static int FONT_COLOR_DARK_GREEN
           
static int FONT_COLOR_DARK_PURPLE
           
static int FONT_COLOR_DARK_RED
           
static int FONT_COLOR_DARK_TEAL
           
static int FONT_COLOR_DARK_YELLOW
           
static String[] font_color_desc
           
static int FONT_COLOR_GOLD
           
static int FONT_COLOR_GREEN
           
static int FONT_COLOR_GREY_25pct
           
static int FONT_COLOR_GREY_40pct
           
static int FONT_COLOR_GREY_50pct
           
static int FONT_COLOR_GREY_80pct
           
static int FONT_COLOR_ICE_BLUE
           
static int FONT_COLOR_IVORY
           
static int FONT_COLOR_LAVENDER
           
static int FONT_COLOR_LIGHT_BLUE
           
static int FONT_COLOR_LIGHT_GREEN
           
static int FONT_COLOR_LIGHT_ORANGE
           
static int FONT_COLOR_LIGHT_TURQUOISE
           
static int FONT_COLOR_LIME
           
static int FONT_COLOR_NONE
           
static int FONT_COLOR_OCEAN_BLUE
           
static int FONT_COLOR_OLIVE_GREEN
           
static int FONT_COLOR_ORANGE
           
static int FONT_COLOR_PALE_BLUE
           
static int FONT_COLOR_PERIWINKLEpct
           
static int FONT_COLOR_PINK
           
static int FONT_COLOR_PLUM
           
static int FONT_COLOR_RED
           
static int FONT_COLOR_ROSE
           
static int FONT_COLOR_SEA_GREEN
           
static int FONT_COLOR_SKY_BLUE
           
static int FONT_COLOR_TAN
           
static int FONT_COLOR_TEAL
           
static int FONT_COLOR_TURQOISE
           
static int FONT_COLOR_TURQUOISE
           
static int FONT_COLOR_VERY_LIGHT_YELLOW
           
static int FONT_COLOR_VIOLET
           
static int FONT_COLOR_WHITE
           
static int FONT_COLOR_YELLOW
           
static int FONT_NAME_ARIAL
           
static String[] font_name_code
           
static int FONT_NAME_COURIER
           
static String[] font_name_desc
           
static int FONT_NAME_TAHOMA
           
static int FONT_NAME_TIMES
           
static String[] font_orientation_code
           
static String[] font_orientation_desc
           
static int FONT_ORIENTATION_HORIZONTAL
           
static int FONT_ORIENTATION_MINUS_45
           
static int FONT_ORIENTATION_MINUS_90
           
static int FONT_ORIENTATION_PLUS_45
           
static int FONT_ORIENTATION_PLUS_90
           
static int FONT_ORIENTATION_STACKED
           
static int FONT_ORIENTATION_VERTICAL
           
static String[] font_underline_code
           
static String[] font_underline_desc
           
static int FONT_UNDERLINE_DOUBLE
           
static int FONT_UNDERLINE_DOUBLE_ACCOUNTING
           
static int FONT_UNDERLINE_NO
           
static int FONT_UNDERLINE_SINGLE
           
static int FONT_UNDERLINE_SINGLE_ACCOUNTING
           
 
Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta
loggingObject, STEP_ATTRIBUTES_FILE
 
Constructor Summary
ExcelOutputMeta()
           
 
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.
 String getDateTimeFormat()
           
 String getEncoding()
           
 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)
           
static int getFontAlignmentByDesc(String tt)
           
static String getFontAlignmentDesc(int i)
           
static int getFontColorByDesc(String tt)
           
static String getFontColorDesc(int i)
           
static int getFontNameByDesc(String tt)
           
static String getFontNameDesc(int i)
           
static int getFontOrientationByDesc(String tt)
           
static String getFontOrientationDesc(int i)
           
static int getFontUnderlineByDesc(String tt)
           
static String getFontUnderlineDesc(int i)
           
 int getHeaderAlignment()
           
 int getHeaderBackGroundColor()
           
 int getHeaderFontColor()
           
 int getHeaderFontName()
           
 int getHeaderFontOrientation()
           
 String getHeaderFontSize()
           
 int getHeaderFontUnderline()
           
 String getHeaderImage()
           
 String getHeaderRowHeight()
           
 String getNewline()
           
 String getNewLine(String fformat)
           
 ExcelField[] getOutputFields()
           
 String getPassword()
           
 int getRowBackGroundColor()
           
 int getRowFontColor()
           
 int getRowFontName()
           
 String getRowFontSize()
           
 String getSheetname()
           
 int getSplitEvery()
           
 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 getTempDirectory()
           
 String getTemplateFileName()
           
 String[] getUsedLibraries()
           
 String getXML()
          Produces the XML string that describes this step's information.
 boolean isAddToResultFiles()
           
 boolean isAppend()
           
 boolean isAutoSizeColums()
           
 boolean isCreateParentFolder()
           
 boolean isDateInFilename()
           
 boolean isDoNotOpenNewFileInit()
           
 boolean isFooterEnabled()
           
 boolean isHeaderEnabled()
           
 boolean isHeaderFontBold()
           
 boolean isHeaderFontItalic()
           
 boolean isNullBlank()
           
 boolean isSheetProtected()
           
 boolean isSpecifyFormat()
           
 boolean isStepNrInFilename()
           
 boolean isTemplateAppend()
           
 boolean isTemplateEnabled()
           
 boolean isTimeInFilename()
           
 boolean isUseTempFiles()
           
 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 setAppend(boolean append)
           
 void setAutoSizeColums(boolean autosizecolums)
           
 void setCreateParentFolder(boolean createparentfolder)
           
 void setDateInFilename(boolean dateInFilename)
           
 void setDateTimeFormat(String date_time_format)
           
 void setDefault()
          Set default values
 void setDoNotOpenNewFileInit(boolean doNotOpenNewFileInit)
           
 void setEncoding(String encoding)
           
 void setExtension(String extension)
           
 void setFileName(String fileName)
           
 void setFooterEnabled(boolean footer)
           
 void setHeaderAlignment(int alignment)
           
 void setHeaderBackGroundColor(int fontcolor)
           
 void setHeaderEnabled(boolean header)
           
 void setHeaderFontBold(boolean font_bold)
           
 void setHeaderFontColor(int fontcolor)
           
 void setHeaderFontItalic(boolean fontitalic)
           
 void setHeaderFontName(int fontname)
           
 void setHeaderFontOrientation(int fontorientation)
           
 void setHeaderFontSize(String fontsize)
           
 void setHeaderFontUnderline(int fontunderline)
           
 void setHeaderImage(String image)
           
 void setHeaderRowHeight(String height)
           
 void setNewline(String newline)
           
 void setNullIsBlank(boolean nullIsBlank)
           
 void setOutputFields(ExcelField[] outputFields)
           
 void setPassword(String password)
           
 void setProtectSheet(boolean protectsheet)
           
 void setRowBackGroundColor(int fontcolor)
           
 void setRowFontColor(int fontcolor)
           
 void setRowFontName(int fontname)
           
 void setRowFontSize(String fontsize)
           
 void setSheetname(String sheetname)
           
 void setSpecifyFormat(boolean SpecifyFormat)
           
 void setSplitEvery(int splitEvery)
           
 void setStepNrInFilename(boolean stepNrInFilename)
           
 void setTempDirectory(String directory)
           
 void setTemplateAppend(boolean templateAppend)
           
 void setTemplateEnabled(boolean template)
           
 void setTemplateFileName(String templateFileName)
           
 void setTimeInFilename(boolean timeInFilename)
           
 void setUseTempFiles(boolean usetempfiles)
           
 
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

FONT_NAME_ARIAL

public static final int FONT_NAME_ARIAL
See Also:
Constant Field Values

FONT_NAME_COURIER

public static final int FONT_NAME_COURIER
See Also:
Constant Field Values

FONT_NAME_TAHOMA

public static final int FONT_NAME_TAHOMA
See Also:
Constant Field Values

FONT_NAME_TIMES

public static final int FONT_NAME_TIMES
See Also:
Constant Field Values

font_name_code

public static final String[] font_name_code

font_name_desc

public static final String[] font_name_desc

FONT_UNDERLINE_NO

public static final int FONT_UNDERLINE_NO
See Also:
Constant Field Values

FONT_UNDERLINE_SINGLE

public static final int FONT_UNDERLINE_SINGLE
See Also:
Constant Field Values

FONT_UNDERLINE_SINGLE_ACCOUNTING

public static final int FONT_UNDERLINE_SINGLE_ACCOUNTING
See Also:
Constant Field Values

FONT_UNDERLINE_DOUBLE

public static final int FONT_UNDERLINE_DOUBLE
See Also:
Constant Field Values

FONT_UNDERLINE_DOUBLE_ACCOUNTING

public static final int FONT_UNDERLINE_DOUBLE_ACCOUNTING
See Also:
Constant Field Values

font_underline_code

public static final String[] font_underline_code

font_underline_desc

public static final String[] font_underline_desc

FONT_ORIENTATION_HORIZONTAL

public static final int FONT_ORIENTATION_HORIZONTAL
See Also:
Constant Field Values

FONT_ORIENTATION_MINUS_45

public static final int FONT_ORIENTATION_MINUS_45
See Also:
Constant Field Values

FONT_ORIENTATION_MINUS_90

public static final int FONT_ORIENTATION_MINUS_90
See Also:
Constant Field Values

FONT_ORIENTATION_PLUS_45

public static final int FONT_ORIENTATION_PLUS_45
See Also:
Constant Field Values

FONT_ORIENTATION_PLUS_90

public static final int FONT_ORIENTATION_PLUS_90
See Also:
Constant Field Values

FONT_ORIENTATION_STACKED

public static final int FONT_ORIENTATION_STACKED
See Also:
Constant Field Values

FONT_ORIENTATION_VERTICAL

public static final int FONT_ORIENTATION_VERTICAL
See Also:
Constant Field Values

font_orientation_code

public static final String[] font_orientation_code

font_orientation_desc

public static final String[] font_orientation_desc

FONT_COLOR_NONE

public static final int FONT_COLOR_NONE
See Also:
Constant Field Values

FONT_COLOR_BLACK

public static final int FONT_COLOR_BLACK
See Also:
Constant Field Values

FONT_COLOR_WHITE

public static final int FONT_COLOR_WHITE
See Also:
Constant Field Values

FONT_COLOR_RED

public static final int FONT_COLOR_RED
See Also:
Constant Field Values

FONT_COLOR_BRIGHT_GREEN

public static final int FONT_COLOR_BRIGHT_GREEN
See Also:
Constant Field Values

FONT_COLOR_BLUE

public static final int FONT_COLOR_BLUE
See Also:
Constant Field Values

FONT_COLOR_YELLOW

public static final int FONT_COLOR_YELLOW
See Also:
Constant Field Values

FONT_COLOR_PINK

public static final int FONT_COLOR_PINK
See Also:
Constant Field Values

FONT_COLOR_TURQUOISE

public static final int FONT_COLOR_TURQUOISE
See Also:
Constant Field Values

FONT_COLOR_DARK_RED

public static final int FONT_COLOR_DARK_RED
See Also:
Constant Field Values

FONT_COLOR_GREEN

public static final int FONT_COLOR_GREEN
See Also:
Constant Field Values

FONT_COLOR_DARK_BLUE

public static final int FONT_COLOR_DARK_BLUE
See Also:
Constant Field Values

FONT_COLOR_DARK_YELLOW

public static final int FONT_COLOR_DARK_YELLOW
See Also:
Constant Field Values

FONT_COLOR_VIOLET

public static final int FONT_COLOR_VIOLET
See Also:
Constant Field Values

FONT_COLOR_TEAL

public static final int FONT_COLOR_TEAL
See Also:
Constant Field Values

FONT_COLOR_GREY_25pct

public static final int FONT_COLOR_GREY_25pct
See Also:
Constant Field Values

FONT_COLOR_GREY_50pct

public static final int FONT_COLOR_GREY_50pct
See Also:
Constant Field Values

FONT_COLOR_PERIWINKLEpct

public static final int FONT_COLOR_PERIWINKLEpct
See Also:
Constant Field Values

FONT_COLOR_PLUM

public static final int FONT_COLOR_PLUM
See Also:
Constant Field Values

FONT_COLOR_IVORY

public static final int FONT_COLOR_IVORY
See Also:
Constant Field Values

FONT_COLOR_LIGHT_TURQUOISE

public static final int FONT_COLOR_LIGHT_TURQUOISE
See Also:
Constant Field Values

FONT_COLOR_DARK_PURPLE

public static final int FONT_COLOR_DARK_PURPLE
See Also:
Constant Field Values

FONT_COLOR_CORAL

public static final int FONT_COLOR_CORAL
See Also:
Constant Field Values

FONT_COLOR_OCEAN_BLUE

public static final int FONT_COLOR_OCEAN_BLUE
See Also:
Constant Field Values

FONT_COLOR_ICE_BLUE

public static final int FONT_COLOR_ICE_BLUE
See Also:
Constant Field Values

FONT_COLOR_TURQOISE

public static final int FONT_COLOR_TURQOISE
See Also:
Constant Field Values

FONT_COLOR_SKY_BLUE

public static final int FONT_COLOR_SKY_BLUE
See Also:
Constant Field Values

FONT_COLOR_LIGHT_GREEN

public static final int FONT_COLOR_LIGHT_GREEN
See Also:
Constant Field Values

FONT_COLOR_VERY_LIGHT_YELLOW

public static final int FONT_COLOR_VERY_LIGHT_YELLOW
See Also:
Constant Field Values

FONT_COLOR_PALE_BLUE

public static final int FONT_COLOR_PALE_BLUE
See Also:
Constant Field Values

FONT_COLOR_ROSE

public static final int FONT_COLOR_ROSE
See Also:
Constant Field Values

FONT_COLOR_LAVENDER

public static final int FONT_COLOR_LAVENDER
See Also:
Constant Field Values

FONT_COLOR_TAN

public static final int FONT_COLOR_TAN
See Also:
Constant Field Values

FONT_COLOR_LIGHT_BLUE

public static final int FONT_COLOR_LIGHT_BLUE
See Also:
Constant Field Values

FONT_COLOR_AQUA

public static final int FONT_COLOR_AQUA
See Also:
Constant Field Values

FONT_COLOR_LIME

public static final int FONT_COLOR_LIME
See Also:
Constant Field Values

FONT_COLOR_GOLD

public static final int FONT_COLOR_GOLD
See Also:
Constant Field Values

FONT_COLOR_LIGHT_ORANGE

public static final int FONT_COLOR_LIGHT_ORANGE
See Also:
Constant Field Values

FONT_COLOR_ORANGE

public static final int FONT_COLOR_ORANGE
See Also:
Constant Field Values

FONT_COLOR_BLUE_GREY

public static final int FONT_COLOR_BLUE_GREY
See Also:
Constant Field Values

FONT_COLOR_GREY_40pct

public static final int FONT_COLOR_GREY_40pct
See Also:
Constant Field Values

FONT_COLOR_DARK_TEAL

public static final int FONT_COLOR_DARK_TEAL
See Also:
Constant Field Values

FONT_COLOR_SEA_GREEN

public static final int FONT_COLOR_SEA_GREEN
See Also:
Constant Field Values

FONT_COLOR_DARK_GREEN

public static final int FONT_COLOR_DARK_GREEN
See Also:
Constant Field Values

FONT_COLOR_OLIVE_GREEN

public static final int FONT_COLOR_OLIVE_GREEN
See Also:
Constant Field Values

FONT_COLOR_BROWN

public static final int FONT_COLOR_BROWN
See Also:
Constant Field Values

FONT_COLOR_GREY_80pct

public static final int FONT_COLOR_GREY_80pct
See Also:
Constant Field Values

font_color_code

public static final String[] font_color_code

font_color_desc

public static final String[] font_color_desc

FONT_ALIGNMENT_LEFT

public static final int FONT_ALIGNMENT_LEFT
See Also:
Constant Field Values

FONT_ALIGNMENT_RIGHT

public static final int FONT_ALIGNMENT_RIGHT
See Also:
Constant Field Values

FONT_ALIGNMENT_CENTER

public static final int FONT_ALIGNMENT_CENTER
See Also:
Constant Field Values

FONT_ALIGNMENT_FILL

public static final int FONT_ALIGNMENT_FILL
See Also:
Constant Field Values

FONT_ALIGNMENT_GENERAL

public static final int FONT_ALIGNMENT_GENERAL
See Also:
Constant Field Values

FONT_ALIGNMENT_JUSTIFY

public static final int FONT_ALIGNMENT_JUSTIFY
See Also:
Constant Field Values

font_alignment_code

public static final String[] font_alignment_code

font_alignment_desc

public static final String[] font_alignment_desc

DEFAULT_FONT_SIZE

public static final int DEFAULT_FONT_SIZE
See Also:
Constant Field Values

DEFAULT_ROW_HEIGHT

public static final int DEFAULT_ROW_HEIGHT
See Also:
Constant Field Values

DEFAULT_ROW_WIDTH

public static final int DEFAULT_ROW_WIDTH
See Also:
Constant Field Values
Constructor Detail

ExcelOutputMeta

public ExcelOutputMeta()
Method Detail

isCreateParentFolder

public boolean isCreateParentFolder()
Returns:
Returns the createparentfolder.

setCreateParentFolder

public void setCreateParentFolder(boolean createparentfolder)
Parameters:
createparentfolder - The createparentfolder to set.

isDateInFilename

public boolean isDateInFilename()
Returns:
Returns the dateInFilename.

setDateInFilename

public void setDateInFilename(boolean dateInFilename)
Parameters:
dateInFilename - The dateInFilename to set.

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.

setTempDirectory

public void setTempDirectory(String directory)

getTempDirectory

public String getTempDirectory()

isNullBlank

public boolean isNullBlank()
Returns:
Returns whether or not null values are written as blank cells.

setNullIsBlank

public void setNullIsBlank(boolean nullIsBlank)
Parameters:
setNullIsBlank - The boolean indicating whether or not to write null values as blank cells

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)

getNewline

public String getNewline()
Returns:
Returns the newline.

setNewline

public void setNewline(String newline)
Parameters:
newline - The newline to set.

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.

isUseTempFiles

public boolean isUseTempFiles()
Returns:
Returns the usetempfile.

setUseTempFiles

public void setUseTempFiles(boolean usetempfiles)
Parameters:
usetempfiles - The usetempfiles to set.

getOutputFields

public ExcelField[] getOutputFields()
Returns:
Returns the outputFields.

setOutputFields

public void setOutputFields(ExcelField[] outputFields)
Parameters:
outputFields - The outputFields to set.

getEncoding

public String getEncoding()
Returns:
The desired encoding of output file, null or empty if the default system encoding needs to be used.

setEncoding

public void setEncoding(String encoding)
Parameters:
encoding - The desired encoding of output file, null or empty if the default system encoding needs to be used.

isTemplateEnabled

public boolean isTemplateEnabled()
Returns:
Returns the template.

setTemplateEnabled

public void setTemplateEnabled(boolean template)
Parameters:
template - The template to set.

isTemplateAppend

public boolean isTemplateAppend()
Returns:
Returns the templateAppend.

setTemplateAppend

public void setTemplateAppend(boolean templateAppend)
Parameters:
templateAppend - The templateAppend to set.

getTemplateFileName

public String getTemplateFileName()
Returns:
Returns the templateFileName.

setTemplateFileName

public void setTemplateFileName(String templateFileName)
Parameters:
templateFileName - The templateFileName to set.

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.

isAppend

public boolean isAppend()
Returns:
Returns the append.

setAppend

public void setAppend(boolean append)
Parameters:
append - The append to set.

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.

getFontNameDesc

public static String getFontNameDesc(int i)

getFontUnderlineDesc

public static String getFontUnderlineDesc(int i)

getFontOrientationDesc

public static String getFontOrientationDesc(int i)

getFontColorDesc

public static String getFontColorDesc(int i)

getFontAlignmentDesc

public static String getFontAlignmentDesc(int i)

getHeaderFontName

public int getHeaderFontName()

getRowFontName

public int getRowFontName()

getHeaderFontUnderline

public int getHeaderFontUnderline()

getHeaderFontOrientation

public int getHeaderFontOrientation()

getHeaderAlignment

public int getHeaderAlignment()

getHeaderFontColor

public int getHeaderFontColor()

getRowFontColor

public int getRowFontColor()

getHeaderBackGroundColor

public int getHeaderBackGroundColor()

getRowBackGroundColor

public int getRowBackGroundColor()

getFontNameByDesc

public static int getFontNameByDesc(String tt)

getFontUnderlineByDesc

public static int getFontUnderlineByDesc(String tt)

getFontOrientationByDesc

public static int getFontOrientationByDesc(String tt)

getFontColorByDesc

public static int getFontColorByDesc(String tt)

getFontAlignmentByDesc

public static int getFontAlignmentByDesc(String tt)

setHeaderFontName

public void setHeaderFontName(int fontname)

setRowFontName

public void setRowFontName(int fontname)

setHeaderFontUnderline

public void setHeaderFontUnderline(int fontunderline)

setHeaderFontOrientation

public void setHeaderFontOrientation(int fontorientation)

setHeaderFontColor

public void setHeaderFontColor(int fontcolor)

setRowFontColor

public void setRowFontColor(int fontcolor)

setHeaderBackGroundColor

public void setHeaderBackGroundColor(int fontcolor)

setRowBackGroundColor

public void setRowBackGroundColor(int fontcolor)

setHeaderAlignment

public void setHeaderAlignment(int alignment)

setHeaderFontSize

public void setHeaderFontSize(String fontsize)

setRowFontSize

public void setRowFontSize(String fontsize)

getHeaderFontSize

public String getHeaderFontSize()

getRowFontSize

public String getRowFontSize()

setHeaderImage

public void setHeaderImage(String image)

getHeaderImage

public String getHeaderImage()

setHeaderRowHeight

public void setHeaderRowHeight(String height)

getHeaderRowHeight

public String getHeaderRowHeight()

isHeaderFontBold

public boolean isHeaderFontBold()

setHeaderFontItalic

public void setHeaderFontItalic(boolean fontitalic)

isHeaderFontItalic

public boolean isHeaderFontItalic()

setHeaderFontBold

public void setHeaderFontBold(boolean font_bold)