hop-user-manual/modules/ROOT/pages/plugins/transforms/switchcase.adoc - incubator-hop-docs - Git at Google

 ////
 Licensed to the Apache Software Foundation (ASF) under one
 or more contributor license agreements.  See the NOTICE file
 distributed with this work for additional information
 regarding copyright ownership.  The ASF licenses this file
 to you under the Apache License, Version 2.0 (the
 "License"); you may not use this file except in compliance
 with the License.  You may obtain a copy of the License at
   http://www.apache.org/licenses/LICENSE-2.0
 Unless required by applicable law or agreed to in writing,
 software distributed under the License is distributed on an
 "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 KIND, either express or implied.  See the License for the
 specific language governing permissions and limitations
 under the License.
 ////
 :documentationPath: /plugins/transforms/
 :language: en_US
 :page-alternativeEditUrl: https://github.com/apache/incubator-hop/edit/master/plugins/transforms/switchcase/src/main/doc/switchcase.adoc
 = Switch / Case

 == Description

 What this transform does is implement the Switch/Case statement found in popular programming languages like Java.

 In our case we route rows of data to one or more target transforms based on the value encountered in a certain field.

 == Options

 [width="90%", options="header"]
 |===
 |Option|Description
 |Transform name|The name that uniquely identifies the transform.
 |Field name to switch|The field name that contains the value to use as a bases for the row routing.
 |Use string contains comparison|If checked, the comparison will be true if the value is found anywhere in the field being tested. Unchecked and the value has to exactly match the field.
 |Case value data type|The data type of the values specified in this dialog
 |Case value conversion mask|The conversion mask of the values specified in this dialog (numeric / date values)
 |Case value decimal symbol|The decimal symbol of the values specified in this dialog (numeric values)
 |Case value grouping symbol|The grouping symbol of the values specified in this dialog (numeric values)
 |Case values|Here you can specify a value-target transform pair, one per row.
 To specify a null value, simply leave the value column blank while entering a target transform.
 Please note that it is possible to specify the same target transform more than once.
 |Default target transform|All the rows that don't match any of the case values above are sent to this target transform.
 |===

 == Metadata Injection Support

 All fields of this transform support metadata injection. You can use this transform with Metadata Injection to pass metadata to your pipeline at runtime.
	////
	Licensed to the Apache Software Foundation (ASF) under one
	or more contributor license agreements. See the NOTICE file
	distributed with this work for additional information
	regarding copyright ownership. The ASF licenses this file
	to you under the Apache License, Version 2.0 (the
	"License"); you may not use this file except in compliance
	with the License. You may obtain a copy of the License at
	http://www.apache.org/licenses/LICENSE-2.0
	Unless required by applicable law or agreed to in writing,
	software distributed under the License is distributed on an
	"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
	KIND, either express or implied. See the License for the
	specific language governing permissions and limitations
	under the License.
	////
	:documentationPath: /plugins/transforms/
	:language: en_US
	:page-alternativeEditUrl: https://github.com/apache/incubator-hop/edit/master/plugins/transforms/switchcase/src/main/doc/switchcase.adoc
	= Switch / Case

	== Description

	What this transform does is implement the Switch/Case statement found in popular programming languages like Java.

	In our case we route rows of data to one or more target transforms based on the value encountered in a certain field.

	== Options

	[width="90%", options="header"]
	\|===
	\|Option\|Description
	\|Transform name\|The name that uniquely identifies the transform.
	\|Field name to switch\|The field name that contains the value to use as a bases for the row routing.
	\|Use string contains comparison\|If checked, the comparison will be true if the value is found anywhere in the field being tested. Unchecked and the value has to exactly match the field.
	\|Case value data type\|The data type of the values specified in this dialog
	\|Case value conversion mask\|The conversion mask of the values specified in this dialog (numeric / date values)
	\|Case value decimal symbol\|The decimal symbol of the values specified in this dialog (numeric values)
	\|Case value grouping symbol\|The grouping symbol of the values specified in this dialog (numeric values)
	\|Case values\|Here you can specify a value-target transform pair, one per row.
	To specify a null value, simply leave the value column blank while entering a target transform.
	Please note that it is possible to specify the same target transform more than once.
	\|Default target transform\|All the rows that don't match any of the case values above are sent to this target transform.
	\|===

	== Metadata Injection Support

	All fields of this transform support metadata injection. You can use this transform with Metadata Injection to pass metadata to your pipeline at runtime.