001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package org.openimaj.text.nlp.textpipe.annotations;
031
032import java.util.ArrayList;
033import java.util.Iterator;
034import java.util.List;
035
036import org.openimaj.text.nlp.textpipe.annotations.POSAnnotation.PartOfSpeech;
037
038/**
039 * Currently a collection of static functions required by various parts of the TextPipe.
040 * 
041 * @author Laurence Willmore (lgw1e10@ecs.soton.ac.uk)
042 *
043 */
044public class AnnotationUtils {
045        
046        /**
047         * Get the string tokens from a list of {@link TokenAnnotation}s
048         * @param tokens
049         * @return List of string tokens
050         */
051        public static List<String> getStringTokensFromTokenAnnotationList(List<TokenAnnotation> tokens){
052                ArrayList<String> result = new ArrayList<String>();
053                for (Iterator<TokenAnnotation> iterator = tokens.iterator(); iterator.hasNext();) { 
054                        TokenAnnotation tokenAnnotation = (TokenAnnotation) iterator.next();
055                        result.add(tokenAnnotation.stringToken);
056                }
057                return result;
058        }
059        
060        /**
061         * Returns a list of String represented Parts of Speech given a list of {@link TokenAnnotation} (These should have {@link POSAnnotation})
062         * @param tokens
063         * @return list of POS strings
064         */
065        public static List<String> getStringPOSsFromTokenAnnotationList(List<TokenAnnotation> tokens){
066                ArrayList<String> result = new ArrayList<String>();
067                for (Iterator<TokenAnnotation> iterator = tokens.iterator(); iterator.hasNext();) {
068                        TokenAnnotation tokenAnnotation = (TokenAnnotation) iterator.next();
069                        POSAnnotation pos = tokenAnnotation.getAnnotationsFor(POSAnnotation.class).get(0);
070                        if(pos.equals(PartOfSpeech.UK)){
071                                result.add(tokenAnnotation.stringToken);
072                        }
073                        else result.add(tokenAnnotation.getAnnotationsFor(POSAnnotation.class).get(0).toString());
074                }
075                return result;
076        }
077        
078        /**
079         * Converst a list of strings to an array of strings
080         * @param convert
081         * @return array of strings
082         */
083        public  static String[] ListToArray(List<String> convert){
084                String[] result = new String[convert.size()];
085                for (int i = 0; i < convert.size(); i++) {
086                        result[i]=convert.get(i);
087                }
088                return result;
089        }
090        
091        /**
092         * Check if a {@link TextPipeAnnotation} has been added to all members in a list of {@link TextPipeAnnotation}.
093         * @param toBeChecked
094         * @param check
095         * @return false if not all members have check annotation.
096         */
097        public static boolean allHaveAnnotation(List<? extends TextPipeAnnotation> toBeChecked,Class<? extends TextPipeAnnotation> check){              
098                for(TextPipeAnnotation anno: toBeChecked){
099                        if(!anno.getAnnotationKeyList().contains(check))return false;
100                }
101                return true;    
102        }
103}