Mode.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.model;

import de.tudarmstadt.ukp.clarin.webanno.support.PersistentEnum;

/**
 * Subjects of interest, either annotation or curation.
 */
public enum Mode
    implements PersistentEnum
{
    /**
     * This mode is used when the user is in the annotation page of WebAnno and perform any of the
     * tasks such as creating annotation document, setting annotation preference, exporting file and
     * so on. Besides it help identifying the type of the project (Annotation Project or Correction
     * Project)
     *
     */
    ANNOTATION("annotation"),
    /**
     * This mode is used when the user is in the Automation Page making correction of automatically
     * annotated documents as well as automation of annotations (Using prediction or Machine
     * learning techniques). Besides it help identifying the type of the project (Annotation Project
     * or Correction or Automation Project)
     */
    AUTOMATION("automation"),
    /**
     * This mode is used when the user is in the curation page of WebAnno and perform any of the
     * tasks such as creating curation document, setting annotation preference, exporting file and
     * so on.
     *
     */
    CURATION("curation"),
    /**
     * This mode is used when the user is in the Correction Page making correction of automatically
     * annotated documents. Besides it help identifying the type of the project (Annotation Project
     * or Correction Project)
     */
    CORRECTION("correction");

    public String getName()
    {
        return getId();
    }

    @Override
    public String toString()
    {
        return getId();
    }

    Mode(String aId)
    {
        this.id = aId;
    }

    private final String id;

    @Override
    public String getId()
    {
        return id;
    }
}