AbstractLogicalFile (jDTAUS Banking ⁑ RI DTAUS 1.16)

java.lang.Object
- org.jdtaus.banking.dtaus.ri.zka.AbstractLogicalFile

All Implemented Interfaces:

LogicalFile

Direct Known Subclasses:

DTAUSDisk, DTAUSTape
```
public abstract class AbstractLogicalFile
extends Object
implements LogicalFile
```
Abstrakte Klasse für LogicalFile-Implementierungen.
Stellt diverse Hilfs-Methoden sowie die Überprüfung von Vor- und Nachbedingungen zur Verfügung.

Hinweis:
Implementierung ist nicht vor gleichzeitigen Zugriffen unterschiedlicher Threads geschützt.

Version:

$JDTAUS: AbstractLogicalFile.java 8810 2012-12-04 00:45:37Z schulte $

Author:

Christian Schulte

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AbstractLogicalFile.Listener

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AbstractLogicalFile.Listener`

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`ENCODING_ASCII` Konstante für ASCII-Zeichensatz.
`protected static int`	`ENCODING_EBCDI` Konstante für EBCDI-Zeichensatz.
`protected static long[]`	`EXP10` Index = Exponent, Wert = 10er Potenz.
`protected static int`	`MAX_SCHEDULEDAYS` Maximum allowed days between create and execution date.
`protected static long`	`NO_NUMBER` Return-Code.

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractLogicalFile()
Erzeugt eine neue AbstractLogicalFile Instanz.

Constructors
Modifier	Constructor and Description
`protected`	`AbstractLogicalFile()` Erzeugt eine neue `AbstractLogicalFile` Instanz.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addListener(AbstractLogicalFile.Listener listener)` Adds a `Listener` to the listener list.
`int`	`addTransaction(Transaction transaction)`
`protected abstract int`	`byteCount(Transaction transaction)` Ermittlung der Bytes einer Transaktion.
`protected boolean`	`checkDate(Date date)` Prüfung eines Datums.
`protected void`	`checksum()`
`protected boolean`	`checkTransactionCount(int transactionCount)` Prüfung einer Menge von Transaktionen.
`protected boolean`	`checkTransactionId(int id, Checksum checksum)` Prüfung einer laufenden Transaktionsnummer.
`void`	`createTransaction(Transaction transaction)`
`protected void`	`fireBytesDeleted(long position, long bytes)` Notifies all registered listeners about deleted bytes.
`protected void`	`fireBytesInserted(long position, long bytes)` Notifies all registered listeners about inserted bytes.
`protected ApplicationLogger`	`getApplicationLogger()` Gets the configured `ApplicationLogger` implementation.
`protected abstract int`	`getBlockSize()` Ermittelt die Größe eines Satzabschnitts.
`protected abstract char`	`getBlockType(long position)` Ermittelt den Typ eines Satzabschnitts.
`Checksum`	`getChecksum()`
`protected long`	`getChecksumPosition()` Liest den Wert der Property `checksumPosition`.
`protected Configuration`	`getConfiguration()` Gets the value of property `configuration`.
`protected CurrencyMapper`	`getCurrencyMapper()` Gets the configured `CurrencyMapper` implementation.
`protected int`	`getDefaultBufferSize()` Gets the value of property `defaultBufferSize`.
`protected Long`	`getDefaultMaximumExtensionCount()` Gets the value of property `defaultMaximumExtensionCount`.
`protected Integer`	`getDefaultMonitoringThreshold()` Gets the value of property `defaultMonitoringThreshold`.
`protected FileOperations`	`getFileOperations()` Ermittelt die zugrunde liegende `FileOperations` Implementierung.
`Header`	`getHeader()`
`protected long`	`getHeaderPosition()` Liest den Wert der Property `headerPosition`.
`protected HeaderValidator[]`	`getHeaderValidator()` Gets the configured `HeaderValidator` implementation.
`protected abstract Implementation`	`getImplementation()` Gets implementation meta-data.
`AbstractLogicalFile.Listener[]`	`getListeners()` Gets all currently registered `Listener`s.
`protected Locale`	`getLocale()` Gets the configured `Locale` implementation.
`protected Logger`	`getLogger()` Gets the configured `Logger` implementation.
`long`	`getMaximumExtensionCount()` Gets the maximum allowed number of extensions.
`protected MemoryManager`	`getMemoryManager()` Gets the configured `MemoryManager` implementation.
`int`	`getMonitoringThreshold()` Gets the value of property `monitoringThreshold`.
`protected String`	`getReadNumberIllegalFileInfoMessage(Locale locale, String readString, Number convertedNumber)` Gets the text of message `readNumberIllegalFileInfo`.
`protected TaskMonitor`	`getTaskMonitor()` Gets the configured `TaskMonitor` implementation.
`protected TextschluesselVerzeichnis`	`getTextschluesselVerzeichnis()` Gets the configured `TextschluesselVerzeichnis` implementation.
`Transaction`	`getTransaction(int index)`
`protected TransactionValidator[]`	`getTransactionValidator()` Gets the configured `TransactionValidator` implementation.
`protected void`	`insertBytes(long position, long bytes)` Inserts a given number of bytes at a given position.
`protected AlphaNumericText27`	`readAlphaNumeric(int field, long position, int len, int encoding)` Hilds-Methode zum Lesen einer alpha-numerischen Zeichenkette.
`protected abstract Checksum`	`readChecksum()` Liest den E Datensatz.
`protected abstract Header`	`readHeader()` Liest den A Datensatz.
`protected Date`	`readLongDate(int field, long position, int encoding)` Hilfs-Methode zum Lesen einer Datums-Angabe mit vierstelliger Jahres-Zahl.
`protected Long`	`readNumber(int field, long position, int len, int encoding)` Hilfs-Methode zum Lesen von Zahlen.
`protected Long`	`readNumber(int field, long position, int len, int encoding, boolean allowSpaces)` Hilfs-Methode zum Lesen von Zahlen mit gegebenenfalls Konvertierung von Leerzeichen zu Nullen.
`protected long`	`readNumberBinary(int field, long position, int len)` Hilfs-Methode zum Lesen von binär gespeicherten Zahlen.
`protected long`	`readNumberPackedPositive(int field, long position, int len, boolean sign)` Hilfs-Methode zum Lesen von gepackten EBCDI Zahlen.
`protected Date`	`readShortDate(int field, long position, int encoding)` Hilfs-Methode zum Lesen einer Datums-Angabe mit zweistelliger Jahres-Zahl.
`protected abstract Transaction`	`readTransaction(long position, Transaction transaction)` Liest einen C Datensatz.
`protected void`	`removeBytes(long position, long bytes)` Removes a given number of bytes at a given position.
`void`	`removeFileOperationsListener(AbstractLogicalFile.Listener listener)` Removes a `Listener` from the listener list.
`Transaction`	`removeTransaction(int index)`
`protected void`	`resizeIndex(int index, Checksum checksum)` Hilfsmethode zum dynamischen Vergrössern des Index.
`protected void`	`setChecksum(Checksum checksum)`
`protected void`	`setChecksumPosition(long checksumPosition)` Schreibt den Wert der Property `checksumPosition`.
`protected void`	`setConfiguration(Configuration configuration)` Sets the value of property `configuration`.
`protected void`	`setFileOperations(FileOperations fileOperations)` Ändert die zu Grunde liegende `FileOperations` Implementierung.
`Header`	`setHeader(Header header)`
`protected void`	`setHeaderPosition(long headerPosition)` Schreibt den Wert der Property `headerPosition`.
`void`	`setMaximumExtensionCount(Long value)` Sets the maximum allowed number of extensions.
`void`	`setMonitoringThreshold(int value)` Sets the value of property `monitoringThreshold`.
`Transaction`	`setTransaction(int index, Transaction transaction)`
`protected void`	`writeAlphaNumeric(int field, long position, int len, String str, int encoding)` Hilfs-Methode zum Schreiben einer Zeichenkette.
`protected abstract void`	`writeChecksum(Checksum checksum)` Schreibt den E Datensatz.
`protected abstract void`	`writeHeader(Header header)` Schreibt den A Datensatz.
`protected void`	`writeLongDate(int field, long position, Date date, int encoding)` Hilfs-Methode zum Schreiben einer Datums-Angabe mit vierstelliger Jahres-Zahl.
`protected void`	`writeNumber(int field, long position, int len, long number, int encoding)` Hilfs-Methode zum Schreiben von Zahlen.
`protected void`	`writeNumberBinary(int field, long position, int len, long number)` Hilfs-Methode zum Schreiben von binär gespeicherten Zahlen.
`protected void`	`writeNumberPackedPositive(int field, long position, int len, long number, boolean sign)` Hilfs-Methode zum Schreiben von gepackten EBCDI-Zahlen.
`protected void`	`writeShortDate(int field, long position, Date date, int encoding)` Hilfs-Methode zum Schreiben einer Datums-Angabe mit zweistelliger Jahres-Zahl.
`protected abstract void`	`writeTransaction(long position, Transaction transaction)` Schreibt einen C Datensatz.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ENCODING_ASCII
```
protected static final int ENCODING_ASCII
```
    Konstante für ASCII-Zeichensatz.
    
    See Also:
    Constant Field Values
  - ENCODING_EBCDI
```
protected static final int ENCODING_EBCDI
```
    Konstante für EBCDI-Zeichensatz.
    
    See Also:
    Constant Field Values
  - EXP10
```
protected static final long[] EXP10
```
    Index = Exponent, Wert = 10er Potenz.
  - MAX_SCHEDULEDAYS
```
protected static final int MAX_SCHEDULEDAYS
```
    Maximum allowed days between create and execution date.
    
    See Also:
    Constant Field Values
  - NO_NUMBER
```
protected static final long NO_NUMBER
```
    Return-Code.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - AbstractLogicalFile
```
protected AbstractLogicalFile()
```
    Erzeugt eine neue AbstractLogicalFile Instanz.
    
    See Also:
    setHeaderPosition(long), setChecksumPosition(long), setFileOperations(org.jdtaus.core.io.FileOperations), checksum()
- Method Detail
  - addListener
```
public void addListener(AbstractLogicalFile.Listener listener)
```
    Adds a Listener to the listener list.
    
    Parameters:
    listener - The listener to be added to the listener list.
    
    Throws:
    
    NullPointerException - if listener is null.
  - addTransaction
```
public int addTransaction(Transaction transaction)
                   throws IOException
```
    Specified by:
    
    addTransaction in interface LogicalFile
    
    Throws:
    
    IOException
  - byteCount
```
protected abstract int byteCount(Transaction transaction)
```
    Ermittlung der Bytes einer Transaktion.
    
    Parameters:
    transaction - Transaktion, für die die Anzahl benötigter Bytes ermittelt werden soll. s
    
    Returns:
    Anzahl der von transaction belegten Bytes.
  - checkDate
```
protected boolean checkDate(Date date)
```
    Prüfung eines Datums.
    
    Parameters:
    date - zu prüfendes Datum.
    
    Returns:
    true wenn date im gültigen Bereich liegt; false wenn nicht,
  - checksum
```
protected void checksum()
                 throws IOException
```
    Throws:
    
    IOException
  - checkTransactionCount
```
protected boolean checkTransactionCount(int transactionCount)
```
    Prüfung einer Menge von Transaktionen.
    
    Parameters:
    transactionCount - zu prüfende Menge Transaktionen.
  - checkTransactionId
```
protected boolean checkTransactionId(int id,
                         Checksum checksum)
```
    Prüfung einer laufenden Transaktionsnummer.
    
    Parameters:
    id - zu prüfende Transaktionsnummer.
    checksum - aktuelle Prüfsumme.
    
    Throws:
    
    NullPointerException - if(checksum == null)
  - createTransaction
```
public final void createTransaction(Transaction transaction)
                             throws IOException
```
    Specified by:
    
    createTransaction in interface LogicalFile
    
    Throws:
    
    IOException
  - fireBytesDeleted
```
protected void fireBytesDeleted(long position,
                    long bytes)
                         throws IOException
```
    Notifies all registered listeners about deleted bytes.
    
    Parameters:
    position - The position of the first deleted byte.
    bytes - The number of bytes which were deleted starting at position inclusive.
    
    Throws:
    
    IOException - if reading or writing fails.
  - fireBytesInserted
```
protected void fireBytesInserted(long position,
                     long bytes)
                          throws IOException
```
    Notifies all registered listeners about inserted bytes.
    
    Parameters:
    position - The position of the first inserted byte.
    bytes - The number of bytes which were inserted at position.
    
    Throws:
    
    IOException - if reading or writing fails.
  - getApplicationLogger
```
protected ApplicationLogger getApplicationLogger()
```
    Gets the configured ApplicationLogger implementation.
    
    Returns:
    The configured ApplicationLogger implementation.
  - getBlockSize
```
protected abstract int getBlockSize()
```
    Ermittelt die Größe eines Satzabschnitts.
    
    Returns:
    Größe eines Satzabschnitts in Byte.
  - getBlockType
```
protected abstract char getBlockType(long position)
                              throws IOException
```
    Ermittelt den Typ eines Satzabschnitts.
    
    Parameters:
    position - Position des zu lesenden Satzabschnitts.
    
    Returns:
    Datensatztyp des an position beginnenden Satzabschnitts position.
    
    Throws:
    
    IOException - wenn nicht gelesen werden kann.
  - getChecksum
```
public Checksum getChecksum()
                     throws IOException
```
    Specified by:
    
    getChecksum in interface LogicalFile
    
    Throws:
    
    IOException
  - getChecksumPosition
```
protected long getChecksumPosition()
```
    Liest den Wert der Property checksumPosition.
    
    Returns:
    Position des E-Datensatzes.
  - getConfiguration
```
protected Configuration getConfiguration()
```
    Gets the value of property configuration.
    
    Returns:
    Implementation configuration.
  - getCurrencyMapper
```
protected CurrencyMapper getCurrencyMapper()
```
    Gets the configured CurrencyMapper implementation.
    
    Returns:
    The configured CurrencyMapper implementation.
  - getDefaultBufferSize
```
protected int getDefaultBufferSize()
```
    Gets the value of property defaultBufferSize.
    
    Returns:
    Size of the pre-alocated default buffer in byte.
  - getDefaultMaximumExtensionCount
```
protected Long getDefaultMaximumExtensionCount()
```
    Gets the value of property defaultMaximumExtensionCount.
    
    Returns:
    Default maximum number of extensions allowed in a C record (field C18).
  - getDefaultMonitoringThreshold
```
protected Integer getDefaultMonitoringThreshold()
```
    Gets the value of property defaultMonitoringThreshold.
    
    Returns:
    Number of bytes which need to minimally be copied to enable any task monitoring during copy operations.
  - getFileOperations
```
protected FileOperations getFileOperations()
```
    Ermittelt die zugrunde liegende FileOperations Implementierung.
    
    Returns:
    zugrunde liegende FileOperations Implementierung.
  - getHeader
```
public Header getHeader()
                 throws IOException
```
    Specified by:
    
    getHeader in interface LogicalFile
    
    Throws:
    
    IOException
  - getHeaderPosition
```
protected long getHeaderPosition()
```
    Liest den Wert der Property headerPosition.
    
    Returns:
    Position des A Datensatzes.
  - getHeaderValidator
```
protected HeaderValidator[] getHeaderValidator()
```
    Gets the configured HeaderValidator implementation.
    
    Returns:
    The configured HeaderValidator implementation.
  - getImplementation
```
protected abstract Implementation getImplementation()
```
    Gets implementation meta-data.
    
    Returns:
    implementation meta-data.
  - getListeners
```
public AbstractLogicalFile.Listener[] getListeners()
```
    Gets all currently registered Listeners.
    
    Returns:
    all currently registered Listeners.
  - getLocale
```
protected Locale getLocale()
```
    Gets the configured Locale implementation.
    
    Returns:
    The configured Locale implementation.
  - getLogger
```
protected Logger getLogger()
```
    Gets the configured Logger implementation.
    
    Returns:
    The configured Logger implementation.
  - getMaximumExtensionCount
```
public long getMaximumExtensionCount()
```
    Gets the maximum allowed number of extensions.
    
    Returns:
    The maximum allowed number of extensions.
    Since:
    
    1.12
  - getMemoryManager
```
protected MemoryManager getMemoryManager()
```
    Gets the configured MemoryManager implementation.
    
    Returns:
    The configured MemoryManager implementation.
  - getMonitoringThreshold
```
public int getMonitoringThreshold()
```
    Gets the value of property monitoringThreshold.
    
    Returns:
    The mininum number of bytes to copy to start any task monitoring.
  - getReadNumberIllegalFileInfoMessage
```
protected String getReadNumberIllegalFileInfoMessage(Locale locale,
                                         String readString,
                                         Number convertedNumber)
```
    Gets the text of message readNumberIllegalFileInfo.
    Ein ungültiges Leerzeichen in einem numerischen Feld wurde zu einer Null konvertiert. Gelesene Zeichenkette "{0}" wurde zur Zahl "{1,number}" konvertiert.
    An illegal space character in a numeric field has been converted to zero. Converted string "{0}" to number "{1,number}".
    Parameters:
    locale - The locale of the message instance to return.
    readString - format parameter.
    convertedNumber - format parameter.
    
    Returns:
    the text of message readNumberIllegalFileInfo.
  - getTaskMonitor
```
protected TaskMonitor getTaskMonitor()
```
    Gets the configured TaskMonitor implementation.
    
    Returns:
    The configured TaskMonitor implementation.
  - getTextschluesselVerzeichnis
```
protected TextschluesselVerzeichnis getTextschluesselVerzeichnis()
```
    Gets the configured TextschluesselVerzeichnis implementation.
    
    Returns:
    The configured TextschluesselVerzeichnis implementation.
  - getTransaction
```
public Transaction getTransaction(int index)
                           throws IOException
```
    Specified by:
    
    getTransaction in interface LogicalFile
    
    Throws:
    
    IOException
  - getTransactionValidator
```
protected TransactionValidator[] getTransactionValidator()
```
    Gets the configured TransactionValidator implementation.
    
    Returns:
    The configured TransactionValidator implementation.
  - insertBytes
```
protected void insertBytes(long position,
               long bytes)
                    throws IOException
```
    Inserts a given number of bytes at a given position.
    
    Parameters:
    position - The position to insert bytes at.
    bytes - The number of bytes to insert.
    
    Throws:
    
    IOException - if inserting bytes fails.
  - readAlphaNumeric
```
protected AlphaNumericText27 readAlphaNumeric(int field,
                                  long position,
                                  int len,
                                  int encoding)
                                       throws IOException
```
    Hilds-Methode zum Lesen einer alpha-numerischen Zeichenkette.
    Sollten ungültige Daten gelesen werden, so wird null zurückgeliefert und eine entsprechende IllegalDataMessage erzeugt.
    
    Parameters:
    field - Feld-Konstante des zu lesenden Feldes.
    position - Position ab der die Zeichen gelesen werden sollen.
    len - Anzahl von Zeichen, die gelesen werden sollen.
    encoding - Zu verwendende Kodierung.
    
    Returns:
    gelesene Zeichenkette oder null wenn ungültige Zeichen gelesen werden.
    
    Throws:
    
    CorruptedException - wenn die Datei Fehler enthält und ThreadLocalMessages.isErrorsEnabled() gleich true ist.
    
    IOException - wenn nicht gelesen werden kann.
    See Also:
    ENCODING_ASCII, ENCODING_EBCDI, Fields, ThreadLocalMessages
  - readChecksum
```
protected abstract Checksum readChecksum()
                                  throws IOException
```
    Liest den E Datensatz. Die entsprechenden Vor- und Nachbedingungen werden in getChecksum() geprüft.
    
    Returns:
    E Datensatz.
    
    Throws:
    
    IOException - wenn nicht gelesen werden kann.
    See Also:
    getChecksumPosition()
  - readHeader
```
protected abstract Header readHeader()
                              throws IOException
```
    Liest den A Datensatz. Die entsprechenden Vor- und Nachbedingungen werden in getHeader() geprüft.
    
    Returns:
    A Datensatz.
    
    Throws:
    
    IOException - wenn nicht gelesen werden kann.
    See Also:
    getHeaderPosition()
  - readLongDate
```
protected Date readLongDate(int field,
                long position,
                int encoding)
                     throws IOException
```
    Hilfs-Methode zum Lesen einer Datums-Angabe mit vierstelliger Jahres-Zahl.
    Sollten ungültige Daten gelesen werden, so wird null zurückgeliefert und eine entsprechende IllegalDataMessage erzeugt.
    
    Parameters:
    field - Feld-Konstante des zu lesenden Feldes.
    position - Position ab der die Zeichen gelesen werden sollen.
    encoding - Zu verwendende Kodierung.
    
    Returns:
    gelesenes Datum oder null wenn nicht gelesen werden kann.
    
    Throws:
    
    IOException - wenn nicht gelesen werden kann.
    See Also:
    ENCODING_ASCII, ENCODING_EBCDI, Fields, ThreadLocalMessages
  - readNumber
```
protected Long readNumber(int field,
              long position,
              int len,
              int encoding)
                   throws IOException
```
    Hilfs-Methode zum Lesen von Zahlen.
    Sollten ungültige Daten gelesen werden, so wird NO_NUMBER zurückgeliefert und eine entsprechende IllegalDataMessage erzeugt.
    
    Parameters:
    field - Feld-Konstante des zu lesenden Feldes.
    position - Position ab der Ziffern gelesen werden sollen.
    len - Anzahl von Ziffern, die gelesen werden sollen.
    encoding - zu verwendende Kodierung.
    
    Returns:
    gelesene Zahl oder NO_NUMBER wenn gelesene Daten nicht als Zahl interpretiert werden konnten.
    
    Throws:
    
    CorruptedException - wenn die Datei Fehler enthält und ThreadLocalMessages.isErrorsEnabled() gleich true ist.
    
    IOException - wenn nicht gelesen werden kann.
    See Also:
    ENCODING_ASCII, ENCODING_EBCDI, NO_NUMBER, Fields, ThreadLocalMessages.isErrorsEnabled()
  - readNumber
```
protected Long readNumber(int field,
              long position,
              int len,
              int encoding,
              boolean allowSpaces)
                   throws IOException
```
    Hilfs-Methode zum Lesen von Zahlen mit gegebenenfalls Konvertierung von Leerzeichen zu Nullen.
    Die Verwendung dieser Methode mit allowSpaces == true entspricht einem Verstoß gegen die Spezifikation. Diese Methode existiert ausschließlich um ungültige Dateien lesen zu können und sollte nur in diesen Fällen verwendet werden.
    
    Sollten ungültige Daten gelesen werden, so wird NO_NUMBER zurückgeliefert und eine entsprechende IllegalDataMessage erzeugt.
    
    Parameters:
    field - Feld-Konstante des zu lesenden Feldes.
    position - Position aber der die Ziffern gelesen werden sollen.
    len - Anzahl von Ziffern, die gelesen werden sollen.
    encoding - Zu verwendende Kodierung.
    allowSpaces - true wenn vorhandene Leerzeichen durch Nullen ersetzt werden sollen; false für eine strikte Einhaltung der Spezifikation.
    
    Returns:
    gelesene Zahl oder NO_NUMBER wenn gelesene Daten nicht als Zahl interpretiert werden konnten.
    
    Throws:
    
    CorruptedException - wenn die Datei Fehler enthält und ThreadLocalMessages.isErrorsEnabled() gleich true ist.
    
    IOException - wenn nicht gelesen werden kann.
    See Also:
    ENCODING_ASCII, ENCODING_EBCDI, NO_NUMBER, Fields, ThreadLocalMessages
  - readNumberBinary
```
protected long readNumberBinary(int field,
                    long position,
                    int len)
                         throws IOException
```
    Hilfs-Methode zum Lesen von binär gespeicherten Zahlen.
    
    Parameters:
    field - Feld-Konstante des zu lesenden Feldes.
    position - Position ab der die Daten gelesen werden sollen.
    len - Anzahl von Byte, die gelesen werden sollen.
    
    Returns:
    gelesene Zahl.
    
    Throws:
    
    IllegalArgumentException - wenn len negativ, 0 oder größer als 8 ist.
    
    IOException - wenn nicht gelesen werden kann.
    See Also:
    Fields
  - readNumberPackedPositive
```
protected long readNumberPackedPositive(int field,
                            long position,
                            int len,
                            boolean sign)
                                 throws IOException
```
    Hilfs-Methode zum Lesen von gepackten EBCDI Zahlen.
    Sollten ungültige Daten gelesen werden, so wird NO_NUMBER zurückgeliefert und eine entsprechende IllegalDataMessage erzeugt.
    
    Parameters:
    field - Feld-Konstante des zu lesenden Feldes.
    position - Position ab der die Daten gelesen werden sollen.
    len - Anzahl von Byte, die gelesen werden sollen.
    sign - true wenn ein Vorzeichen erwartet wird; false wenn kein Vorzeichen erwartet wird.
    
    Returns:
    gelesene Zahl oder NO_NUMBER wenn gelesene Daten nicht als Zahl interpretiert werden konnten.
    
    Throws:
    
    CorruptedException - wenn die Datei Fehler enthält und ThreadLocalMessages.isErrorsEnabled() gleich true ist.
    
    IOException - wenn nicht gelesen werden kann.
    See Also:
    Fields, ThreadLocalMessages.isErrorsEnabled(), NO_NUMBER
  - readShortDate
```
protected Date readShortDate(int field,
                 long position,
                 int encoding)
                      throws IOException
```
    Hilfs-Methode zum Lesen einer Datums-Angabe mit zweistelliger Jahres-Zahl.
    Zweistellige Jahres-Angaben kleiner oder gleich 79 werden als 2000 + zweistelliges Jahr interpretiert. Zweistellige Jahres-Angaben größer oder gleich 80 werden als 1900 + zweistelliges Jahr interpretiert.
    
    Sollten ungültige Daten gelesen werden, so wird null zurückgeliefert und eine entsprechende IllegalDataMessage erzeugt.
    
    Parameters:
    field - Feld-Konstante des zu lesenden Feldes.
    position - Position ab der die Zeichen gelesen werden sollen.
    encoding - Zu verwendende Kodierung.
    
    Returns:
    das gelesene Datum oder null wenn kein Datum gelesen werden kann.
    
    Throws:
    
    CorruptedException - wenn die Datei Fehler enthält und ThreadLocalMessages.isErrorsEnabled() gleich true ist.
    
    IOException - wenn nicht gelesen werden kann.
    See Also:
    ENCODING_ASCII, ENCODING_EBCDI, Fields, ThreadLocalMessages
  - readTransaction
```
protected abstract Transaction readTransaction(long position,
                          Transaction transaction)
                                        throws IOException
```
    Liest einen C Datensatz. Die entsprechenden Vor- und Nachbedingungen werden in getTransaction(int) geprüft.
    
    Parameters:
    position - Position des C Datensatzes.
    transaction - Instanz, die die gelesenen Daten aufnehmen soll.
    
    Returns:
    an position beginnender C Datensatz.
    
    Throws:
    
    IOException - wenn nicht gelesen werden kann.
  - removeBytes
```
protected void removeBytes(long position,
               long bytes)
                    throws IOException
```
    Removes a given number of bytes at a given position.
    
    Parameters:
    position - The position to remove bytes at.
    bytes - The number of bytes to remove.
    
    Throws:
    
    IOException - if removing bytes fails.
  - removeFileOperationsListener
```
public void removeFileOperationsListener(AbstractLogicalFile.Listener listener)
```
    Removes a Listener from the listener list.
    
    Parameters:
    listener - The listener to be removed from the listener list.
    
    Throws:
    
    NullPointerException - if listener is null.
  - removeTransaction
```
public Transaction removeTransaction(int index)
                              throws IOException
```
    Specified by:
    
    removeTransaction in interface LogicalFile
    
    Throws:
    
    IOException
  - resizeIndex
```
protected void resizeIndex(int index,
               Checksum checksum)
```
    Hilfsmethode zum dynamischen Vergrössern des Index.
    
    Parameters:
    index - laufende Transaktionsnummer, für die der Index angepasst werden soll.
    checksum - aktuelle Prüfsumme zur Initialisierung des Index.
  - setChecksum
```
protected void setChecksum(Checksum checksum)
                    throws IOException
```
    Throws:
    
    IOException
  - setChecksumPosition
```
protected void setChecksumPosition(long checksumPosition)
                            throws IOException
```
    Schreibt den Wert der Property checksumPosition.
    
    Parameters:
    checksumPosition - Position des E-Datensatzes.
    
    Throws:
    
    IllegalArgumentException - wenn checksumPosition negativ ist.
    
    IOException - wenn die aktuelle Anzahl Byte nicht ermittelt werden kann.
  - setConfiguration
```
protected void setConfiguration(Configuration configuration)
```
    Sets the value of property configuration.
    
    Parameters:
    configuration - Implementation configuration.
  - setFileOperations
```
protected void setFileOperations(FileOperations fileOperations)
                          throws IOException
```
    Ändert die zu Grunde liegende FileOperations Implementierung.
    
    Parameters:
    fileOperations - neue FileOperations Implementierung.
    
    Throws:
    
    NullPointerException - wenn fileOperations null ist.
    
    IOException - wenn zwischengespeicherte Änderungen der vorherigen Instanz nicht geschrieben werden können.
  - setHeader
```
public Header setHeader(Header header)
                 throws IOException
```
    Specified by:
    
    setHeader in interface LogicalFile
    
    Throws:
    
    IOException
  - setHeaderPosition
```
protected void setHeaderPosition(long headerPosition)
                          throws IOException
```
    Schreibt den Wert der Property headerPosition.
    
    Parameters:
    headerPosition - Position des A Datensatzes.
    
    Throws:
    
    IllegalArgumentException - wenn headerPosition negativ ist.
    
    IOException - wenn die aktuelle Anzahl Bytes nicht ermittelt werden kann.
  - setMaximumExtensionCount
```
public void setMaximumExtensionCount(Long value)
```
    Sets the maximum allowed number of extensions.
    
    Parameters:
    value - The new maximum allowed number of extensions or null.
    Since:
    
    1.12
  - setMonitoringThreshold
```
public void setMonitoringThreshold(int value)
```
    Sets the value of property monitoringThreshold.
    
    Parameters:
    value - The mininum number of bytes to copy to start any task monitoring.
  - setTransaction
```
public Transaction setTransaction(int index,
                         Transaction transaction)
                           throws IOException
```
    Specified by:
    
    setTransaction in interface LogicalFile
    
    Throws:
    
    IOException
  - writeAlphaNumeric
```
protected void writeAlphaNumeric(int field,
                     long position,
                     int len,
                     String str,
                     int encoding)
                          throws IOException
```
    Hilfs-Methode zum Schreiben einer Zeichenkette.
    
    Parameters:
    field - Feld-Konstante des zu beschreibenden Feldes.
    position - Position ab der die Zeichen geschrieben werden sollen.
    len - Anzahl von Zeichen die maximal geschrieben werden sollen. Sollte str kürzer als len sein, wird linksseitig mit Leerzeichen aufgefüllt.
    str - Die zu schreibende Zeichenkette.
    encoding - Zu verwendende Kodierung.
    
    Throws:
    
    NullPointerException - wenn str null ist.
    
    IllegalArgumentException - wenn str länger als len Zeichen lang ist oder ungültige Zeichen enthält.
    
    IOException - wenn nicht geschrieben werden kann.
    See Also:
    ENCODING_ASCII, ENCODING_EBCDI, Fields
  - writeChecksum
```
protected abstract void writeChecksum(Checksum checksum)
                               throws IOException
```
    Schreibt den E Datensatz. Die entsprechenden Vor- und Nachbedingungen werden in setChecksum(Checksum) geprüft.
    
    Parameters:
    checksum - E Datensatz.
    
    Throws:
    
    IOException - wenn nicht geschrieben werden kann.
    See Also:
    getChecksumPosition()
  - writeHeader
```
protected abstract void writeHeader(Header header)
                             throws IOException
```
    Schreibt den A Datensatz. Die entsprechenden Vor- und Nachbedingungen werden in setHeader(Header) geprüft.
    
    Parameters:
    header - A Datensatz.
    
    Throws:
    
    IOException - wenn nicht geschrieben werden kann.
    See Also:
    getHeaderPosition()
  - writeLongDate
```
protected void writeLongDate(int field,
                 long position,
                 Date date,
                 int encoding)
                      throws IOException
```
    Hilfs-Methode zum Schreiben einer Datums-Angabe mit vierstelliger Jahres-Zahl.
    
    Parameters:
    field - Feld-Konstante des zu beschreibenden Feldes.
    position - Position ab der die Zeichen geschrieben werden sollen.
    date - Die zu schreibende Datums-Angabe oder null um eine optionale Datums-Angabe zu entfernen.
    encoding - Zu verwendende Kodierung.
    
    Throws:
    
    IllegalArgumentException - wenn das Jahr von date nicht größer oder gleich 1980 und kleiner oder gleich 2079 ist.
    
    IOException - wenn nicht geschrieben werden kann.
    See Also:
    ENCODING_ASCII, ENCODING_EBCDI, Fields, ThreadLocalMessages
  - writeNumber
```
protected void writeNumber(int field,
               long position,
               int len,
               long number,
               int encoding)
                    throws IOException
```
    Hilfs-Methode zum Schreiben von Zahlen.
    
    Parameters:
    field - Feld-Konstante des zu beschreibenden Feldes.
    position - Position ab der die Daten geschrieben werden sollen.
    len - Anzahl an Ziffern die geschrieben werden sollen. Hierbei wird linksseitig mit Nullen aufgefüllt, so dass exakt len Ziffern geschrieben werden.
    number - Die zu schreibende Zahl.
    encoding - Zu verwendende Kodierung.
    
    Throws:
    
    IllegalArgumentException - wenn number nicht mit len Ziffern darstellbar ist.
    
    IOException - wenn nicht geschrieben werden kann.
    See Also:
    ENCODING_ASCII, ENCODING_EBCDI, Fields
  - writeNumberBinary
```
protected void writeNumberBinary(int field,
                     long position,
                     int len,
                     long number)
                          throws IOException
```
    Hilfs-Methode zum Schreiben von binär gespeicherten Zahlen.
    
    Parameters:
    field - Feld-Konstante des zu beschreibenden Feldes.
    position - Position ab der die Daten geschrieben werden sollen.
    len - Anzahl an Byte die geschrieben werden sollen.
    number - Die zu schreibende Zahl.
    
    Throws:
    
    IllegalArgumentException - wenn len negativ, 0 oder größer als 8 ist.
    
    IOException - wenn nicht geschrieben werden kann.
    See Also:
    Fields
  - writeNumberPackedPositive
```
protected void writeNumberPackedPositive(int field,
                             long position,
                             int len,
                             long number,
                             boolean sign)
                                  throws IOException
```
    Hilfs-Methode zum Schreiben von gepackten EBCDI-Zahlen.
    
    Parameters:
    field - Feld-Konstante des zu beschreibenden Feldes.
    position - Position ab der die Daten geschrieben werden sollen.
    len - Anzahl an Byte die geschrieben werden sollen. Hierbei wird linksseitig mit Nullen aufgefüllt, so dass exakt len Ziffern geschrieben werden.
    number - Die zu schreibende Zahl.
    sign - true wenn ein Vorzeichen geschrieben werden soll; false wenn kein Vorzeichen geschrieben werden soll.
    
    Throws:
    
    IllegalArgumentException - wenn number nicht mit len Byte darstellbar ist.
    
    IOException - wenn nicht geschrieben werden kann.
    See Also:
    Fields
  - writeShortDate
```
protected void writeShortDate(int field,
                  long position,
                  Date date,
                  int encoding)
                       throws IOException
```
    Hilfs-Methode zum Schreiben einer Datums-Angabe mit zweistelliger Jahres-Zahl.
    Es werden nur Daten mit Jahren größer oder gleich 1980 und kleiner oder gleich 2079 akzeptiert.
    
    Parameters:
    field - Feld-Konstante des zu beschreibenden Feldes.
    position - Position ab der die Zeichen geschrieben werden sollen.
    date - Die zu schreibende Datums-Angabe oder null um eine optionale Datums-Angabe zu entfernen.
    encoding - Zu verwendende Kodierung.
    
    Throws:
    
    IllegalArgumentException - wenn das Jahr von date nicht größer oder gleich 1980 und kleiner oder gleich 2079 ist.
    
    IOException - wenn nicht geschrieben werden kann.
    See Also:
    ENCODING_ASCII, ENCODING_EBCDI, Fields
  - writeTransaction
```
protected abstract void writeTransaction(long position,
                    Transaction transaction)
                                  throws IOException
```
    Schreibt einen C Datensatz. Die entsprechenden Vor- und Nachbedingungen werden in setTransaction(int, Transaction) geprüft.
    
    Parameters:
    position - Position des C Datensatzes.
    transaction - Daten des C Datensatzes.
    
    Throws:
    
    IOException - wenn nicht geschrieben werden kann.

Class AbstractLogicalFile

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ENCODING_ASCII

ENCODING_EBCDI

EXP10

MAX_SCHEDULEDAYS

NO_NUMBER

Constructor Detail

AbstractLogicalFile

Method Detail

addListener

addTransaction

byteCount

checkDate

checksum

checkTransactionCount

checkTransactionId

createTransaction

fireBytesDeleted

fireBytesInserted

getApplicationLogger

getBlockSize

getBlockType

getChecksum

getChecksumPosition

getConfiguration

getCurrencyMapper

getDefaultBufferSize

getDefaultMaximumExtensionCount

getDefaultMonitoringThreshold

getFileOperations

getHeader

getHeaderPosition

getHeaderValidator

getImplementation

getListeners

getLocale

getLogger

getMaximumExtensionCount

getMemoryManager

getMonitoringThreshold

getReadNumberIllegalFileInfoMessage

getTaskMonitor

getTextschluesselVerzeichnis

getTransaction

getTransactionValidator

insertBytes

readAlphaNumeric

readChecksum

readHeader

readLongDate

readNumber

readNumber

readNumberBinary

readNumberPackedPositive

readShortDate

readTransaction

removeBytes

removeFileOperationsListener

removeTransaction

resizeIndex

setChecksum

setChecksumPosition

setConfiguration

setFileOperations

setHeader

setHeaderPosition

setMaximumExtensionCount

setMonitoringThreshold

setTransaction

writeAlphaNumeric

writeChecksum

writeHeader

writeLongDate

writeNumber