Package org.daisy.braille.utils.pef

Class PEFFileSplitter

java.lang.Object

org.daisy.braille.utils.pef.PEFFileSplitter

All Implemented Interfaces:

ErrorHandler

public class PEFFileSplitter
extends Object
implements ErrorHandler

Splits a PEF-file into several single volume files. The main purpose is to interact with software that operates on one volume at a time.

Field Summary

Fields

Modifier and Type	Field	Description
static String	POSTFIX	Defines the default postfix for generated file names.
static String	PREFIX	Defines the default prefix for generated file names.

Constructor Summary

Constructors

Constructor	Description
PEFFileSplitter(Predicate<URL> validator)	Creates a new PEFFileSplitter object.

Method Summary

Modifier and Type	Method	Description
void	error(SAXParseException exception)
void	fatalError(SAXParseException exception)
boolean	split(File input, File directory)	Splits a PEF-file into several single volume PEF-files.
boolean	split(InputStream is, File directory)	Splits the PEF-document provided as an input stream into several single volume PEF-files using the default file name pre- and postfix.
boolean	split(InputStream is, File directory, String prefix, String postfix)	Splits the PEF-document provided as an input stream into several single volume PEF-files using the supplied file name pre- and postfix.
void	warning(SAXParseException exception)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PREFIX

public static final String PREFIX

Defines the default prefix for generated file names.

See Also:

Constant Field Values

POSTFIX

public static final String POSTFIX

Defines the default postfix for generated file names.

See Also:

Constant Field Values

Constructor Detail

PEFFileSplitter

public PEFFileSplitter(Predicate<URL> validator)

Creates a new PEFFileSplitter object.

Parameters:

validator - a PEF validator. A full validation is strongly recommended.

Method Detail

split

public boolean split(File input,
                     File directory)

Splits a PEF-file into several single volume PEF-files.

Parameters:

input - input PEF-file

directory - output directory

Returns:

returns true if split was successful, false otherwise

Throws:

IllegalArgumentException - if input is not a file

split

public boolean split(InputStream is,
                     File directory)

Splits the PEF-document provided as an input stream into several single volume PEF-files using the default file name pre- and postfix.

Parameters:

is - the input stream to the PEF-document

directory - the output directory

Returns:

returns true if split was successful, false otherwise

split

public boolean split(InputStream is,
                     File directory,
                     String prefix,
                     String postfix)

Splits the PEF-document provided as an input stream into several single volume PEF-files using the supplied file name pre- and postfix.

Parameters:

is - the input stream to the PEF-document

directory - the output directory

prefix - the prefix to use

postfix - the postfix to use

Returns:

returns true if split was successful, false otherwise

error

public void error(SAXParseException exception)
           throws SAXException

Specified by:

error in interface ErrorHandler

Throws:

SAXException

fatalError

public void fatalError(SAXParseException exception)
                throws SAXException

Specified by:

fatalError in interface ErrorHandler

Throws:

SAXException

warning

public void warning(SAXParseException exception)
             throws SAXException

Specified by:

warning in interface ErrorHandler

Throws:

SAXException