de.jfachwert.formular.Familienstand.java Source code

Introduction

Here is the source code for de.jfachwert.formular.Familienstand.java

Source

/*
 * Copyright (c) 2017 by Oliver Boehm
 *
 * 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.
 *
 * (c)reated 28.11.2017 by oboehm (ob@oasd.de)
 */
package de.jfachwert.formular;

import org.apache.commons.lang3.StringUtils;

/**
 * Der Familienstand gehoert in Deutschland zu den Personenstandsdaten einer
 * Person und gibt an, ob diese ledig, verheiratet, geschieden oder verwitwet
 * ist. Der Familienstand wird im Melderegister gespeichert und dabei wie folgt
 * verschluesselt:
 * <ul>
 *     <li> LD (ledig) </li>
 *     <li> VH (verheiratet) </li>
 *     <li> VW (verwitwet) </li>
 *     <li> GS (geschieden) </li>
 *     <li> EA (Ehe aufgehoben) </li>
 *     <li> LP (in eingetragener Lebenspartnerschaft) </li>
 *     <li> LV (durch Tod aufgeloeste Lebenspartnerschaft) </li>
 *     <li> LA (aufgehobene Lebenspartnerschaft) </li>
 *     <li> LE (durch Todeserklrung aufgelste Lebenspartnerschaft) </li>
 *     <li> NB (nicht bekannt) </li>
 * </ul>
 * <p>
 * aus: Koordinierungsstelle fr IT-Standards (Hrsg.): Datensatz fr das
 * Meldewesen. Einheitlicher Bundes-/Laenderteil (DSMeld),
 * Stand: 1. Mai 2015, Blatt 1401
 * </p>
 *
 * @since 2.0
 */
public enum Familienstand {

    /** Ledig. */
    LEDIG("LD", "ledig"),

    /** Verheiratet. */
    VERHEIRATET("VH", "verheiratet"),

    /** Verheiratet. */
    VERWITWET("VW", "verwitwet"),

    /** Geschieden - der Zustand nach verheiratet. */
    GESCHIEDEN("GS", "geschieden"),

    /** Ehe aufgehoben. */
    EHE_AUFGEHOBEN("EA", "Ehe aufgehoben"),

    /** In eingetragener Lebenspartnerschaft. */
    EINGETRAGENE_LEBENSPARTNERSCHAFT("LP", "eingetragene Lebenspartnerschaft"),

    /** Eheaehnliche Gemeinschaft. */
    EHEAEHNLICHE_GEMEINSCHAFT("EG", "ehe\u00e4hnliche Gemeinschaft"),

    /** Lebenspartnerschaft, die durch den Tod beendet wurde. */
    DURCH_TOD_AUFGELOESTE_LEBENSPARTNERSCHAFT("LV", "durch Tod aufgel\u00f6ste Lebenspartnerschaft"),

    /** Aufgehobene Lebenspartnerschaft. */
    AUFGEHOBENE_LEBENSPARTNERSCHAFT("LA", "getrennt lebend"),

    /** Lebenspartnerschaft, die durch eine Todeserklaerung aufgeloest wurde. */
    DURCH_TODESERKLAERUNG_AUFGELOESTE_LEBENSPARTNERSCHAFT("LE",
            "durch Todeserklrung aufgelste Lebenspartnerschaft"),

    /** Unbekannter Familienstand. */
    NICHT_BEKANNT("NB", "nicht bekannt");

    private final String schluessel;
    private final String text;

    Familienstand(String schluessel, String text) {
        this.schluessel = schluessel;
        this.text = text;
    }

    /**
     * Liefert den zweistelligen Schluessel gemaess Datensatz des Meldewesens.
     *
     * @return z.B. "VW" fuer "verwittwet"
     */
    public String getSchluessel() {
        return schluessel;
    }

    /**
     * Als Ergebnis werden die einzelnen Elemente in normaler Schreibweise
     * ausgegeben und nicht in kompletter Grossschreibung.
     *
     * @return z.B. "ledig"
     */
    @Override
    public String toString() {
        return text;
    }

    /**
     * Liefert zu einem Schluessel den entsprechende Familienstand. Falls
     * nichts gefunden wird, wird NICHT_BEKANNT zurueckgeliefert.
     *
     * @param schluessel z.B. "LE"
     * @return Familienstand, z.B. LEDIG
     */
    public static Familienstand of(String schluessel) {
        String normalized = StringUtils.trimToEmpty(schluessel);
        if (normalized.length() == 2) {
            return findSchluessel(normalized);
        } else {
            return findText(schluessel);
        }
    }

    private static Familienstand findSchluessel(String schluessel) {
        for (Familienstand familienstand : Familienstand.values()) {
            if (familienstand.schluessel.equalsIgnoreCase(schluessel)) {
                return familienstand;
            }
        }
        return NICHT_BEKANNT;
    }

    private static Familienstand findText(String text) {
        for (Familienstand familienstand : Familienstand.values()) {
            if (familienstand.text.equalsIgnoreCase(text)) {
                return familienstand;
            }
        }
        return NICHT_BEKANNT;
    }

}