OpenNlpSequenceTagsetDescriptionProvider.java

/*
 * Copyright 2016
 * Ubiquitous Knowledge Processing (UKP) Lab
 * Technische Universität Darmstadt
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package de.tudarmstadt.ukp.dkpro.core.opennlp.internal;

import static java.util.Collections.singletonMap;

import java.util.Map;
import java.util.Set;
import java.util.TreeSet;

import opennlp.tools.ml.model.SequenceClassificationModel;
import de.tudarmstadt.ukp.dkpro.core.api.metadata.TagsetBase;

public class OpenNlpSequenceTagsetDescriptionProvider
    extends TagsetBase
{
    private String name;
    private String layer;
    private SequenceClassificationModel<String> model;
    private String tagSplitPattern;

    public OpenNlpSequenceTagsetDescriptionProvider(String aName, Class<?> aLayer,
            SequenceClassificationModel<String> aModel)
    {
        name = aName;
        layer = aLayer.getName();
        model = aModel;
    }
    
    public void setTagSplitPattern(String aTagSplitPattern)
    {
        tagSplitPattern = aTagSplitPattern;
    }

    @Override
    public Map<String, String> getLayers()
    {
        return singletonMap(layer, name);
    }

    @Override
    public Set<String> listTags(String aLayer, String aTagsetName)
    {
        Set<String> tagSet = new TreeSet<String>();
        for (String tag : model.getOutcomes()) {
            if (tagSplitPattern != null) {
                tag = tag.split(tagSplitPattern)[0];
            }
            tagSet.add(tag);
        }

        return tagSet;
    }

    public SequenceClassificationModel<String> getModel()
    {
        return model;
    }
}