org.pentaho.di.trans.steps.jsonoutput
Class JsonOutputMeta

java.lang.Object
  org.pentaho.di.trans.step.BaseStepMeta
      org.pentaho.di.trans.steps.jsonoutput.JsonOutputMeta

All Implemented Interfaces:

Cloneable, StepAttributesInterface, StepMetaInterface

public class JsonOutputMeta
extends BaseStepMeta
implements StepMetaInterface

This class knows how to handle the MetaData for the Json output step

Since:

14-june-2010

Field Summary

static int	OPERATION_TYPE_BOTH
static int	OPERATION_TYPE_OUTPUT_VALUE
static int	OPERATION_TYPE_WRITE_TO_FILE
static String[]	operationTypeCode The operations type codes
static String[]	operationTypeDesc The operations description

Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta

loggingObject, STEP_ATTRIBUTES_FILE

Constructor Summary

JsonOutputMeta()

Method Summary

boolean	AddToResult()
void	allocate(int nrfields)
String	buildFilename(String fileName, 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	getEncoding()
String	getExtension()
void	getFields(RowMetaInterface row, String name, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space) Get the fields that are emitted by this step
String	getFileName()
String[]	getFiles(String fileName)
String	getJsonBloc()
String	getNrRowsInBloc()
int	getOperationType()
static int	getOperationTypeByDesc(String tt)
static String	getOperationTypeDesc(int i)
JsonOutputField[]	getOutputFields()
String	getOutputValue()
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	isCompatibilityMode()
boolean	isCreateParentFolder()
boolean	isDateInFilename()
boolean	isDoNotOpenNewFileInit()
boolean	isFileAppended()
boolean	isServletOutput()
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	setAddToResult(boolean AddToResult)
void	setCompatibilityMode(boolean compatibilityMode)
void	setCreateParentFolder(boolean createparentfolder)
void	setDateInFilename(boolean dateInFilename)
void	setDefault() Set default values
void	setDoNotOpenNewFileInit(boolean DoNotOpenNewFileInit)
void	setEncoding(String encoding)
void	setExtension(String extension)
void	setFileAppended(boolean fileAppended)
void	setFileName(String fileName)
void	setJsonBloc(String jsonBloc)
void	setNrRowsInBloc(String nrRowsInBloc)
void	setOperationType(int operationType)
void	setOutputFields(JsonOutputField[] outputFields)
void	setOutputValue(String outputValue)
void	setServletOutput(boolean servletOutput)
void	setTimeInFilename(boolean timeInFilename)

Methods inherited from class org.pentaho.di.trans.step.BaseStepMeta

analyseImpact, cancelQueries, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, 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, getUsedLibraries, 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, exportResources, getDialogClassName, getOptionalStreams, getParentStepMeta, getRequiredFields, getResourceDependencies, getSQLStatements, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, handleStreamSelection, hasRepositoryReferences, lookupRepositoryReferences, resetStepIoMeta, searchInfoAndTargetSteps, setParentStepMeta, supportsErrorHandling

Field Detail

operationTypeDesc

public static final String[] operationTypeDesc

The operations description

operationTypeCode

public static final String[] operationTypeCode

The operations type codes

OPERATION_TYPE_OUTPUT_VALUE

public static final int OPERATION_TYPE_OUTPUT_VALUE

See Also:

Constant Field Values

OPERATION_TYPE_WRITE_TO_FILE

public static final int OPERATION_TYPE_WRITE_TO_FILE

See Also:

Constant Field Values

OPERATION_TYPE_BOTH

public static final int OPERATION_TYPE_BOTH

See Also:

Constant Field Values

Constructor Detail

JsonOutputMeta

public JsonOutputMeta()

Method Detail

isDoNotOpenNewFileInit

public boolean isDoNotOpenNewFileInit()

setDoNotOpenNewFileInit

public void setDoNotOpenNewFileInit(boolean DoNotOpenNewFileInit)

isCreateParentFolder

public boolean isCreateParentFolder()

Returns:

Returns the create parent folder flag.

setCreateParentFolder

public void setCreateParentFolder(boolean createparentfolder)

Parameters:

createparentfolder - The create parent folder flag to set.

getExtension

public String getExtension()

Returns:

Returns the extension.

setExtension

public void setExtension(String extension)

Parameters:

extension - The extension to set.

isFileAppended

public boolean isFileAppended()

Returns:

Returns the fileAppended.

setFileAppended

public void setFileAppended(boolean fileAppended)

Parameters:

fileAppended - The fileAppended to set.

getFileName

public String getFileName()

Returns:

Returns the fileName.

isTimeInFilename

public boolean isTimeInFilename()

Returns:

Returns the timeInFilename.

isDateInFilename

public boolean isDateInFilename()

Returns:

Returns the dateInFilename.

setDateInFilename

public void setDateInFilename(boolean dateInFilename)

Parameters:

dateInFilename - The dateInFilename to set.

setTimeInFilename

public void setTimeInFilename(boolean timeInFilename)

Parameters:

timeInFilename - The timeInFilename to set.

setFileName

public void setFileName(String fileName)

Parameters:

fileName - The fileName to set.

AddToResult

public boolean AddToResult()

Returns:

Returns the Add to result filesname flag.

getOperationType

public int getOperationType()

getOperationTypeByDesc

public static int getOperationTypeByDesc(String tt)

setOperationType

public void setOperationType(int operationType)

getOperationTypeDesc

public static String getOperationTypeDesc(int i)

getOutputFields

public JsonOutputField[] getOutputFields()

Returns:

Returns the outputFields.

setOutputFields

public void setOutputFields(JsonOutputField[] outputFields)

Parameters:

outputFields - The outputFields 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

setAddToResult

public void setAddToResult(boolean AddToResult)

Parameters:

AddToResult - The Add file to result to set.

setDefault

public void setDefault()

Description copied from interface: StepMetaInterface

Set default values

Specified by:

setDefault in interface StepMetaInterface

getFields

public void getFields(RowMetaInterface row,
                      String name,
                      RowMetaInterface[] info,
                      StepMeta nextStep,
                      VariableSpace space)
               throws KettleStepException

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:

row - 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

Throws:

KettleStepException - when an error occurred searching for the fields.

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)

getFiles

public String[] getFiles(String fileName)

buildFilename

public String buildFilename(String fileName,
                            int stepnr,
                            int splitnr)

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

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.

getEncoding

public String getEncoding()

setEncoding

public void setEncoding(String encoding)

getJsonBloc

public String getJsonBloc()

Returns:

Returns the jsonBloc.

setJsonBloc

public void setJsonBloc(String jsonBloc)

Parameters:

jsonBloc - The root node to set.

getNrRowsInBloc

public String getNrRowsInBloc()

Returns:

Returns the jsonBloc.

setNrRowsInBloc

public void setNrRowsInBloc(String nrRowsInBloc)

Parameters:

jsonBloc - The nrRowsInBloc.

getOutputValue

public String getOutputValue()

setOutputValue

public void setOutputValue(String outputValue)

isServletOutput

public boolean isServletOutput()

setServletOutput

public void setServletOutput(boolean servletOutput)

isCompatibilityMode

public boolean isCompatibilityMode()

setCompatibilityMode

public void setCompatibilityMode(boolean compatibilityMode)