6.13.22 CustomObjects(Custom function)

This section defines the Custom function (custom).

Comments exist in the class and arguments to be specified in Custom function. However, import of these items is not supported in the mapping by using Excel.

Define the package and class separately and set the value of "Package + class" defined in Excel, in the "Class" item on the screen of mapping definition editor.

Organization of this subsection
(1) Definition item
(2) Definition example

(1) Definition item

Following table describes definition items:

Table 6-47 TableCustomObjectsDefinition item

Item nameDefinition contentsValue that you can defineAdditional description
NameFunction nameValue of NCName typeFor details on the value that you can define, see "6.13.24 Objects for which you can define the same Name element in multiple rows".
JarJAR fileValue of NCName having less than 100 charactersYou can define only one file in the same Name.#1
PackagePackageValue of NCName type having less than 255 charactersYou can define only one package in the same Name.#1
ClassClassValue of NCName type having less than 100 charactersYou can define only one class in the same Name.#1
MethodMethodValue of NCName type having less than 100 charactersYou can define only one method in the same Name.#1
Set only method name and do not add "()" at the end.
ReturnTypeReturn value typeOnly "String" or "NodeList"You can define only one return value type in the same Name.#1#2
ArgumentArgumentValue of NCName type having less than 100 charactersYou can define multiple arguments in the same Name.#3#4
ArgumentTypeArgument typeOnly "String" or "Object"You can define multiple argument types in the same Name.#2#3#4
InputInput valueSee "6.12.2 Setting up the mapping definition"You can specify multiple input values in the same Name.
Set value in the list, in the defined order.
#1
When you specify transformation function definition item (Jar, Package, Class, Method, Return Type), always specify in first line in the same Name. Specify value same as first line, or blank in the lines other than first line in the same Name.
#2
When ReturnType is "String", you can define ArgumentType only as "String" and when the ReturnType is "NodeList", you can define ArgumentType only as "Object".
#3
This is mandatory item when you set even 1 argument item (Argument or ArgumentType) in the same line.
#4
Set argument in the list, in the defined order.

(2) Definition example

Following figure shows the definition example:

Figure 6-88 FigureCustomObjectsDefinition example

[Figure]