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 * <br/>
019 * It takes two optional parameters, {@link #removeMultipleWhitespaces} (default true) and
020 * {@link #trimIt} (default true)
021 */
022public class RegexExtractorTransformer implements Transformer {
023
024        private Pattern regex;
025        private boolean removeMultipleWhitespaces = true;
026        private boolean trimIt = true;
027
028        @Override
029        public String transform(String s) {
030                StringBuilder sb = new StringBuilder();
031                if (s != null){
032                        if (this.removeMultipleWhitespaces) {
033                                s = SqueezeWhitespaceTransformer.MULTIPLE_WHITESPACE.matcher(s).replaceAll(" ");
034                        }
035                        if (this.trimIt) {
036                                s = s.trim();
037                        }
038
039                        Matcher m = regex.matcher(s);
040                        while (m.find()){
041                                if (sb.length() > 0) sb.append(" ");
042                                sb.append(m.group());
043                        }
044                }
045                return sb.toString();
046        }
047
048        public String getRegex() {
049                return regex.pattern();
050        }
051        public void setRegex(String regex) {
052                this.regex = Pattern.compile("(" + regex + ")");
053        }
054
055        public boolean isRemoveMultipleWhitespaces() {
056                return removeMultipleWhitespaces;
057        }
058        public void setRemoveMultipleWhitespaces(boolean removeMultipleWhitespaces) {
059                this.removeMultipleWhitespaces = removeMultipleWhitespaces;
060        }
061
062        public boolean isTrimIt() {
063                return trimIt;
064        }
065        public void setTrimIt(boolean trimIt) {
066                this.trimIt = trimIt;
067        }
068}