AnnotationSelection.java

/*
 * Copyright 2012
 * Ubiquitous Knowledge Processing (UKP) Lab and FG Language Technology
 * 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.clarin.webanno.ui.curation.component.model;

import java.io.Serializable;
import java.util.LinkedHashMap;
import java.util.Map;

/**
 * This class comprises usernames, which agree on a specific annotation (same annotation type, same
 * annotation value, same position).
 *
 */
public class AnnotationSelection
    implements Serializable
{
    private static final long serialVersionUID = -8839941493657969753L;
    private Map<String, Integer> addressByUsername = new LinkedHashMap<>();
//    private transient Map<String, FeatureStructure> fsStringByUsername = new LinkedHashMap<>();
    private AnnotationOption annotationOption = null;

    public AnnotationSelection()
    {
        // TODO Auto-generated constructor stub
    }
    
    public Map<String, Integer> getAddressByUsername()
    {
        return addressByUsername;
    }

    /**
     * Set Map of Username-Address-Tuples. The Map contains only annotations, which have the same
     * annotation type and annotation value, and the same position in the cas. <br>
     * <br>
     * Example:
     *
     * <pre>
     * {"Anno1": 1234, "Anno2": 1235}
     * </pre>
     *
     * @param aAddressByUsername
     *            HashMap of Username-Address-Tuples
     */
    public void setAddressByUsername(Map<String, Integer> aAddressByUsername)
    {
        this.addressByUsername = aAddressByUsername;
    }

    public AnnotationOption getAnnotationOption()
    {
        return annotationOption;
    }

    /**
     *
     * @param annotationOption
     *            the option.
     */
    public void setAnnotationOption(AnnotationOption annotationOption)
    {
        this.annotationOption = annotationOption;
    }

//    @Override
//    public String toString()
//    {
//        return fsStringByUsername.toString();
//    }

    @Override
    public boolean equals(Object obj)
    {
        if (!(obj instanceof AnnotationSelection)) {
            return false;
        }
        AnnotationSelection as = (AnnotationSelection) obj;
        return addressByUsername.equals(as.getAddressByUsername());
    }

    @Override
    public int hashCode()
    {
        return addressByUsername.hashCode();
    }

//    public Map<String, FeatureStructure> getFsStringByUsername()
//    {
//        return fsStringByUsername;
//    }
//
//    public void setFsStringByUsername(Map<String, FeatureStructure> fsStringByUsername)
//    {
//        this.fsStringByUsername = fsStringByUsername;
//    }
}