org.jdtaus.banking.dtaus

Interface PhysicalFileFactory

public interface PhysicalFileFactory

Factory for PhysicalFile instances.

Example: Getting the jDTAUS Banking SPI implementation.

 PhysicalFileFactory factory =
     (PhysicalFileFactory) ContainerFactory.getContainer().
     getObject( PhysicalFileFactory.class );
 

Version:

$JDTAUS: PhysicalFileFactory.java 8661 2012-09-27 11:29:58Z schulte $

Author:

Christian Schulte

See Also:

Container

Field Summary

Fields

Modifier and Type	Field and Description
static int	FORMAT_DISK Constant for the DTAUS disk format.
static int	FORMAT_TAPE Constant for the DTAUS tape format.

Method Summary

Methods

Modifier and Type	Method and Description
int	analyse(File file) Detects the format by analysing the given File.
int	analyse(FileOperations ops) Detects the format by analysing the given FileOperations.
PhysicalFile	createPhysicalFile(File file, int format) Creates a new PhysicalFile on a given File.
PhysicalFile	createPhysicalFile(File file, int format, Properties properties) Creates a new PhysicalFile on a given File taking properties to configure the implementation.
PhysicalFile	createPhysicalFile(FileOperations ops, int format) Creates a new PhysicalFile on given FileOperations.
PhysicalFile	createPhysicalFile(FileOperations ops, int format, Properties properties) Creates a new PhysicalFile on given FileOperations taking properties to configure the implementation.
PhysicalFile	getPhysicalFile(File file) Reads a PhysicalFile from a given File.
PhysicalFile	getPhysicalFile(FileOperations ops) Reads a PhysicalFile from given FileOperations.
PhysicalFile	getPhysicalFile(FileOperations ops, Properties properties) Reads a PhysicalFile from given FileOperations taking properties to configure the implementation.
PhysicalFile	getPhysicalFile(File file, Properties properties) Reads a PhysicalFile from a given File taking properties to configure the implementation.

Field Detail

FORMAT_DISK

static final int FORMAT_DISK

Constant for the DTAUS disk format.

See Also:

Constant Field Values

FORMAT_TAPE

static final int FORMAT_TAPE

Constant for the DTAUS tape format.

See Also:

Constant Field Values

Method Detail

analyse

int analyse(File file)
            throws PhysicalFileException,
                   IOException

Detects the format by analysing the given File.

Parameters:

file - The file to analyse.

Returns:

Constant for the detected format.

Throws:

NullPointerException - if file is null.

PhysicalFileException - if file provides a file containing errors.

IOException - if reading fails.

See Also:

FORMAT_DISK, FORMAT_TAPE, PhysicalFile.commit()

analyse

int analyse(FileOperations ops)
            throws PhysicalFileException,
                   IOException

Detects the format by analysing the given FileOperations.

Parameters:

ops - FileOperations to analyse.

Returns:

Constant for the detected format.

Throws:

NullPointerException - if ops is null.

PhysicalFileException - if ops provides a file containing errors.

IOException - if reading fails.

See Also:

FORMAT_DISK, FORMAT_TAPE, PhysicalFile.commit()

createPhysicalFile

PhysicalFile createPhysicalFile(File file,
                              int format)
                                throws IOException

Creates a new PhysicalFile on a given File.

Parameters:

file - The file to create a new DTAUS file with.

format - Constant for the format of the new DTAUS file.

Returns:

An empty DTAUS file.

Throws:

NullPointerException - if file is null.

IllegalArgumentException - if format is neither FORMAT_DISK nor FORMAT_TAPE.

IOException - if creating a new DTAUS file fails.

See Also:

FORMAT_DISK, FORMAT_TAPE, PhysicalFile.commit()

createPhysicalFile

PhysicalFile createPhysicalFile(File file,
                              int format,
                              Properties properties)
                                throws IOException

Creates a new PhysicalFile on a given File taking properties to configure the implementation.

Parameters:

file - The file to create a new DTAUS file with.

format - Constant for the format of the new DTAUS file.

properties - Properties to be passed to implementations.

Returns:

An empty DTAUS file.

Throws:

NullPointerException - if either file or properties is null.

IllegalArgumentException - if format is neither FORMAT_DISK nor FORMAT_TAPE.

IOException - if creating a new DTAUS file fails.

See Also:

FORMAT_DISK, FORMAT_TAPE, PhysicalFile.commit()

createPhysicalFile

PhysicalFile createPhysicalFile(FileOperations ops,
                              int format)
                                throws IOException

Creates a new PhysicalFile on given FileOperations.

Parameters:

ops - The FileOperations to create a new DTAUS file with.

format - Constant for the format of the new DTAUS file.

Returns:

An empty DTAUS file.

Throws:

NullPointerException - if ops is null.

IllegalArgumentException - if format is neither FORMAT_DISK nor FORMAT_TAPE.

IOException - if creating a new DTAUS file fails.

See Also:

FORMAT_DISK, FORMAT_TAPE, PhysicalFile.commit()

createPhysicalFile

PhysicalFile createPhysicalFile(FileOperations ops,
                              int format,
                              Properties properties)
                                throws IOException

Creates a new PhysicalFile on given FileOperations taking properties to configure the implementation.

Parameters:

ops - The FileOperations to create a new DTAUS file with.

format - Constant for the format of the new DTAUS file.

properties - Properties to be passed to implementations.

Returns:

An empty DTAUS file.

Throws:

NullPointerException - if either ops or properties is null.

IllegalArgumentException - if format is neither FORMAT_DISK nor FORMAT_TAPE.

IOException - if creating a new DTAUS file fails.

See Also:

FORMAT_DISK, FORMAT_TAPE, PhysicalFile.commit()

getPhysicalFile

PhysicalFile getPhysicalFile(File file)
                             throws PhysicalFileException,
                                    IOException

Reads a PhysicalFile from a given File.

Parameters:

file - The file to create a PhysicalFile instance from.

Returns:

New PhysicalFile instance for file.

Throws:

NullPointerException - if file is null.

PhysicalFileException - if file provides a file containing errors.

IOException - if reading fails.

See Also:

PhysicalFile.commit()

getPhysicalFile

PhysicalFile getPhysicalFile(FileOperations ops)
                             throws PhysicalFileException,
                                    IOException

Reads a PhysicalFile from given FileOperations.

Parameters:

ops - FileOperations to create a PhysicalFile instance from.

Returns:

New PhysicalFile instance for ops.

Throws:

NullPointerException - if ops is null.

PhysicalFileException - if ops provides a file containing errors.

IOException - if reading fails.

See Also:

PhysicalFile.commit()

getPhysicalFile

PhysicalFile getPhysicalFile(FileOperations ops,
                           Properties properties)
                             throws PhysicalFileException,
                                    IOException

Reads a PhysicalFile from given FileOperations taking properties to configure the implementation.

Parameters:

ops - FileOperations to create a PhysicalFile instance from.

properties - properties to be passed to implementations.

Returns:

new PhysicalFile instance for ops.

Throws:

NullPointerException - if either ops or properties is null.

PhysicalFileException - if ops provides a file containing errors.

IOException - if reading fails.

See Also:

PhysicalFile.commit()

getPhysicalFile

PhysicalFile getPhysicalFile(File file,
                           Properties properties)
                             throws PhysicalFileException,
                                    IOException

Reads a PhysicalFile from a given File taking properties to configure the implementation.

Parameters:

file - The file to create a PhysicalFile instance from.

properties - Properties to be passed to implementations.

Returns:

New PhysicalFile instance for file.

Throws:

NullPointerException - if either file or properties is null.

PhysicalFileException - if file provides a file containing errors.

IOException - if reading fails.

See Also:

PhysicalFile.commit()