Skip to content

Commit 411cf91

Browse files
committed
Merge #57 from remote-tracking branch 'origin/updateFluxExamples'
2 parents dce941b + c45903a commit 411cf91

File tree

2 files changed

+12
-11
lines changed

2 files changed

+12
-11
lines changed

docs/flux/flux-commands.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ parent: Flux
55
nav_order: 2
66
---
77

8-
Available flux commands (with release 1.2.0)
8+
Available flux commands (with release 7.0.0)
99
=======================
1010

1111
add-oreaggregation
@@ -166,6 +166,7 @@ decode-string
166166
- description: Splits a String into several Strings, either by extracting parts that match a regexp or by splitting by a regexp.
167167
- options: mode [SPLIT, EXTRACT]
168168
- signature: String -> String
169+
- [example in Playground](https://metafacture.org/playground/?example=decode-string)
169170
- java class: [org.metafacture.strings.StringDecoder](https://github.com/metafacture/metafacture-core/blob/master/metafacture-strings/src/main/java/org/metafacture/strings/StringDecoder.java)
170171

171172
decode-xml
@@ -357,7 +358,7 @@ flatten
357358
- description: flattens out entities in a stream by introducing dots in literal names
358359
- options: entitymarker (String)
359360
- signature: StreamReceiver -> StreamReceiver
360-
- [example in Playground](https://metafacture.org/playground/?example=flatten)
361+
- [example in Playground](https://metafacture.org/playground/?example=flatten_in_flux)
361362
- java class: [org.metafacture.mangling.StreamFlattener](https://github.com/metafacture/metafacture-core/blob/master/metafacture-mangling/src/main/java/org/metafacture/mangling/StreamFlattener.java)
362363

363364
from-jdom-document
@@ -543,15 +544,15 @@ object-to-literal
543544
open-file
544545
---------
545546
- description: Opens a file.
546-
- options: decompressconcatenated (boolean), encoding (String), compression (String)
547+
- options: decompressconcatenated (boolean), encoding (String), compression [NONE, AUTO, BZIP2, GZIP, PACK200, XZ]
547548
- signature: String -> Reader
548549
- [example in Playground](https://metafacture.org/playground/?example=open-file)
549550
- java class: [org.metafacture.io.FileOpener](https://github.com/metafacture/metafacture-core/blob/master/metafacture-io/src/main/java/org/metafacture/io/FileOpener.java)
550551

551552
open-http
552553
---------
553554
- description: Opens an HTTP resource. Supports setting HTTP header fields `Accept`, `Accept-Charset`, `Accept-Encoding`, `Content-Encoding` and `Content-Type`, as well as generic headers (separated by `\n`). Defaults: request `method` = `GET`, request `url` = `@-` (input data), request `body` = `@-` (input data) if request method supports body and input data not already used, `Accept` header (`accept`) = `*/*`, `Accept-Charset` header (`acceptcharset`) = `UTF-8`, `errorprefix` = `ERROR: `.
554-
- options: method [DELETE, GET, HEAD, OPTIONS, POST, PUT, TRACE], contentencoding (String), header (String), [deprecated] encoding (String), body (String), acceptcharset (String), acceptencoding (String), url (String), contenttype (String), accept (String), errorprefix (String)
555+
- options: method [DELETE, GET, HEAD, OPTIONS, POST, PUT, TRACE], contentencoding (String), header (String), [deprecated] encoding (String), body (String), acceptcharset (String), acceptencoding (String), url (String), accept (String), errorprefix (String), contenttype (String)
555556
- signature: String -> Reader
556557
- [example in Playground](https://metafacture.org/playground/?example=open-http)
557558
- java class: [org.metafacture.io.HttpOpener](https://github.com/metafacture/metafacture-core/blob/master/metafacture-io/src/main/java/org/metafacture/io/HttpOpener.java)
@@ -586,15 +587,15 @@ pass-through
586587
print
587588
-----
588589
- description: Writes objects to stdout
589-
- options: footer (String), header (String), encoding (String), compression (String), separator (String)
590+
- options: footer (String), header (String), encoding (String), compression [NONE, AUTO, BZIP2, GZIP, PACK200, XZ], separator (String)
590591
- signature: Object -> Void
591592
- [example in Playground](https://metafacture.org/playground/?example=print)
592593
- java class: [org.metafacture.io.ObjectStdoutWriter](https://github.com/metafacture/metafacture-core/blob/master/metafacture-io/src/main/java/org/metafacture/io/ObjectStdoutWriter.java)
593594

594595
rdf-macros
595596
----------
596-
- description: Expands some macros for RDF/XML
597-
- options: autoaddedsubject (String)
597+
- description: Expands some macros for RDF/XML. When using Fix, configure `referenceMarker` to any char but the default `*`
598+
- options: autoaddedsubject (String), referencemarker (String), languagemarker (String)
598599
- signature: StreamReceiver -> StreamReceiver
599600
- java class: [org.metafacture.linkeddata.RdfMacroPipe](https://github.com/metafacture/metafacture-core/blob/master/metafacture-linkeddata/src/main/java/org/metafacture/linkeddata/RdfMacroPipe.java)
600601

@@ -670,7 +671,7 @@ retrieve-triple-objects
670671
sleep
671672
-----
672673
- description: Lets the process sleep for a specific amount of time between objects.
673-
- options: sleeptime (int), timeunit [NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS]
674+
- options: sleeptime (int), timeunit (String)
674675
- signature: Object -> Object
675676
- java class: org.metafacture.flowcontrol.ObjectSleeper
676677

@@ -770,7 +771,7 @@ write
770771
-----
771772
- description: Writes objects to stdout or a file
772773
- arguments: [stdout, PATH]
773-
- options: appendiffileexists (boolean), footer (String), header (String), encoding (String), compression [NONE, AUTO, BZIP2, GZIP, PACK200, XZ], separator (String)
774+
- options: appendiffileexists (boolean), footer (String), header (String), encoding (String), compression (String), separator (String)
774775
- signature: Object -> Void
775776
- java class: [org.metafacture.io.ObjectWriter](https://github.com/metafacture/metafacture-core/blob/master/metafacture-io/src/main/java/org/metafacture/io/ObjectWriter.java)
776777

linksAndExamples.tsv

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ decode-json https://github.com/metafacture/metafacture-core/blob/master/metafact
1919
decode-mab https://github.com/metafacture/metafacture-core/blob/master/metafacture-biblio/src/main/java/org/metafacture/biblio/MabDecoder.java https://metafacture.org/playground/?example=decode-mab
2020
decode-marc21 https://github.com/metafacture/metafacture-core/blob/master/metafacture-biblio/src/main/java/org/metafacture/biblio/marc21/Marc21Decoder.java https://metafacture.org/playground/?example=decode-marc21
2121
decode-pica https://github.com/metafacture/metafacture-core/blob/master/metafacture-biblio/src/main/java/org/metafacture/biblio/pica/PicaDecoder.java https://metafacture.org/playground/?example=decode-pica
22-
decode-string https://github.com/metafacture/metafacture-core/blob/master/metafacture-strings/src/main/java/org/metafacture/strings/StringDecoder.java
22+
decode-string https://github.com/metafacture/metafacture-core/blob/master/metafacture-strings/src/main/java/org/metafacture/strings/StringDecoder.java https://metafacture.org/playground/?example=decode-string
2323
decode-xml https://github.com/metafacture/metafacture-core/blob/master/metafacture-xml/src/main/java/org/metafacture/xml/XmlDecoder.java https://metafacture.org/playground/?example=decode-xml
2424
decode-yaml https://github.com/metafacture/metafacture-core/blob/master/metafacture-yaml/src/main/java/org/metafacture/yaml/YamlDecoder.java https://metafacture.org/playground/?example=decode-yaml
2525
decouple https://github.com/metafacture/metafacture-core/blob/master/metafacture-flowcontrol/src/main/java/org/metafacture/flowcontrol/ObjectPipeDecoupler.java
@@ -44,7 +44,7 @@ filter-records-by-path https://github.com/metafacture/metafacture-core/blob/mast
4444
filter-strings https://github.com/metafacture/metafacture-core/blob/master/metafacture-strings/src/main/java/org/metafacture/strings/StringFilter.java https://metafacture.org/playground/?example=filter-strings
4545
filter-triples https://github.com/metafacture/metafacture-core/blob/master/metafacture-triples/src/main/java/org/metafacture/triples/TripleFilter.java https://metafacture.org/playground/?example=filter-triples
4646
find-fix-paths https://github.com/metafacture/metafacture-fix/blob/master/metafix/src/main/java/org/metafacture/metafix/FindFixPaths.java https://metafacture.org/playground/?example=find-fix-paths
47-
flatten https://github.com/metafacture/metafacture-core/blob/master/metafacture-mangling/src/main/java/org/metafacture/mangling/StreamFlattener.java https://metafacture.org/playground/?example=flatten
47+
flatten https://github.com/metafacture/metafacture-core/blob/master/metafacture-mangling/src/main/java/org/metafacture/mangling/StreamFlattener.java https://metafacture.org/playground/?example=flatten_in_flux
4848
from-jdom-document https://github.com/metafacture/metafacture-core/blob/master/metafacture-jdom/src/main/java/org/metafacture/jdom/JDomDocumentToStream.java
4949
handle-cg-xml https://github.com/metafacture/metafacture-core/blob/master/metafacture-xml/src/main/java/org/metafacture/xml/CGXmlHandler.java
5050
handle-comarcxml https://github.com/metafacture/metafacture-core/blob/master/metafacture-biblio/src/main/java/org/metafacture/biblio/ComarcXmlHandler.java

0 commit comments

Comments
 (0)