org.thales.punch.libraries.punchlang.operator

Class ValidateSchemaOperator

java.lang.Object

org.thales.punch.libraries.punchlang.operator.ValidateSchemaOperator

public class ValidateSchemaOperator
extends Object

You can check that the tuple schema validate against the mappings provided.

 validateSchema("mySchema").on([logs][log]).into([logs][error]);
 

 List<Tuple> errors = validateSchema("mySchema").on([logs][log]).validate();
 

 List<Tuple> errors = validateSchema("mySchema1", "mySchema2").on([logs][log]).validate();
 

Constructor Summary

Constructors

Constructor and Description
ValidateSchemaOperator(String... mappingNames) Constructor.

Method Summary

Modifier and Type	Method and Description
List<Tuple>	into(Tuple result) Stores validation results in provided tuple.
ValidateSchemaOperator	on(Tuple tuple) Make the operator check if the provided tuple is conform with your schema.
List<Tuple>	validate() Fire the operator and effectively check if your tuple conforms to your schema.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ValidateSchemaOperator

public ValidateSchemaOperator(String... mappingNames)

Constructor. Use the punch language 'validateSchema(mappingName)' from a punchlet.

Parameters:

mappingNames - : Mapping names. It must identify registered sets of mapping files.

Method Detail

on

public ValidateSchemaOperator on(Tuple tuple)

Make the operator check if the provided tuple is conform with your schema.

Parameters:

tuple - : Tuple to check.

Returns:

this operator

validate

public List<Tuple> validate()

Fire the operator and effectively check if your tuple conforms to your schema.

Returns:

the list of error tuple. Empty if no error.

into

public List<Tuple> into(Tuple result)

Stores validation results in provided tuple. This is handy to put the possible schema mismatches somewhere into your output document. Also return the list of results.

Parameters:

result - : Destination tuple

Returns:

the list of error tuple. Empty if no error.