001/*
002 * Copyright © 2012, 2013, 2014 Royal Botanic Gardens, Kew.
003 *
004 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
005 *
006 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
007 *
008 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
009 */
010package org.kew.rmf.transformers;
011
012import java.util.regex.Matcher;
013import java.util.regex.Pattern;
014
015/**
016 * A generic transformer that extracts all occurrences of a pattern (regEx)
017 * in a string
018 *
019 * It takes two optional parameters, `removeMultipleWhitespaces` (default true) and
020 * `trimIt` (default true)
021 */
022public class RegexExtractorTransformer extends RegexDefCollection implements Transformer {
023
024    protected String regex = "";
025    private boolean removeMultipleWhitespaces = true;
026    private boolean trimIt = true;
027
028    @Override
029    public String transform(String s) {
030        StringBuffer sb = new StringBuffer();
031        if (s != null){
032            if (this.removeMultipleWhitespaces) s = s.replaceAll("\\s+", " ");
033            if (this.trimIt) s = s.trim();
034                Pattern patt = Pattern.compile("(" + regex + ")");
035                Matcher m = patt.matcher(s);
036                while (m.find()){
037                        if (sb.length() > 0) sb.append(" ");
038                        sb.append(m.group());
039                }
040        }
041        return sb.toString();
042    }
043
044    public String getRegex() {
045                return regex;
046        }
047
048        public void setRegex(String regex) {
049                this.regex = regex;
050        }
051
052        public boolean isRemoveMultipleWhitespaces() {
053        return removeMultipleWhitespaces;
054    }
055
056    public void setRemoveMultipleWhitespaces(boolean removeMultipleWhitespaces) {
057        this.removeMultipleWhitespaces = removeMultipleWhitespaces;
058    }
059
060    public boolean isTrimIt() {
061        return trimIt;
062    }
063
064    public void setTrimIt(boolean trimIt) {
065        this.trimIt = trimIt;
066    }
067
068}