Ant Filters & Mappers

<target name="recurse" depends="clean">
  <echo file="${out}/t.txt" message="@A@${line.separator}"/>
  <copy file="${out}/t.txt" tofile="${out}/recursive.txt">
    <filterset><filter token="A" value="x-@B@-x"/><filter token="B" value="inner"/></filterset>
  </copy>
  <copy file="${out}/t.txt" tofile="${out}/flat.txt">
    <filterset recurse="false"><filter token="A" value="x-@B@-x"/><filter token="B" value="inner"/></filterset>
  </copy>
  <loadfile srcfile="${out}/recursive.txt" property="r1"/>
  <loadfile srcfile="${out}/flat.txt" property="r2"/>
  <echo message="recurse=true : ${r1}"/>
  <echo message="recurse=false: ${r2}"/>
</target>

$ ant -q recurse
     [echo] recurse=true : x-inner-x
     [echo] recurse=false: x-@B@-x
BUILD SUCCESSFUL
Total time: 0 seconds

<target name="bad-filtersfile">
  <copy file="data/stations.csv" tofile="${out}/x.csv"><filterset><filtersfile file="nope.properties"/></filterset></copy>
</target>

$ ant -q bad-filtersfile
BUILD FAILED
/work/tidepool/build.xml:289: Could not read filters from file /work/tidepool/nope.properties as it doesn't exist.
Total time: 0 seconds
$ echo $?
1

<target name="chain-basic" depends="clean">
  <copy file="src/main/resources/banner.txt.in" tofile="${out}/banner.txt">
    <filterchain>
      <striplinecomments><comment value="#"/></striplinecomments>
      <replacetokens>
        <token key="VERSION" value="1.4.0"/>
        <token key="BUILD_DATE" value="2026-10-16"/>
        <token key="STATIONS" value="data/stations.csv"/>
      </replacetokens>
      <expandproperties/>
      <prefixlines prefix="| "/>
    </filterchain>
  </copy>
  <loadfile srcfile="${out}/banner.txt" property="banner"/>
  <echo message="${banner}"/>
</target>

$ ant -q chain-basic
     [echo] | tidepool 1.4.0 (built 2026-10-16)
     [echo] | stations file: data/stations.csv
     [echo] | engine: harmonic
     [echo] | unknown token stays: @MISSING@
BUILD SUCCESSFUL
Total time: 0 seconds

<target name="chain-lines" depends="clean">
  <loadfile srcfile="data/stations.csv" property="head2"><filterchain><headfilter lines="2"/></filterchain></loadfile>
  <loadfile srcfile="data/stations.csv" property="body"><filterchain><headfilter lines="-1" skip="1"/></filterchain></loadfile>
  <loadfile srcfile="data/stations.csv" property="tail1"><filterchain><tailfilter lines="1"/></filterchain></loadfile>
  <loadfile srcfile="data/stations.csv" property="m2"><filterchain><linecontains><contains value="M2"/><contains value="S2"/></linecontains></filterchain></loadfile>
  <loadfile srcfile="data/stations.csv" property="without.k1"><filterchain><linecontains negate="true"><contains value="K1"/></linecontains></filterchain></loadfile>
  <loadfile srcfile="data/stations.csv" property="rx"><filterchain><linecontainsregexp regexp="^(SF|HNL),"/></filterchain></loadfile>
  <loadfile srcfile="data/stations.csv" property="suffixed"><filterchain><headfilter lines="2" skip="1"/><suffixlines suffix=" ;"/></filterchain></loadfile>
  <echo message="headfilter lines=2:${line.separator}${head2}"/>
  <echo message="headfilter lines=-1 skip=1:${line.separator}${body}"/>
  <echo message="tailfilter lines=1:${line.separator}${tail1}"/>
  <echo message="linecontains M2 and S2:${line.separator}${m2}"/>
  <echo message="linecontains negate K1:${line.separator}${without.k1}"/>
  <echo message="linecontainsregexp:${line.separator}${rx}"/>
  <echo message="head skip + suffixlines:${line.separator}${suffixed}"/>
</target>

$ ant -q chain-lines
     [echo] headfilter lines=2:
     [echo] id,name,latitude,longitude,constituents
     [echo] SF,San Francisco,37.8063,-122.4659,M2:0.55:120;S2:0.13:150;K1:0.38:210
     [echo] headfilter lines=-1 skip=1:
     [echo] SF,San Francisco,37.8063,-122.4659,M2:0.55:120;S2:0.13:150;K1:0.38:210
     [echo] BOS,Boston,42.3539,-71.0503,M2:1.35:15;S2:0.21:42;N2:0.28:350
     [echo] HNL,Honolulu,21.3067,-157.8645,M2:0.14:90;K1:0.17:250;O1:0.10:230
     [echo] tailfilter lines=1:
     [echo] HNL,Honolulu,21.3067,-157.8645,M2:0.14:90;K1:0.17:250;O1:0.10:230
     [echo] linecontains M2 and S2:
     [echo] SF,San Francisco,37.8063,-122.4659,M2:0.55:120;S2:0.13:150;K1:0.38:210
     [echo] BOS,Boston,42.3539,-71.0503,M2:1.35:15;S2:0.21:42;N2:0.28:350
     [echo] linecontains negate K1:
     [echo] id,name,latitude,longitude,constituents
     [echo] BOS,Boston,42.3539,-71.0503,M2:1.35:15;S2:0.21:42;N2:0.28:350
     [echo] linecontainsregexp:
     [echo] SF,San Francisco,37.8063,-122.4659,M2:0.55:120;S2:0.13:150;K1:0.38:210
     [echo] HNL,Honolulu,21.3067,-157.8645,M2:0.14:90;K1:0.17:250;O1:0.10:230
     [echo] head skip + suffixlines:
     [echo] SF,San Francisco,37.8063,-122.4659,M2:0.55:120;S2:0.13:150;K1:0.38:210 ;
     [echo] BOS,Boston,42.3539,-71.0503,M2:1.35:15;S2:0.21:42;N2:0.28:350 ;
BUILD SUCCESSFUL
Total time: 0 seconds

<target name="chain-text" depends="clean">
  <loadfile srcfile="src/main/java/io/tidepool/model/Height.java" property="nocomments">
    <filterchain><stripjavacomments/></filterchain>
  </loadfile>
  <echo message="stripjavacomments:${line.separator}${nocomments}"/>
  <loadfile srcfile="noisy.txt" property="noisy" encoding="UTF-8">
    <filterchain>
      <striplinecomments>
        <comment value="#"/><comment value="--"/><comment value="REM "/>
      </striplinecomments>
      <tabstospaces tablength="2"/>
      <escapeunicode/>
    </filterchain>
  </loadfile>
  <echo message="striplinecomments + tabstospaces + escapeunicode:${line.separator}${noisy}"/>
  <loadfile srcfile="constituents.txt" property="oneline">
    <filterchain><striplinebreaks/></filterchain>
  </loadfile>
  <echo message="striplinebreaks: ${oneline}"/>
  <loadfile srcfile="constituents.txt" property="nom2">
    <filterchain><deletecharacters chars="2"/></filterchain>
  </loadfile>
  <echo message="deletecharacters chars=2:${line.separator}${nom2}"/>
</target>

$ ant -q chain-text
     [echo] stripjavacomments:
     [echo] package io.tidepool.model;
     [echo]
     [echo]
     [echo]
     [echo] public record Height(double metres) {
     [echo]
     [echo]     public static final String DATUM = "LAT";
     [echo] }
     [echo] striplinecomments + tabstospaces + escapeunicode:
     [echo] name=Plage de l\u00e9on
     [echo]
     [echo]      indented  line
     [echo] value=1
     [echo] striplinebreaks: M2S2K1M2M2O1S2
     [echo] deletecharacters chars=2:
     [echo] M
     [echo] S
     [echo] K1
     [echo] M
     [echo] M
     [echo] O1
     [echo] S
BUILD SUCCESSFUL
Total time: 0 seconds

<target name="chain-sort" depends="clean">
  <loadfile srcfile="constituents.txt" property="sorted">
    <filterchain><sortfilter/></filterchain>
  </loadfile>
  <loadfile srcfile="constituents.txt" property="rsorted">
    <filterchain><sortfilter reverse="true"/><tokenfilter><uniqfilter/></tokenfilter></filterchain>
  </loadfile>
  <loadfile srcfile="constituents.txt" property="uniq">
    <filterchain><sortfilter/><uniqfilter/></filterchain>
  </loadfile>
  <echo message="sortfilter:${line.separator}${sorted}"/>
  <echo message="sortfilter reverse=true, then uniqfilter:${line.separator}${rsorted}"/>
  <echo message="sortfilter then uniqfilter:${line.separator}${uniq}"/>
</target>

$ ant -q chain-sort
     [echo] sortfilter:
     [echo] K1
     [echo] M2
     [echo] M2
     [echo] M2
     [echo] O1
     [echo] S2
     [echo] S2
     [echo] sortfilter reverse=true, then uniqfilter:
     [echo] S2
     [echo] O1
     [echo] M2
     [echo] K1
     [echo] sortfilter then uniqfilter:
     [echo] K1
     [echo] M2
     [echo] O1
     [echo] S2
BUILD SUCCESSFUL
Total time: 0 seconds

<target name="chain-token" depends="clean">
  <loadfile srcfile="data/stations.csv" property="tok1">
    <filterchain>
      <tokenfilter>
        <containsregex pattern="^([A-Z]+),([^,]+),.*$" replace="\1 = \2"/>
      </tokenfilter>
    </filterchain>
  </loadfile>
  <echo message="containsregex with replace (header dropped):${line.separator}${tok1}"/>
  <echo file="${out}/words.txt" message="M2 S2 K1${line.separator}"/>
  <loadfile srcfile="${out}/words.txt" property="tok2">
    <filterchain>
      <tokenfilter>
        <stringtokenizer/>
        <replaceregex pattern="(.+)" replace="[\1]"/>
      </tokenfilter>
    </filterchain>
  </loadfile>
  <echo message="stringtokenizer with replaceregex: ${tok2}"/>
  <loadfile srcfile="noisy.txt" property="tok5" encoding="UTF-8">
    <filterchain>
      <headfilter lines="2" skip="1"/>
      <tokenfilter><native2asciifilter/></tokenfilter>
    </filterchain>
  </loadfile>
  <echo message="native2asciifilter: ${tok5}"/>
  <loadfile srcfile="data/stations.csv" property="tok3">
    <filterchain>
      <headfilter lines="2" skip="1"/>
      <tokenfilter>
        <replacestring from="San Francisco" to="SF City"/>
        <trim/>
        <containsstring contains="City"/>
      </tokenfilter>
    </filterchain>
  </loadfile>
  <echo message="replacestring, trim, containsstring:${line.separator}${tok3}"/>
  <loadfile srcfile="noisy.txt" property="tok4" encoding="UTF-8">
    <filterchain>
      <tokenfilter><deletecharacters chars="\t"/><trim/><ignoreblank/></tokenfilter>
    </filterchain>
  </loadfile>
  <echo message="deletecharacters, trim, ignoreblank:${line.separator}${tok4}"/>
</target>

$ ant -q chain-token
     [echo] containsregex with replace (header dropped):
     [echo] SF = San Francisco
     [echo] BOS = Boston
     [echo] HNL = Honolulu
     [echo] stringtokenizer with replaceregex: [M2] [S2] [K1]
     [echo] native2asciifilter: name=Plage de l\u00e9on
     [echo]
     [echo] replacestring, trim, containsstring:
     [echo] SF,SF City,37.8063,-122.4659,M2:0.55:120;S2:0.13:150;K1:0.38:210
     [echo] deletecharacters, trim, ignoreblank:
     [echo] # comment line
     [echo] name=Plage de léon
     [echo] indentedline
     [echo] -- sql comment
     [echo] REM batch comment
     [echo] value=1
BUILD SUCCESSFUL
Total time: 0 seconds

<target name="chain-ref" depends="clean">
  <echo file="${out}/header.txt" message="// generated by tidepool${line.separator}"/>
  <filterchain id="java.header">
    <concatfilter prepend="${out}/header.txt"/>
  </filterchain>
  <copy todir="${out}/gen">
    <fileset dir="src/main/java" includes="**/Height.java"/>
    <filterchain refid="java.header"/>
  </copy>
  <loadfile srcfile="${out}/gen/io/tidepool/model/Height.java" property="gen"/>
  <echo message="${gen}"/>
</target>

$ ant -q chain-ref
     [echo] // generated by tidepool
     [echo] package io.tidepool.model;
     [echo]
     [echo] // Licence header: internal use only.
     [echo] /** A tide height in metres above chart datum. */
     [echo] public record Height(double metres) {
     [echo]     /* the chart datum is lowest astronomical tide */
     [echo]     public static final String DATUM = "LAT"; // keep in sync with the CLI
     [echo] }
BUILD SUCCESSFUL
Total time: 0 seconds

<target name="scriptfilter" depends="clean">
  <copy file="data/stations.csv" tofile="${out}/upper.csv">
    <filterchain>
      <tokenfilter>
        <scriptfilter language="javascript">self.setToken(self.getToken().toUpperCase());</scriptfilter>
      </tokenfilter>
    </filterchain>
  </copy>
</target>

$ ant -q scriptfilter
Java 15 has removed Nashorn, you must provide an engine for running JavaScript yourself. GraalVM JavaScript currently is the preferred option.
BUILD FAILED
/work/tidepool/build.xml:184: Unable to create javax script engine for javascript
Total time: 0 seconds
$ echo $?
1

<macrodef name="show-mapping">
  <attribute name="title"/>
  <element name="m" implicit="true"/>
  <sequential>
    <pathconvert property="mapped.@{title}" pathsep="${line.separator}  " setonempty="false">
      <fileset dir="src">
        <include name="main/java/io/tidepool/model/Height.java"/>
        <include name="main/java/io/tidepool/engine/TideEngine.java"/>
        <include name="test/java/io/tidepool/model/HeightTest.java"/>
        <include name="main/resources/banner.txt.in"/>
      </fileset>
      <chainedmapper>
        <globmapper from="${basedir}${file.separator}src${file.separator}*" to="*"/>
        <m/>
      </chainedmapper>
    </pathconvert>
    <echo message="@{title}:${line.separator}  ${mapped.@{title}}"/>
  </sequential>
</macrodef>

<target name="mappers">
  <show-mapping title="identity"><identitymapper/></show-mapping>
  <show-mapping title="flatten"><flattenmapper/></show-mapping>
  <show-mapping title="merge"><mergemapper to="all.txt"/></show-mapping>
  <show-mapping title="glob"><globmapper from="*.java" to="*.java.bak"/></show-mapping>
  <show-mapping title="regexp"><regexpmapper from="^(.*)/([^/]+)/([^/]*)$$" to="\1/\2/\2-\3"/></show-mapping>
  <show-mapping title="package"><packagemapper from="main/java/*.java" to="*.src"/></show-mapping>
  <show-mapping title="unpackage"><chainedmapper><packagemapper from="main/java/*.java" to="*"/><unpackagemapper from="*" to="gen/*.txt"/></chainedmapper></show-mapping>
  <show-mapping title="composite"><compositemapper><identitymapper/><packagemapper from="main/java/*.java" to="*"/></compositemapper></show-mapping>
  <show-mapping title="chained"><chainedmapper><flattenmapper/><globmapper from="*" to="new/path/*"/></chainedmapper></show-mapping>
  <show-mapping title="firstmatch"><firstmatchmapper><globmapper from="*Test.java" to="*Test.xml"/><globmapper from="*.java" to="*.class"/></firstmatchmapper></show-mapping>
  <show-mapping title="cutdirs"><cutdirsmapper dirs="3"/></show-mapping>
  <show-mapping title="filtermapper"><filtermapper><replacestring from="/" to="-"/></filtermapper></show-mapping>
</target>

$ ant -q mappers
     [echo] identity:
     [echo]   main/java/io/tidepool/engine/TideEngine.java
     [echo]   main/java/io/tidepool/model/Height.java
     [echo]   main/resources/banner.txt.in
     [echo]   test/java/io/tidepool/model/HeightTest.java
     [echo] flatten:
     [echo]   TideEngine.java
     [echo]   Height.java
     [echo]   banner.txt.in
     [echo]   HeightTest.java
     [echo] merge:
     [echo]   all.txt
     [echo]   all.txt
     [echo]   all.txt
     [echo]   all.txt
     [echo] glob:
     [echo]   main/java/io/tidepool/engine/TideEngine.java.bak
     [echo]   main/java/io/tidepool/model/Height.java.bak
     [echo]   test/java/io/tidepool/model/HeightTest.java.bak
     [echo] regexp:
     [echo]   main/java/io/tidepool/engine/engine-TideEngine.java
     [echo]   main/java/io/tidepool/model/model-Height.java
     [echo]   main/resources/resources-banner.txt.in
     [echo]   test/java/io/tidepool/model/model-HeightTest.java
     [echo] package:
     [echo]   io.tidepool.engine.TideEngine.src
     [echo]   io.tidepool.model.Height.src
     [echo] unpackage:
     [echo]   gen/io/tidepool/engine/TideEngine.txt
     [echo]   gen/io/tidepool/model/Height.txt
     [echo] composite:
     [echo]   main/java/io/tidepool/engine/TideEngine.java
     [echo]   io.tidepool.engine.TideEngine
     [echo]   main/java/io/tidepool/model/Height.java
     [echo]   io.tidepool.model.Height
     [echo]   main/resources/banner.txt.in
     [echo]   test/java/io/tidepool/model/HeightTest.java
     [echo] chained:
     [echo]   new/path/TideEngine.java
     [echo]   new/path/Height.java
     [echo]   new/path/banner.txt.in
     [echo]   new/path/HeightTest.java
     [echo] firstmatch:
     [echo]   main/java/io/tidepool/engine/TideEngine.class
     [echo]   main/java/io/tidepool/model/Height.class
     [echo]   test/java/io/tidepool/model/HeightTest.xml
     [echo] cutdirs:
     [echo]   tidepool/engine/TideEngine.java
     [echo]   tidepool/model/Height.java
     [echo]   tidepool/model/HeightTest.java
     [echo] filtermapper:
     [echo]   main-java-io-tidepool-engine-TideEngine.java
     [echo]   main-java-io-tidepool-model-Height.java
     [echo]   main-resources-banner.txt.in
     [echo]   test-java-io-tidepool-model-HeightTest.java
BUILD SUCCESSFUL
Total time: 0 seconds

<target name="glob-without-to" depends="clean">
  <copy todir="${out}/x">
    <fileset dir="data"/>
    <globmapper from="*.csv"/>
  </copy>
  <pathconvert property="made" pathsep=", ">
    <fileset dir="${out}/x"/>
    <flattenmapper/>
  </pathconvert>
  <echo message="files created: ${made}"/>
</target>

$ ant -q glob-without-to
     [echo] files created: null
BUILD SUCCESSFUL
Total time: 0 seconds

<target name="no-match" depends="clean">
  <copy todir="${out}/y">
    <fileset dir="data"/>
    <globmapper from="*.txt" to="*.bak"/>
  </copy>
  <available file="${out}/y" type="dir" property="y.exists"/>
  <echo message="destination directory created: ${y.exists}"/>
</target>

$ ant -q no-match
     [echo] destination directory created: ${y.exists}
BUILD SUCCESSFUL
Total time: 0 seconds