|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.pentaho.di.trans.step.BaseStepMeta org.pentaho.di.trans.steps.excelwriter.ExcelWriterStepMeta
public class ExcelWriterStepMeta
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)
Gets the fields. |
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 |
isStreamingData()
|
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 |
setStreamingData(boolean streamingData)
|
void |
setTemplateEnabled(boolean template)
|
void |
setTemplateFileName(String templateFileName)
|
void |
setTemplateSheetEnabled(boolean templateSheetEnabled)
|
void |
setTemplateSheetName(String templateSheetName)
|
void |
setTimeInFilename(boolean timeInFilename)
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String IF_FILE_EXISTS_REUSE
public static final String IF_FILE_EXISTS_CREATE_NEW
public static final String IF_SHEET_EXISTS_REUSE
public static final String IF_SHEET_EXISTS_CREATE_NEW
public static final String ROW_WRITE_OVERWRITE
public static final String ROW_WRITE_PUSH_DOWN
Constructor Detail |
---|
public ExcelWriterStepMeta()
Method Detail |
---|
public int getAppendOffset()
public void setAppendOffset(int appendOffset)
public int getAppendEmpty()
public void setAppendEmpty(int appendEmpty)
public boolean isDateInFilename()
public void setDateInFilename(boolean dateInFilename)
dateInFilename
- The dateInFilename to set.public boolean isAppendOmitHeader()
public void setAppendOmitHeader(boolean appendOmitHeader)
public String getStartingCell()
public void setStartingCell(String startingCell)
public String getRowWritingMethod()
public void setRowWritingMethod(String rowWritingMethod)
public String getIfFileExists()
public void setIfFileExists(String ifFileExists)
public String getIfSheetExists()
public void setIfSheetExists(String ifSheetExists)
public String getProtectedBy()
public void setProtectedBy(String protectedBy)
public String getExtension()
public void setExtension(String extension)
extension
- The extension to set.public String getFileName()
public String getPassword()
public String getSheetname()
public void setSheetname(String sheetname)
sheetname
- The sheet name.public void setFileName(String fileName)
fileName
- The fileName to set.public void setPassword(String password)
password
- teh passwoed to set.public boolean isFooterEnabled()
public void setFooterEnabled(boolean footer)
footer
- The footer to set.public boolean isAutoSizeColums()
public void setAutoSizeColums(boolean autosizecolums)
autosizecolums
- The autosizecolums to set.public boolean isHeaderEnabled()
public void setHeaderEnabled(boolean header)
header
- The header to set.public boolean isSpecifyFormat()
public void setSpecifyFormat(boolean SpecifyFormat)
public String getDateTimeFormat()
public void setDateTimeFormat(String date_time_format)
public int getSplitEvery()
public boolean isAddToResultFiles()
public void setAddToResultFiles(boolean addtoresultfilenamesin)
addtoresultfilenamesin
- The addtoresultfilenames to set.public void setSplitEvery(int splitEvery)
splitEvery
- The splitEvery to set.public boolean isStepNrInFilename()
public void setStepNrInFilename(boolean stepNrInFilename)
stepNrInFilename
- The stepNrInFilename to set.public boolean isTimeInFilename()
public boolean isSheetProtected()
public void setTimeInFilename(boolean timeInFilename)
timeInFilename
- The timeInFilename to set.public void setProtectSheet(boolean protectsheet)
protectsheet
- the value to set.public ExcelWriterStepField[] getOutputFields()
public void setOutputFields(ExcelWriterStepField[] outputFields)
outputFields
- The outputFields to set.public boolean isTemplateEnabled()
public void setTemplateEnabled(boolean template)
template
- The template to set.public boolean isTemplateSheetEnabled()
public void setTemplateSheetEnabled(boolean templateSheetEnabled)
public String getTemplateFileName()
public void setTemplateFileName(String templateFileName)
templateFileName
- The templateFileName to set.public String getTemplateSheetName()
public void setTemplateSheetName(String templateSheetName)
public boolean isDoNotOpenNewFileInit()
public void setDoNotOpenNewFileInit(boolean doNotOpenNewFileInit)
doNotOpenNewFileInit
- The "do not open new file at init" flag to set.public boolean isAppendLines()
public void setAppendLines(boolean append)
appendLines
- The appendLines to set.public void setMakeSheetActive(boolean makeSheetActive)
public boolean isMakeSheetActive()
public boolean isForceFormulaRecalculation()
public void setForceFormulaRecalculation(boolean forceFormulaRecalculation)
public boolean isLeaveExistingStylesUnchanged()
public void setLeaveExistingStylesUnchanged(boolean leaveExistingStylesUnchanged)
public void loadXML(Node stepnode, List<DatabaseMeta> databases, Map<String,Counter> counters) throws KettleXMLException
StepMetaInterface
loadXML
in interface StepMetaInterface
stepnode
- the Node to get the info fromdatabases
- The available list of databases to reference tocounters
- Counters to reference.
KettleXMLException
- When an unexpected XML error occurred. (malformed etc.)public void allocate(int nrfields)
public Object clone()
StepMetaInterface
clone
in interface StepMetaInterface
clone
in class BaseStepMeta
public String getNewLine(String fformat)
public void setDefault()
StepMetaInterface
setDefault
in interface StepMetaInterface
public String[] getFiles(VariableSpace space)
public String buildFilename(VariableSpace space, int stepnr, int splitnr)
public void getFields(RowMetaInterface r, String name, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space)
BaseStepMeta
getFields
in interface StepMetaInterface
getFields
in class BaseStepMeta
r
- the input row metaname
- the nameinfo
- the infonextStep
- the next stepspace
- the spacepublic String getXML()
BaseStepMeta
getXML
in interface StepMetaInterface
getXML
in class BaseStepMeta
public void readRep(Repository rep, ObjectId id_step, List<DatabaseMeta> databases, Map<String,Counter> counters) throws KettleException
StepMetaInterface
readRep
in interface StepMetaInterface
rep
- The repository to read fromid_step
- The step IDdatabases
- The databases to referencecounters
- The counters to reference
KettleException
- When an unexpected error occurred (database, network, etc)public void saveRep(Repository rep, ObjectId id_transformation, ObjectId id_step) throws KettleException
StepMetaInterface
saveRep
in interface StepMetaInterface
rep
- The Kettle repository to save toid_transformation
- The transformation IDid_step
- The step ID
KettleException
- When an unexpected error occurred (database, network, etc)public void check(List<CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepMeta, RowMetaInterface prev, String[] input, String[] output, RowMetaInterface info)
StepMetaInterface
check
in interface StepMetaInterface
remarks
- The list to put the remarks in @see org.pentaho.di.core.CheckResultstepMeta
- The stepMeta to help checkingprev
- The fields coming from the previous stepinput
- The input step namesoutput
- The output step namesinfo
- The fields that are used as information by the steppublic String exportResources(VariableSpace space, Map<String,ResourceDefinition> definitions, ResourceNamingInterface resourceNamingInterface, Repository repository) throws KettleException
exportResources
in interface StepMetaInterface
exportResources
in class BaseStepMeta
space
- the spacedefinitions
- the definitionsresourceNamingInterface
- the resource naming interfacerepository
- the repository
KettleException
- the kettle exceptionpublic StepInterface getStep(StepMeta stepMeta, StepDataInterface stepDataInterface, int cnr, TransMeta transMeta, Trans trans)
StepMetaInterface
getStep
in interface StepMetaInterface
stepMeta
- The step infostepDataInterface
- the step data interface linked to this step. Here the step can store temporary data, database connections, etc.cnr
- The copy nr to gettransMeta
- The transformation infotrans
- The launching transformationpublic StepDataInterface getStepData()
StepMetaInterface
getStepData
in interface StepMetaInterface
public String[] getUsedLibraries()
getUsedLibraries
in interface StepMetaInterface
getUsedLibraries
in class BaseStepMeta
public boolean isStreamingData()
public void setStreamingData(boolean streamingData)
streamingData
- the streamingData to set
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |