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.annotators;
031
032import java.io.IOException;
033import java.io.InputStream;
034import java.util.ArrayList;
035import java.util.Arrays;
036import java.util.List;
037
038import opennlp.tools.sentdetect.SentenceDetectorME;
039import opennlp.tools.sentdetect.SentenceModel;
040
041import org.openimaj.text.nlp.textpipe.annotations.RawTextAnnotation;
042import org.openimaj.text.nlp.textpipe.annotations.SentenceAnnotation;
043
044/**
045 * {@link SentenceDetectorME} backed by a {@link SentenceModel} loaded from the
046 * resource located at: {@link OpenNLPSentenceAnnotator#SENTENCE_MODEL_PROP}
047 * 
048 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
049 * 
050 */
051public class OpenNLPSentenceAnnotator extends AbstractSentenceAnnotator {
052
053        /**
054         * Property name pointing to the sentence model
055         */
056        public static final String SENTENCE_MODEL_PROP = "org.openimaj.text.opennlp.models.sent";
057        public static final String SENTENCE_MODEL_DEFAULT = "/org/openimaj/text/opennlp/models/en-sent.bin";
058        SentenceDetectorME sentenceDetector;
059
060        public OpenNLPSentenceAnnotator() {
061                super();
062                InputStream modelIn = null;
063                modelIn = OpenNLPSentenceAnnotator.class.getResourceAsStream(System.getProperty(SENTENCE_MODEL_PROP,
064                                SENTENCE_MODEL_DEFAULT));
065                SentenceModel model = null;
066                try {
067                        model = new SentenceModel(modelIn);
068                } catch (final IOException e) {
069                        e.printStackTrace();
070                } finally {
071                        if (modelIn != null) {
072                                try {
073                                        modelIn.close();
074                                } catch (final IOException e) {
075                                }
076                        }
077                }
078                sentenceDetector = new SentenceDetectorME(model);
079        }
080
081        @Override
082        protected List<SentenceAnnotation> getSentenceAnnotations(String text) {
083                final ArrayList<SentenceAnnotation> sents = new ArrayList<SentenceAnnotation>();
084                final List<String> sentences = Arrays.asList(sentenceDetector.sentDetect(text));
085                final int currentOff = 0;
086                for (int i = 0; i < sentences.size(); i++) {
087                        final String sentence = sentences.get(i);
088                        final int start = currentOff + (text.substring(currentOff).indexOf(sentence));
089                        final int stop = start + sentence.length();
090                        sents.add(new SentenceAnnotation(sentence, start, stop));
091                }
092                return sents;
093        }
094
095        @Override
096        void checkForRequiredAnnotations(RawTextAnnotation annotation)
097                        throws MissingRequiredAnnotationException
098        {
099                // TODO Auto-generated method stub
100
101        }
102
103}