gdv.xport.feld.NumFeld 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
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.
The newest version!
/*
* Copyright (c) 2009 - 2023 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 09.10.2009 by Oli B. ([email protected])
*/
package gdv.xport.feld;
import de.jfachwert.pruefung.exception.LocalizedIllegalArgumentException;
import de.jfachwert.pruefung.exception.ValidationException;
import gdv.xport.config.Config;
import org.apache.commons.lang3.StringUtils;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.math.RoundingMode;
import java.text.NumberFormat;
/**
* Klasse fuer numerische Zeichen. Die Default-Einstellung fuer die
* Darstellung ist rechtsbuendig.
*
* Siehe Broschuere_gdv-datensatz_vu-vermittler.pdf, Seite 16
* ("Datenfelder/Feldformate").
*
*
* @author oliver
*/
public class NumFeld extends Feld {
private static final Logger LOG = LogManager.getLogger(NumFeld.class);
private static final Feld.Validator DEFAULT_VALIDATOR =new NumFeld.Validator(Config.getInstance());
private final int nachkommastellen;
/**
* @param name Feld-Bezeichner (z.B. "Anzahl Saetze")
* @param s z.B. "4"
* @deprecated bitte anderen Constructor verwenden
* (TODO: wird mit v8 entsorgt)
*/
@Deprecated
public NumFeld(final String name, final String s) {
this(Bezeichner.of(name), s.length(), 1, 0, Config.getInstance());
this.setInhalt(s);
}
/**
* Legt ein neues numerisches Feld an.
*
* @param bezeichner Feld-Bezeichner (z.B. "Anzahl Saetze")
* @param length Anzahl Bytes
* @param start Start-Byte (beginnend bei 1)
* @since 1.0
* @deprecated durch entsprechenden Constructor mit ByteAdresse ersetzt
* (TODO: wird mit v8 entsorgt)
*/
@Deprecated
public NumFeld(Bezeichner bezeichner, int length, int start) {
this(bezeichner, length, start, 0, Config.getInstance());
}
/**
* Legt ein neues numerisches Feld an.
*
* @param bezeichner Feld-Bezeichner (z.B. "Anzahl Saetze")
* @param length Anzahl Bytes
* @param start Start-Adresse
* @since 7.0 (07-Jan-2024)
*/
public NumFeld(Bezeichner bezeichner, int length, ByteAdresse start) {
this(bezeichner, length, start, 0, Config.getInstance());
}
/**
* Legt ein neues numerisches Feld an.
*
* @param bezeichner Feld-Bezeichner (z.B. "Anzahl Saetze")
* @param length Anzahl Bytes
* @param start Start-Byte (beginnend bei 1)
* @param value z.B. "01"
* @since 1.0
* @deprecated durch entsprechenden Constructor mit ByteAdresse ersetzt
* (TODO: wird mit v8 entsorgt)
*/
@Deprecated
public NumFeld(final Bezeichner bezeichner, final int length, final int start, final int value) {
this(bezeichner, length, start);
this.setInhalt(value);
}
/**
* Legt ein neues numerisches Feld an.
*
* @param bezeichner Feld-Bezeichner (z.B. "Anzahl Saetze")
* @param length Anzahl Bytes
* @param start Start-Byte (beginnend bei 1)
* @param value z.B. "01"
* @since 7.0 (07-Jan-2024)
*/
public NumFeld(final Bezeichner bezeichner, final int length, final ByteAdresse start, final int value) {
this(bezeichner, length, start);
this.setInhalt(value);
}
/**
* @since 0.4
* @param name Feld-Bezeichner (z.B. "Anzahl Saetze")
* @param start Start-Byte (beginnend bei 1)
* @param value z.B. "01"
* @deprecated durch entsprechenden Constructor mit Bezeichner und ByteAdresse ersetzt
* (TODO: wird mit v8 entsorgt)
*/
@Deprecated
public NumFeld(final String name, final int start, final String value) {
this(Bezeichner.of(name), value.length(), start);
this.setInhalt(value);
}
/**
* @since 0.4
* @param name Feld-Bezeichner (z.B. "pi")
* @param s der Inhalt (z.B. "314")
* @param nachkommastellen Anzahl der Nachkommastellen (z.B. 2)
* @deprecated durch entsprechenden Constructor mit Bezeichner ersetzt
* (TODO: wird mit v8 entsorgt)
*/
@Deprecated
public NumFeld(final String name, final String s, final int nachkommastellen) {
this(Bezeichner.of(name), s.length(), 1, nachkommastellen, Config.getInstance());
this.setInhalt(s);
}
/**
* Instantiiert ein neues numerisches Feld.
*
* @param name Feld-Bezeichner (z.B. "pi")
* @param start Start-Byte (beginnend ab 1)
* @param value der Inhalt (z.B. "314")
* @param nachkommastellen Anzahl der Nachkommastellen (z.B. 2)
* @since 4.0
* @deprecated durch entsprechenden Constructor mit ByteAdresse ersetzt
* (TODO: wird mit v8 entsorgt)
*/
@Deprecated
public NumFeld(final Bezeichner name, final int start, final String value, final int nachkommastellen) {
this(name, value.length(), start, nachkommastellen, Config.getInstance());
this.setInhalt(value);
}
/**
* Instantiiert ein neues numerisches Feld.
*
* @param name Feld-Bezeichner (z.B. "pi")
* @param start Start-Byte (beginnend ab 1)
* @param value der Inhalt (z.B. "314")
* @param nachkommastellen Anzahl der Nachkommastellen (z.B. 2)
* @since 7.0 (07-Jan-2024)
*/
public NumFeld(final Bezeichner name, final ByteAdresse start, final String value, final int nachkommastellen) {
this(name, value.length(), start, nachkommastellen, Config.getInstance());
this.setInhalt(value);
}
/**
* Legt ein neues numerisches Feld an.
*
* @param name Feld-Bezeichner (z.B. "pi")
* @param length Gesamtlaenge
* @param start Start-Byte (beginnend ab 1)
* @param value der Inhalt (z.B. 314)
* @param nachkommastellen Anzahl der Nachkommastellen (z.B. 2)
* @since 1.0
* @deprecated durch entsprechenden Constructor mit ByteAdresse ersetzt
* (TODO: wird mit v8 entsorgt)
*/
@Deprecated
public NumFeld(final Bezeichner name, final int length, final int start, final int value,
final int nachkommastellen) {
this(name, length, start, nachkommastellen, Config.getInstance());
this.setInhalt(value);
}
/**
* Legt ein neues numerisches Feld an.
*
* @param name Feld-Bezeichner (z.B. "pi")
* @param length Gesamtlaenge
* @param start Start-Byte (beginnend ab 1)
* @param value der Inhalt (z.B. 314)
* @param nachkommastellen Anzahl der Nachkommastellen (z.B. 2)
* @since 7.0 (07-Jan-2024)
*/
public NumFeld(final Bezeichner name, final int length, final ByteAdresse start, final int value,
final int nachkommastellen) {
this(name, length, start, nachkommastellen, Config.getInstance());
this.setInhalt(value);
}
@Deprecated // TODO: wird mit v8 entsorgt
protected NumFeld(final Bezeichner name, final int length, final int start,
final int nachkommastellen, final Config config) {
super(name, length, start, Align.RIGHT, config);
this.nachkommastellen = nachkommastellen;
this.setInhalt(0);
}
protected NumFeld(final Bezeichner name, final int length, final ByteAdresse start,
final int nachkommastellen, final Config config) {
super(name, length, start, Align.RIGHT, config);
this.nachkommastellen = nachkommastellen;
this.setInhalt(0);
}
/**
* Dies ist der Copy-Constructor, mit dem man ein bestehendes Feld
* kopieren kann.
*
* @param other das originale Feld
*/
public NumFeld(final Feld other) {
this(other, other.config);
}
protected NumFeld(Feld other, Config config) {
super(other, config);
if (other instanceof NumFeld) {
this.nachkommastellen = ((NumFeld) other).nachkommastellen;
} else {
this.nachkommastellen = 0;
}
}
/**
* Liefert ein neues NumFeld mit der gewuenschten Anzahl von Nachkommastellen zurueck.
*
* @since 0.4
* @param n Anzahl der Nachkommastellen
* @return neues NumFeld mit n Nachkommastellen
*/
public NumFeld mitNachkommastellen(final int n) {
if (n > this.getAnzahlBytes()) {
throw new IllegalArgumentException(n + " Nachkommastellen sind zuviel (max. "
+ this.getAnzahlBytes() + " moeglich)");
}
return new NumFeld(this.getBezeichner(), this.getByteAdresse(), this.getInhalt(), n);
}
/**
* Liefert eine neues NumFeld mit neuer Konfiguration
*
* @param c neue Konfiguration
* @return neues NumFeld
* @since 5.3
*/
@Override
public NumFeld mitConfig(Config c) {
return new NumFeld(this, c);
}
/**
* Liefert die Anzahl der Nachkommastellen.
*
* @return Anzahl der Nachkommastellen
*/
public int getNachkommastellen() {
return this.nachkommastellen;
}
/**
* Setzt den Inhalt mit der uebergebenen Ziffer.
*
* @param c neuer Inhalt
*/
@Override
public void setInhalt(final char c) {
this.setInhalt(Character.digit(c, 10));
}
/**
* Setzt den Inhalt mit der uebergebenen Zahl unter Beruecksichtigung
* der Nachkommastellen.
*
* ACHTUNG: Ab 5.1 werden hier die Nachkommastellen beruecksichtigt.
*
*
* @param n neuer Inhalt
* @throws IllegalArgumentException wenn n < 0
*/
@Override
public void setInhalt(final long n) {
if (LOG.isDebugEnabled() && getNachkommastellen() > 0) {
LOG.debug("Ab v5.1 wird hier Zahl {} mit {} 0en gesetzt.", n, getNachkommastellen());
}
this.setInhalt(new BigDecimal(n));
}
/**
* Setzt den Inhalt mit der uebergebenen Zahl unter Beruecksichtigung
* der Nachkommastellen.
*
* ACHTUNG: Ab 5.1 werden hier die Nachkommastellen beruecksichtigt.
*
*
* @param n neuer Inhalt
* @throws IllegalArgumentException wenn n < 0
*/
@Override
public void setInhalt(final BigInteger n) {
setInhalt(new BigDecimal(n.toString()));
}
/**
* Setzt den Inhalt mit der uebergebenen Zahl.
*
* @param n Zahl
* @throws IllegalArgumentException wenn n < 0
* @since 5.0
*/
@Override
public void setInhalt(BigDecimal n) {
setInhalt(n.movePointRight(this.nachkommastellen).setScale(0, RoundingMode.HALF_UP).toString());
}
/**
* Setzt den Inhalt eines Feldes als Double. Nach Moeglichkeit soll
* {@link NumFeld#setInhalt(BigDecimal)} verwendet werden, da die
* interne Darstellung von double-Werten nie exakt sind.
*
* @param x der neue Inhalt
* @throws IllegalArgumentException wenn n < 0
* @since 6.1
*/
public void setInhalt(final double x) {
this.setInhalt(BigDecimal.valueOf(x));
}
protected String pack(String s) {
return StringUtils.stripStart(s, "0");
}
public String getInhalt() {
String zeroes = StringUtils.repeat('0', this.getAnzahlBytes() - this.inhalt.length());
return zeroes + this.inhalt;
}
// /* (non-Javadoc)
// * @see gdv.xport.feld.Feld#resetInhalt()
// */
// @Override
// public void resetInhalt() {
// int anzahlBytes = this.getAnzahlBytes();
// for (int i = 0; i < anzahlBytes; i++) {
// this.setInhalt('0', i);
// }
// }
@Override
protected String truncate(String s) {
if (s.startsWith("0") && (s.length() > 1)) {
return truncate(s.substring(1));
} else if (s.length() > getAnzahlBytes()) {
LOG.info("NumFeld {} wird auf {} Ziffern gekuerzt", getBezeichner(), getAnzahlBytes());
return StringUtils.repeat('9', getAnzahlBytes());
}
return s;
}
/**
* Wandelt den Inhalt in einen Integer (ohne Beruecksichtigung etwaiger
* Nachkommastellen).
*
* @return den Inhalt als int
*/
public int toInt() {
return toBigDecimal().intValue();
}
/**
* Wandelt den Inhalt in einen Long (ohne Beruecksichtigung etwaiger
* Nachkommastellen).
*
* @return den Inhalt als long
*/
public long toLong() {
return toBigDecimal().longValue();
}
/**
* Wenn eine Zahl Nachkommastellen hat, sollte sie auch als Double
* ausgegeben werden koennen.
*
* @since 0.4
* @return die Zahl als Double
*/
public double toDouble() {
return toBigDecimal().doubleValue();
}
/**
* Fuer grosse Zahlen kann auch schon mal ein {@link BigInteger} noetig
* sein.
*
* @since 5.4
* @return die Zahl als {@link BigInteger}
*/
public BigInteger toBigInteger() {
return toBigDecimal().toBigInteger();
}
/**
* Wenn eine Zahl Nachkommastellen hat, sollte sie auch als {@link BigDecimal}
* ausgegeben werden koennen.
*
* @since 5.0
* @return die Zahl als {@link BigDecimal}
*/
public BigDecimal toBigDecimal() {
BigDecimal d = new BigDecimal(getInhalt().trim());
return d.movePointLeft(this.nachkommastellen);
}
/**
* Addiert den Summand auf und liefert die Summe zurueck.
*
* @param summand der aufaddiert wird
* @return Summe
* @since 5.0
*/
public BigDecimal add(BigDecimal summand) {
BigDecimal summe = toBigDecimal().add(summand);
setInhalt(summe);
return summe.setScale(nachkommastellen, RoundingMode.UP);
}
// /**
// * Dient zum Ermittel, ob ein Werte schon gesetzt wurde. Dabei werden
// * typische Initialisierungswerte wie "0" als "nicht gesetzt"
// * interpretiert.
// *
// * @return true, falls Feld mit einem Wert belegt ist
// * @since 3.1
// */
// @Override
// public boolean hasValue() {
// try {
// return !ZERO.equals(toBigDecimal());
// } catch (NumberFormatException ex) {
// LOG.debug("{} hat ungueltigen Wert:", this, ex);
// return false;
// }
// }
/* (non-Javadoc)
* @see gdv.xport.feld.Feld#format()
*/
@Override
public String format() {
NumberFormat nf = NumberFormat.getInstance();
if (this.nachkommastellen == 0) {
return nf.format(this.toLong());
}
nf.setMinimumFractionDigits(this.nachkommastellen);
nf.setMaximumFractionDigits(this.nachkommastellen);
return nf.format(this.toDouble());
}
/* (non-Javadoc)
* @see gdv.xport.feld.Feld#clone()
*/
@SuppressWarnings("squid:S2975")
@Override
public Object clone() {
return new NumFeld(this);
}
/**
* Die Validierung von Werten wurde jetzt in einer eingenen Validator-
* Klasse zusammengefasst. Damit kann die Validierung auch unabhaengig
* von NumFeld-Klasse im Vorfeld eingesetzt werden, um Werte auf ihre
* Gueltigkeit pruefen zu koennen.
*
* @since 5.3
*/
public static class Validator extends Feld.Validator {
public Validator() {
super();
}
public Validator(Config config) {
super(config);
}
@Override
protected String validateLax(String value) {
String nummer = value.trim();
LOG.debug("{} wird als Zahl validiert.", nummer);
if (StringUtils.isNotBlank(nummer)) {
try {
BigInteger n = new BigInteger(nummer);
if (n.compareTo(BigInteger.ZERO) < 0) {
throw new javax.validation.ValidationException(String.format("'%s' darf nicht negativ sein", nummer));
}
} catch (NumberFormatException nfe) {
throw new javax.validation.ValidationException(String.format("'%s' ist keine Zahl", nummer), nfe);
}
}
return nummer;
}
@Override
protected String validateStrict(String value) {
if (!StringUtils.trim(value).equals(value) || StringUtils.isBlank(value)) {
throw new ValidationException("Zahl muss vorhanden sein und darf keine Leerzeichen enthalten");
} else {
return validateLax(value);
}
}
@Override
public String verify(String value) {
try {
return super.verify(value);
} catch (javax.validation.ValidationException ex) {
throw new LocalizedIllegalArgumentException(ex);
}
}
}
}