BratTextAnnotation.java

/*
 * Copyright 2015
 * 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.io.brat.internal.model;

import java.io.IOException;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import com.fasterxml.jackson.core.JsonGenerator;

public class BratTextAnnotation
    extends BratAnnotation
{
    private static final Pattern PATTERN = Pattern.compile(
            "(?<ID>T[0-9]+)\\t" + 
            "(?<TYPE>[a-zA-Z_][a-zA-Z0-9_\\-]+) " +
            "(?<BEGIN>[0-9]+) " +
            "(?<END>[0-9]+)\\t" +
            "(?<TEXT>.*)");
    
    private static final String ID = "ID";
    private static final String TYPE = "TYPE";
    private static final String BEGIN = "BEGIN";
    private static final String END = "END";
    private static final String TEXT = "TEXT";
    
    private final int begin;
    private final int end;
    private final String text;

    public BratTextAnnotation(int aId, String aType, int aBegin, int aEnd, String aText)
    {
        this("T" + aId, aType, aBegin, aEnd, aText);
    }

    public BratTextAnnotation(String aId, String aType, int aBegin, int aEnd, String aText)
    {
        super(aId, aType);
        begin = aBegin;
        end = aEnd;
        text = aText;
    }

    public int getBegin()
    {
        return begin;
    }

    public int getEnd()
    {
        return end;
    }
    
    public String getText()
    {
        return text;
    }
    
    @Override
    public void write(JsonGenerator aJG)
        throws IOException
    {
        // Format: [${ID}, ${TYPE}, [[${START}, ${END}]]]
        // note that range of the offsets are [${START},${END})
        // ['T1', 'Person', [[0, 11]]]
        
        aJG.writeStartArray();
        aJG.writeString(getId());
        aJG.writeString(getType());
        aJG.writeStartArray();
        aJG.writeStartArray();
        aJG.writeNumber(begin);
        aJG.writeNumber(end);
        aJG.writeEndArray();
        aJG.writeEndArray();
        aJG.writeEndArray();
    }
    
    @Override
    public String toString()
    {
        return getId() + '\t' + getType() + ' ' + begin + ' ' + end + '\t' + text;
    }

    public static BratTextAnnotation parse(String aLine)
    {
        Matcher m = PATTERN.matcher(aLine);
        
        if (!m.matches()) {
            throw new IllegalArgumentException("Illegal text annotation format ["+aLine+"]");
        }

        return new BratTextAnnotation(m.group(ID), m.group(TYPE), Integer.valueOf(m.group(BEGIN)),
                Integer.valueOf(m.group(END)), m.group(TEXT));
    }
}