|
||||||||||
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.xmloutput.XMLOutputMeta
public class XMLOutputMeta
This class knows how to handle the MetaData for the XML output step
Field Summary |
---|
Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta |
---|
loggingObject, STEP_ATTRIBUTES_FILE |
Constructor Summary | |
---|---|
XMLOutputMeta()
|
Method Summary | |
---|---|
void |
allocate(int nrfields)
|
String |
buildFilename(VariableSpace space,
int stepnr,
int splitnr,
boolean ziparchive)
|
void |
check(List<CheckResultInterface> remarks,
TransMeta transMeta,
StepMeta stepinfo,
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 row,
String name,
RowMetaInterface[] info,
StepMeta nextStep,
VariableSpace space)
Gets the fields. |
String |
getFileName()
|
String[] |
getFiles(VariableSpace space)
|
String |
getMainElement()
|
String |
getNameSpace()
|
String |
getNewLine(String fformat)
|
XMLField[] |
getOutputFields()
|
String |
getRepeatElement()
|
RowMetaInterface |
getRequiredFields(VariableSpace space)
The natural way of data flow in a transformation is source-to-target. |
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 |
getXML()
Produces the XML string that describes this step's information. |
boolean |
isAddToResultFiles()
|
boolean |
isDateInFilename()
|
boolean |
isDoNotOpenNewFileInit()
|
boolean |
isOmitNullValues()
|
boolean |
isServletOutput()
|
boolean |
isSpecifyFormat()
|
boolean |
isStepNrInFilename()
|
boolean |
isTimeInFilename()
|
boolean |
isZipped()
|
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 |
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 |
setMainElement(String mainElement)
|
void |
setNameSpace(String nameSpace)
|
void |
setOmitNullValues(boolean omitNullValues)
|
void |
setOutputFields(XMLField[] outputFields)
|
void |
setRepeatElement(String repeatElement)
|
void |
setServletOutput(boolean servletOutput)
|
void |
setSpecifyFormat(boolean SpecifyFormat)
|
void |
setSplitEvery(int splitEvery)
|
void |
setStepNrInFilename(boolean stepNrInFilename)
|
void |
setTimeInFilename(boolean timeInFilename)
|
void |
setZipped(boolean zipped)
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public XMLOutputMeta()
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 boolean isDoNotOpenNewFileInit()
public void setDoNotOpenNewFileInit(boolean doNotOpenNewFileInit)
doNotOpenNewFileInit
- The "do not open new file at init" flag to set.public String getFileName()
public void setFileName(String fileName)
fileName
- The fileName to set.public int getSplitEvery()
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 void setTimeInFilename(boolean timeInFilename)
timeInFilename
- The timeInFilename to set.public boolean isAddToResultFiles()
public void setAddToResultFiles(boolean addtoresultfilenamesin)
addtoresultfilenamesin
- The addtoresultfilenames to set.public boolean isSpecifyFormat()
public void setSpecifyFormat(boolean SpecifyFormat)
public String getDateTimeFormat()
public void setDateTimeFormat(String date_time_format)
public boolean isZipped()
public void setZipped(boolean zipped)
zipped
- The zipped to set.public XMLField[] getOutputFields()
public void setOutputFields(XMLField[] outputFields)
outputFields
- The outputFields to set.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, boolean ziparchive)
public void getFields(RowMetaInterface row, String name, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space)
BaseStepMeta
getFields
in interface StepMetaInterface
getFields
in class BaseStepMeta
row
- the input row metaname
- the nameinfo
- the infonextStep
- the next stepspace
- the spacepublic RowMetaInterface getRequiredFields(VariableSpace space) throws KettleException
BaseStepMeta
getRequiredFields
in interface StepMetaInterface
getRequiredFields
in class BaseStepMeta
space
- the variable space to use to do variable substitution.
KettleException
- in case the required fields can't be determinedpublic 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 stepinfo, 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.CheckResultstepinfo
- 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 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 getEncoding()
public void setEncoding(String encoding)
public String getMainElement()
public void setMainElement(String mainElement)
mainElement
- The mainElement to set.public String getRepeatElement()
public void setRepeatElement(String repeatElement)
repeatElement
- The repeatElement to set.public String getNameSpace()
public void setNameSpace(String nameSpace)
nameSpace
- The nameSpace to set.public void setOmitNullValues(boolean omitNullValues)
public boolean isOmitNullValues()
public boolean isServletOutput()
public void setServletOutput(boolean servletOutput)
public 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 exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |