Skip to content

Commit 367f236

Browse files
committed
Add documentation annotations on MetafixListPaths
See https://gitlab.com/oersi/oersi-etl/-/issues/238
1 parent 17b836d commit 367f236

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

metafix/src/main/java/org/metafacture/metafix/MetafixListPaths.java

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,13 @@
1717
package org.metafacture.metafix;
1818

1919
import org.metafacture.formatting.ObjectTemplate;
20+
import org.metafacture.framework.FluxCommand;
2021
import org.metafacture.framework.ObjectReceiver;
2122
import org.metafacture.framework.Sender;
23+
import org.metafacture.framework.StreamReceiver;
24+
import org.metafacture.framework.annotations.Description;
25+
import org.metafacture.framework.annotations.In;
26+
import org.metafacture.framework.annotations.Out;
2227
import org.metafacture.framework.helpers.DefaultStreamPipe;
2328
import org.metafacture.mangling.DuplicateObjectFilter;
2429
import org.metafacture.mangling.StreamFlattener;
@@ -35,6 +40,12 @@
3540
*
3641
* @author Fabian Steeg
3742
*/
43+
@Description("Lists all paths found in a record. These paths can be used in a Fix to address fields. Options: " +
44+
"count (output occurence frequency of each path, sorted by highest frequency first; default: true), " +
45+
"index (output individual repeated subfields and array elements with index numbers instead of '*'; default: false)")
46+
@In(StreamReceiver.class)
47+
@Out(String.class)
48+
@FluxCommand("fix-list-paths")
3849
public class MetafixListPaths extends DefaultStreamPipe<ObjectReceiver<String>> {
3950

4051
private Metafix fix;

0 commit comments

Comments
 (0)