|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.pentaho.di.trans.step.BaseStepMeta
org.pentaho.di.trans.steps.exceloutput.ExcelOutputMeta
public class ExcelOutputMeta
Metadata of the Excel Output step.
Constructor Summary | |
---|---|
ExcelOutputMeta()
|
Method Summary | |
---|---|
void |
allocate(int nrfields)
|
String |
buildFilename(org.pentaho.di.core.variables.VariableSpace space,
int stepnr,
int splitnr)
|
void |
check(List<org.pentaho.di.core.CheckResultInterface> remarks,
TransMeta transMeta,
StepMeta stepMeta,
org.pentaho.di.core.row.RowMetaInterface prev,
String[] input,
String[] output,
org.pentaho.di.core.row.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(org.pentaho.di.core.variables.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(org.pentaho.di.core.row.RowMetaInterface r,
String name,
org.pentaho.di.core.row.RowMetaInterface[] info,
StepMeta nextStep,
org.pentaho.di.core.variables.VariableSpace space)
Get the fields that are emitted by this step |
String |
getFileName()
|
String[] |
getFiles(org.pentaho.di.core.variables.VariableSpace space)
|
String |
getNewline()
|
String |
getNewLine(String fformat)
|
ExcelField[] |
getOutputFields()
|
String |
getPassword()
|
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 |
getTemplateFileName()
|
String[] |
getUsedLibraries()
|
String |
getXML()
Produces the XML string that describes this step's information. |
boolean |
isAddToResultFiles()
|
boolean |
isAppend()
|
boolean |
isAutoSizeColums()
|
boolean |
isDateInFilename()
|
boolean |
isDoNotOpenNewFileInit()
|
boolean |
isFooterEnabled()
|
boolean |
isHeaderEnabled()
|
boolean |
isSheetProtected()
|
boolean |
isSpecifyFormat()
|
boolean |
isStepNrInFilename()
|
boolean |
isTemplateAppend()
|
boolean |
isTemplateEnabled()
|
boolean |
isTimeInFilename()
|
void |
loadXML(Node stepnode,
List<org.pentaho.di.core.database.DatabaseMeta> databases,
Map<String,org.pentaho.di.core.Counter> counters)
Load the values for this step from an XML Node |
void |
readRep(Repository rep,
long id_step,
List<org.pentaho.di.core.database.DatabaseMeta> databases,
Map<String,org.pentaho.di.core.Counter> counters)
Read the steps information from a Kettle repository |
void |
saveRep(Repository rep,
long id_transformation,
long id_step)
Save the steps data into a Kettle repository |
void |
setAddToResultFiles(boolean addtoresultfilenamesin)
|
void |
setAppend(boolean append)
|
void |
setAutoSizeColums(boolean autosizecolums)
|
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 |
setHeaderEnabled(boolean header)
|
void |
setNewline(String newline)
|
void |
setOutputFields(ExcelField[] outputFields)
|
void |
setPassword(String password)
|
void |
setProtectSheet(boolean protectsheet)
|
void |
setSheetname(String sheetname)
|
void |
setSpecifyFormat(boolean SpecifyFormat)
|
void |
setSplitEvery(int splitEvery)
|
void |
setStepNrInFilename(boolean stepNrInFilename)
|
void |
setTemplateAppend(boolean templateAppend)
|
void |
setTemplateEnabled(boolean template)
|
void |
setTemplateFileName(String templateFileName)
|
void |
setTimeInFilename(boolean timeInFilename)
|
Methods inherited from class org.pentaho.di.trans.step.BaseStepMeta |
---|
analyseImpact, cancelQueries, chosesTargetSteps, excludeFromRowLayoutVerification, getDialogClassName, getID, getInfoSteps, getRequiredFields, getRequiredFields, getResourceDependencies, getSQLStatements, getTableFields, getTargetSteps, getUsedArguments, getUsedDatabaseConnections, hasChanged, searchInfoAndTargetSteps, setChanged, setChanged, setID, setInfoSteps, setTargetSteps, 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, excludeFromRowLayoutVerification, getDialogClassName, getInfoSteps, getRequiredFields, getRequiredFields, getResourceDependencies, getSQLStatements, getTableFields, getTargetSteps, getUsedArguments, getUsedDatabaseConnections, searchInfoAndTargetSteps, setInfoSteps, setTargetSteps, supportsErrorHandling |
Constructor Detail |
---|
public ExcelOutputMeta()
Method Detail |
---|
public boolean isDateInFilename()
public void setDateInFilename(boolean dateInFilename)
dateInFilename
- The dateInFilename to set.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 String getNewline()
public void setNewline(String newline)
newline
- The newline to set.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 ExcelField[] getOutputFields()
public void setOutputFields(ExcelField[] outputFields)
outputFields
- The outputFields to set.public String getEncoding()
public void setEncoding(String encoding)
encoding
- The desired encoding of output file, null or empty if the default system encoding needs to be used.public boolean isTemplateEnabled()
public void setTemplateEnabled(boolean template)
template
- The template to set.public boolean isTemplateAppend()
public void setTemplateAppend(boolean templateAppend)
templateAppend
- The templateAppend to set.public String getTemplateFileName()
public void setTemplateFileName(String templateFileName)
templateFileName
- The templateFileName to set.public boolean isDoNotOpenNewFileInit()
public void setDoNotOpenNewFileInit(boolean doNotOpenNewFileInit)
doNotOpenNewFileInit
- The "do not open new file at init" flag to set.public boolean isAppend()
public void setAppend(boolean append)
append
- The append to set.public void loadXML(Node stepnode, List<org.pentaho.di.core.database.DatabaseMeta> databases, Map<String,org.pentaho.di.core.Counter> counters) throws org.pentaho.di.core.exception.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.
org.pentaho.di.core.exception.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(org.pentaho.di.core.variables.VariableSpace space)
public String buildFilename(org.pentaho.di.core.variables.VariableSpace space, int stepnr, int splitnr)
public void getFields(org.pentaho.di.core.row.RowMetaInterface r, String name, org.pentaho.di.core.row.RowMetaInterface[] info, StepMeta nextStep, org.pentaho.di.core.variables.VariableSpace space)
StepMetaInterface
getFields
in interface StepMetaInterface
getFields
in class BaseStepMeta
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 origininfo
- 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
- TODOpublic String getXML()
BaseStepMeta
getXML
in interface StepMetaInterface
getXML
in class BaseStepMeta
public void readRep(Repository rep, long id_step, List<org.pentaho.di.core.database.DatabaseMeta> databases, Map<String,org.pentaho.di.core.Counter> counters) throws org.pentaho.di.core.exception.KettleException
StepMetaInterface
readRep
in interface StepMetaInterface
rep
- The repository to read fromid_step
- The step IDdatabases
- The databases to referencecounters
- The counters to reference
org.pentaho.di.core.exception.KettleException
- When an unexpected error occurred (database, network, etc)public void saveRep(Repository rep, long id_transformation, long id_step) throws org.pentaho.di.core.exception.KettleException
StepMetaInterface
saveRep
in interface StepMetaInterface
rep
- The Kettle repository to save toid_transformation
- The transformation IDid_step
- The step ID
org.pentaho.di.core.exception.KettleException
- When an unexpected error occurred (database, network, etc)public void check(List<org.pentaho.di.core.CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepMeta, org.pentaho.di.core.row.RowMetaInterface prev, String[] input, String[] output, org.pentaho.di.core.row.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(org.pentaho.di.core.variables.VariableSpace space, Map<String,ResourceDefinition> definitions, ResourceNamingInterface resourceNamingInterface, Repository repository) throws org.pentaho.di.core.exception.KettleException
exportResources
in interface StepMetaInterface
exportResources
in class BaseStepMeta
space
- the variable space to userepository
- The repository to optionally load other resources from (to be converted to XML)
org.pentaho.di.core.exception.KettleException
public 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
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |