Qorus Integration Engine®  4.0.3_git
OMQ::MapperType Class Reference

system mapper class for prividing Mapper::Mapper objects at runtime More...

Inheritance diagram for OMQ::MapperType:
OMQ::AbstractMapperType

Public Member Methods

string getName ()
 returns "Mapper", the name of the primary mapper class (must be unique in the mapper type list)
 
bool requiresInput ()
 mapper definition must include the input record description
 
bool requiresOutput ()
 mapper definition must include the output record description
 
hash getMapperOptions ()
 returns a hash of valid mapper options; the keys are the option names and the values are string descriptions for the options
 
*list getRequiredRecordOptions ()
 returns a list of mapper options that must be given to create the input or output records for the mapper for mappers that can create either input records (ie requiresInput() is False) and/or output records (ie requiresOutput() is False); these options must also be present in the getMapperOptions() output
 
Mapper::Mapper get (hash mapv, *hash opts)
 returns a Mapper::Mapper object
 
- Public Member Methods inherited from OMQ::AbstractMapperType
*hash getRuntimeMapperOptions ()
 returns a hash of valid runtime mapper options; the keys are the option names and the values are string descriptions for the options
 
Qore::AbstractIterator getIterator (Qore::AbstractIterator input, hash mapv, *hash opts)
 must return a iterator object given the input iterator that maps the input data to output in the iterator using the current Mapper
 
*list getRequiredOptions ()
 returns a list of mapper options that must be given to create the mapper (these options must also be present in the getMapperOptions() output); by default this method returns getRequiredRecordOptions() + "input" (if requiresInput() returns False) + "output" (if requiresOutput() returns False)
 
hash< auto > getConfigInfo ()
 returns a hash of configuration info for the mapper type
 
hash< auto > getInput (string mname, hash< auto > opth)
 called for mapper providers that automatically define the input record
 
hash< auto > getOutput (string mname, hash< auto > opth)
 called for mapper providers that automatically define the output record
 
bool isValid ()
 whether the mapper is valid, i.e. eligible for parsing and other "regular" actions
 

Detailed Description

system mapper class for prividing Mapper::Mapper objects at runtime

This mapper type does not require any special options, but also does not provide default values for any options, therefore the input and mapper-options-output "output" options must be explicitly defined (requiresInput() and requiresOutput() both return True)

Example:

# name: my-example-mapper
# version: 1.0
# desc: Example mapper for documentation
# type: Mapper
# author: Joesephine Programmer (Qore Technologies, s.r.o.)
# functions: my-mapper-lib
# parse-options: PO_NEW_STYLE
# define-group: Example: Example interface objects
# groups: Example
OPTION: input: (
"order_id": "unique order ID",
#...
)
OPTION: output: (
"order_number": (
"type": "number",
"desc": "the unique order number for the order",
),
# ...
)

The documentation for this class was generated from the following file: