gdv.xport.satz.xml.FeldReferenz Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gdv-xport-lib Show documentation
gdv-xport-lib ist die Java-Bibliothek fuer den Umgang mit dem GDV-Format. Sie erleichtert den Export und Export dieses Datenformats.
There is a newer version: 7.2.2
Show newest version
/*
 * Copyright (c) 2014 by Oli B.
 *
 * 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 orimplied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * (c)reated 07.08.2014 by Oli B. ([email protected])
 */

package gdv.xport.satz.xml;

import gdv.xport.feld.Bezeichner;
import gdv.xport.util.XmlHelper;
import org.apache.commons.lang3.StringUtils;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

import javax.xml.namespace.QName;
import javax.xml.stream.XMLEventReader;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.events.StartElement;
import java.util.ArrayList;
import java.util.List;
import java.util.Properties;

/**
 * Diese Klasse repraesentiert den Wert, der als "<feldreferenz>" ueber XML
 * reinkommt.
 *
 * @author oliver ([email protected])
 * @since 1.0 (07.08.2014)
 */
public final class FeldReferenz {

    private static final Logger LOG = LogManager.getLogger(FeldReferenz.class);

    private final String id;
    private final Bezeichner bezeichner;
    private final String bemerkung;
    private final String auspraegung;

    /**
     * Instantiiert eine Objekt mit den Werten, die ueber den uebergebenen
     * Parser gelesen werden.
     *
     * @param parser the parser
     * @throws XMLStreamException the XML stream exception
     */
    public FeldReferenz(final XMLEventReader parser) throws XMLStreamException {
        this(parser, XmlHelper.getNextStartElement(parser));
    }

    /**
     * Instantiiert eine Objekt mit den Werten, die ueber den uebergebenen
     * Parser gelesen werden.
     *
     * @param parser the parser
     * @param element das Start-Element <feldreferenz referenz=... >
     * @throws XMLStreamException the XML stream exception
     */
    public FeldReferenz(final XMLEventReader parser, final StartElement element) throws XMLStreamException {
        id = element.getAttributeByName(new QName("referenz")).getValue();
        Properties props = XmlHelper.parseSimpleElements(element.getName(), parser);
        this.bezeichner = new Bezeichner(props);
        this.bemerkung = props.getProperty("bemerkung", "");
        this.auspraegung = props.getProperty("auspraegung", "");
        LOG.debug("{} created.", this);
    }

    /**
     * Liefert die Referenz (Id).
     *
     * @return z.B. "BN-2003.02.11.22.49.47.214"
     */
    public String getId() {
        return this.id;
    }

    /**
     * Liefert den Bezeichner mit Name und technischen Namen.
     *
     * @return den Bezeichner
     */
    public Bezeichner getBezeichner() {
        return this.bezeichner;
    }

    /**
     * Gets the name.
     *
     * @return the name
     */
    public String getName() {
        return this.bezeichner.getName();
    }

    /**
     * Gets the technischer name.
     *
     * @return the technischer name
     */
    public String getTechnischerName() {
        return this.bezeichner.getTechnischerName();
    }

    /**
     * Gets the auspraegung.
     *
     * @return the auspraegung
     */
    public String getAuspraegung() {
        return this.auspraegung;
    }

    /**
     * Gets the bemerkung.
     *
     * @return the bemerkung
     */
    public String getBemerkung() {
        return this.bemerkung;
    }

    /**
     * Die Default-Werte werde aus dem Bemerkungsfeld abgeleitet. Dies wird
     * vor allem fuer die moeglichen Wagnisarten verwendet.
     *
     * @return Liste mit moeglichen Werten (kann leer sein)
     */
    public List getDefaultWerte() {
        List defaultWerte = new ArrayList();
        String[] lines = this.bemerkung.trim().split("\n");
        for (int i = 0; i < lines.length; i++) {
            String[] values = lines[i].split("=");
            if (values.length == 2) {
                defaultWerte.add(values[0].trim());
            }
        }
        return defaultWerte;
    }

    /**
     * Dient zum Ermitteln, ob uerhaupt das auspraegung-Feld belegt ist.
     *
     * @return true falls auspraegung > 0
     */
    public boolean hasAuspraegung() {
        return StringUtils.isNotEmpty(this.auspraegung);
    }

    /* (non-Javadoc)
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        return this.getClass().getSimpleName() + " \"" + this.id + "\" (" + this.bezeichner + ")";
    }

}