|
||||||||||
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.xmlinput.XMLInputMeta
public class XMLInputMeta
Field Summary |
---|
Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta |
---|
loggingObject, STEP_ATTRIBUTES_FILE |
Constructor Summary | |
---|---|
XMLInputMeta()
|
Method Summary | |
---|---|
void |
allocate(int nrfiles,
int nrfields,
int nrPositions)
|
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. |
void |
getFields(RowMetaInterface r,
String name,
RowMetaInterface[] info,
StepMeta nextStep,
VariableSpace space)
Gets the fields. |
String |
getFileBaseURI()
|
String[] |
getFileMask()
|
String[] |
getFileName()
|
String |
getFilenameField()
|
FileInputList |
getFiles(VariableSpace space)
|
XMLInputField[] |
getInputFields()
|
String[] |
getInputPosition()
|
int |
getNrRowsToSkip()
|
List<ResourceReference> |
getResourceDependencies(TransMeta transMeta,
StepMeta stepInfo)
Get a list of all the resource dependencies that the step is depending on. |
long |
getRowLimit()
|
String |
getRowNumberField()
|
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 |
includeFilename()
|
boolean |
includeRowNumber()
|
boolean |
isIgnoreEntities()
|
boolean |
isNamespaceAware()
|
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 |
setDefault()
Set default values |
void |
setFileBaseURI(String fileBaseURI)
|
void |
setFileMask(String[] fileMask)
|
void |
setFileName(String[] fileName)
|
void |
setFilenameField(String filenameField)
|
void |
setIgnoreEntities(boolean ignoreEntities)
|
void |
setIncludeFilename(boolean includeFilename)
|
void |
setIncludeRowNumber(boolean includeRowNumber)
|
void |
setInputFields(XMLInputField[] inputFields)
|
void |
setInputPosition(String[] inputPosition)
|
void |
setNamespaceAware(boolean namespaceAware)
|
void |
setNrRowsToSkip(int nrRowsToSkip)
|
void |
setRowLimit(long rowLimit)
|
void |
setRowNumberField(String rowNumberField)
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public XMLInputMeta()
Method Detail |
---|
public XMLInputField[] getInputFields()
public void setInputFields(XMLInputField[] inputFields)
inputFields
- The input fields to set.public String[] getFileMask()
public void setFileMask(String[] fileMask)
fileMask
- The fileMask to set.public String[] getFileName()
public void setFileName(String[] fileName)
fileName
- The fileName to set.public String getFilenameField()
public void setFilenameField(String filenameField)
filenameField
- The filenameField to set.public boolean includeFilename()
public void setIncludeFilename(boolean includeFilename)
includeFilename
- The includeFilename to set.public boolean includeRowNumber()
public void setIncludeRowNumber(boolean includeRowNumber)
includeRowNumber
- The includeRowNumber to set.public long getRowLimit()
public void setRowLimit(long rowLimit)
rowLimit
- The rowLimit to set.public int getNrRowsToSkip()
public void setNrRowsToSkip(int nrRowsToSkip)
nrRowsToSkip
- The nrRowsToSkip to set.public String getRowNumberField()
public void setRowNumberField(String rowNumberField)
rowNumberField
- The rowNumberField 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 Object clone()
StepMetaInterface
clone
in interface StepMetaInterface
clone
in class BaseStepMeta
public String getXML()
BaseStepMeta
getXML
in interface StepMetaInterface
getXML
in class BaseStepMeta
public void allocate(int nrfiles, int nrfields, int nrPositions)
public void setDefault()
StepMetaInterface
setDefault
in interface StepMetaInterface
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 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 FileInputList getFiles(VariableSpace space)
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[] getInputPosition()
public List<ResourceReference> getResourceDependencies(TransMeta transMeta, StepMeta stepInfo)
BaseStepMeta
getResourceDependencies
in interface StepMetaInterface
getResourceDependencies
in class BaseStepMeta
public void setInputPosition(String[] inputPosition)
inputPosition
- The inputPosition to set.public String getFileBaseURI()
public void setFileBaseURI(String fileBaseURI)
fileBaseURI
- Provide a base for resolving relative URIspublic boolean isIgnoreEntities()
public void setIgnoreEntities(boolean ignoreEntities)
ignoreEntities
- Ignores external entities and returns an empty dummy e.g. for missing DTDspublic boolean isNamespaceAware()
public void setNamespaceAware(boolean namespaceAware)
namespaceAware
- support XML namespacespublic 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 |