// Copyright 2011 Google Inc. All Rights Reserved.
//
// 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 com.hughes.android.dictionary.engine;

public enum EntryTypeName {

    WIKTIONARY_TITLE_SINGLE_DETAIL(true, true, null),
    WIKTIONARY_TITLE_SINGLE(true, true, null),
    WIKTIONARY_INFLECTD_FORM_SINGLE(false, true, null),

    ONE_WORD(true, true, null),
    MULTIROW_HEAD_ONE_WORD(true, true, null),
    MULTIROW_TAIL_ONE_WORD(false, true, null),

    SYNONYM_SINGLE(false, true, null),
    ANTONYM_SINGLE(false, true, null),

    WIKTIONARY_TITLE_MULTI_DETAIL(false, true, WIKTIONARY_TITLE_SINGLE_DETAIL),
    WIKTIONARY_TITLE_MULTI(false, true, WIKTIONARY_TITLE_SINGLE),
    WIKTIONARY_TRANSLITERATION(),
    // How we file "casa {f}, case {pl}" under "case"
    WIKTIONARY_INFLECTED_FORM_MULTI(false, true, WIKTIONARY_INFLECTD_FORM_SINGLE),
    WIKTIONARY_ENGLISH_DEF_WIKI_LINK(),
    WIKTIONARY_ENGLISH_DEF_OTHER_LANG(),
    WIKTIONARY_ENGLISH_DEF(),

    SYNONYM_MULTI(false, true, SYNONYM_SINGLE),
    ANTONYM_MULTI(false, true, ANTONYM_SINGLE),
    DERIVED_TERM(false, true, null),

    TWO_WORDS(),
    THREE_WORDS(),
    FOUR_WORDS(),
    FIVE_OR_MORE_WORDS(),
    WIKTIONARY_TRANSLATION_WIKI_TEXT(),
    WIKTIONARY_TRANSLATION_OTHER_TEXT(),

    // How we file entries like: "sono: {form of|essere}" under "sono.".
    WIKTIONARY_IS_FORM_OF_SOMETHING_ELSE(false, true, null),

    MULTIROW_HEAD_MANY_WORDS(),
    MULTIROW_TAIL_MANY_WORDS(),
    WIKTIONARY_EXAMPLE(),

    // The next two are how we file entries like: "sono: {form of|essere}" under
    // "essere".
    WIKTIONARY_BASE_FORM_SINGLE(), // These two should be eligible for removal
    // if the links are otherwise present.
    WIKTIONARY_BASE_FORM_MULTI(false, false, WIKTIONARY_BASE_FORM_SINGLE),
    PART_OF_HYPHENATED(),
    BRACKETED(),
    PARENTHESIZED(),
    WIKTIONARY_TRANSLATION_SENSE(),
    SEE_ALSO(),
    WIKTIONARY_MENTIONED(false, true, null), ;

    final boolean mainWord;
    final boolean overridesStopList;
    final EntryTypeName singleWordInstance;

    EntryTypeName() {
        this(false, false, null);
    }

    EntryTypeName(final boolean mainWord, final boolean overridesStopList,
    final EntryTypeName singleWordInstance) {
        this.mainWord = mainWord;
        this.overridesStopList = overridesStopList;
        this.singleWordInstance = singleWordInstance == null ? this : singleWordInstance;
    }

}