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.authors;
011
012import org.kew.rmf.transformers.Transformer;
013
014/**
015 * This transformer tries to identify all publication authors of plant names in
016 * a string and returns a string where each of their surnames are shrunk/cropped
017 * to a length of {@link #setShrinkTo(int)}.
018 */
019/*
020 * For examples of standard usage and corner cases see {@link ShrunkPubAuthorsTest}
021 */
022public class ShrunkPubAuthors implements Transformer {
023
024        private ShrunkAuthors shrunkAuthors = new ShrunkAuthors();
025        private CleanedPubAuthors cleanedPubAuthors = new CleanedPubAuthors();
026
027        @Override
028        public String transform(String s) {
029                s = cleanedPubAuthors.transform(s);
030                s = shrunkAuthors.transform(s);
031                return s;
032        }
033
034        public Integer getShrinkTo() {
035                return shrunkAuthors.getShrinkTo();
036        }
037        public void setShrinkTo(int shrinkTo) {
038                shrunkAuthors.setShrinkTo(shrinkTo);
039        }
040}