Package cdc.util.data.util

Class AbstractResourceLoader<R>

java.lang.Object

cdc.util.data.util.AbstractResourceLoader<R>

Type Parameters:

R - The return type.

public abstract class AbstractResourceLoader<R>
extends java.lang.Object

Helper class dedicated to data loading.

Author:

Damien Carbonne

Constructor Summary

Constructors

Constructor	Description
AbstractResourceLoader(cdc.util.lang.FailureReaction reaction)	Creates a Loader with reaction to adopt in case of error.

Method Summary

Modifier and Type	Method	Description
org.apache.logging.log4j.Logger	getLogger()
cdc.util.events.ProgressSupplier	getProgressSupplier()
cdc.util.lang.FailureReaction	getReaction()
protected abstract R	loadRoot(Element root)	Method that must be implemented by concrete classes to load the file.
R	loadXml(java.io.File file, cdc.util.compress.Compressor compressor, XmlDataReader.Feature... features)	Loads an XML file, possibly compressed.
R	loadXml(java.io.File file, XmlDataReader.Feature... features)	Loads an uncompressed XML file.
R	loadXml(java.io.InputStream is, java.lang.String systemId, cdc.util.compress.Compressor compressor, XmlDataReader.Feature... features)	Loads an XML input stream, possibly compressed.
R	loadXml(java.io.InputStream is, java.lang.String systemId, XmlDataReader.Feature... features)	Loads an uncompressed XML input stream.
R	loadXml(java.lang.String filename, cdc.util.compress.Compressor compressor, XmlDataReader.Feature... features)	Loads an XML file, possibly compressed.
R	loadXml(java.lang.String filename, XmlDataReader.Feature... features)	Loads an uncompressed XML file.
R	loadXml(java.net.URL url, cdc.util.compress.Compressor compressor, XmlDataReader.Feature... features)	Loads an XML URL, possibly compressed.
R	loadXml(java.net.URL url, XmlDataReader.Feature... features)	Loads an uncompressed XML URL.
void	loadXml(java.util.List<java.net.URL> urls, cdc.util.compress.Compressor compressor, XmlDataReader.Feature... features)	Loads a list of XML URLs, possibly compressed.
void	loadXml(java.util.List<java.net.URL> urls, XmlDataReader.Feature... features)	Loads a list of uncompressed XML URLs.
protected void	onError(java.lang.String message)	Function that either keeps silent, warns or raises an exception, depending on error reaction.
protected <T> T	onError(java.lang.String message, T def)	Function that either silently returns a value, warns and returns a value or raises an exception, depending on error reaction.
protected <T> T	onResult(T result, java.lang.String message, T def)	Function that returns a computed value if it is not null, or silently returns a default value, warns and returns a default value or throws an exception.
void	setProgressController(cdc.util.events.ProgressController controller)	Associates a progress controller to this loader.
protected void	unexpectedElement(Element element, java.lang.String... expected)
protected <V> V	unexpectedElement(Element element, V def, java.lang.String... expected)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractResourceLoader

public AbstractResourceLoader(cdc.util.lang.FailureReaction reaction)

Creates a Loader with reaction to adopt in case of error.

A logger named from the class is created.

Parameters:

reaction - The reaction to adopt in case of error.

Method Detail

getLogger

public final org.apache.logging.log4j.Logger getLogger()

Returns:

The logger to use.

getReaction

public final cdc.util.lang.FailureReaction getReaction()

Returns:

The reaction to adopt in case of error.

setProgressController

public void setProgressController(cdc.util.events.ProgressController controller)

Associates a progress controller to this loader.

Parameters:

controller - The progress controller.

getProgressSupplier

public cdc.util.events.ProgressSupplier getProgressSupplier()

Returns:

The progress supplier, that can be used to generated progress events.

loadXml

public final R loadXml(java.io.File file,
                       cdc.util.compress.Compressor compressor,
                       XmlDataReader.Feature... features)
                throws java.io.IOException

Loads an XML file, possibly compressed.

Parameters:

file - The file.

compressor - The compressor to use (if the file is compressed).

features - The enabled XMLDataReader features.

Returns:

The result.

Throws:

java.io.IOException - When an IO exception occurs.

loadXml

public final R loadXml(java.io.File file,
                       XmlDataReader.Feature... features)
                throws java.io.IOException

Loads an uncompressed XML file.

Parameters:

file - The file.

features - The enabled XMLDataReader features.

Returns:

The result.

Throws:

java.io.IOException - When an IO exception occurs.

loadXml

public final R loadXml(java.lang.String filename,
                       cdc.util.compress.Compressor compressor,
                       XmlDataReader.Feature... features)
                throws java.io.IOException

Loads an XML file, possibly compressed.

Parameters:

filename - The file name.

compressor - The compressor to use (if the file is compressed).

features - The enabled XMLDataReader features.

Returns:

The result.

Throws:

java.io.IOException - When an IO exception occurs.

loadXml

public final R loadXml(java.lang.String filename,
                       XmlDataReader.Feature... features)
                throws java.io.IOException

Loads an uncompressed XML file.

Parameters:

filename - The file name.

features - The enabled XMLDataReader features.

Returns:

The result.

Throws:

java.io.IOException - When an IO exception occurs.

loadXml

public final R loadXml(java.net.URL url,
                       cdc.util.compress.Compressor compressor,
                       XmlDataReader.Feature... features)
                throws java.io.IOException

Loads an XML URL, possibly compressed.

Parameters:

url - The URL.

compressor - The compressor to use (if the file is compressed).

features - The enabled XMLDataReader features.

Returns:

The result.

Throws:

java.io.IOException - When an IO exception occurs.

loadXml

public final R loadXml(java.net.URL url,
                       XmlDataReader.Feature... features)
                throws java.io.IOException

Loads an uncompressed XML URL.

Parameters:

url - The URL.

features - The enabled XMLDataReader features.

Returns:

The result.

Throws:

java.io.IOException - When an IO exception occurs.

loadXml

public final void loadXml(java.util.List<java.net.URL> urls,
                          cdc.util.compress.Compressor compressor,
                          XmlDataReader.Feature... features)

Loads a list of XML URLs, possibly compressed.

Parameters:

urls - The list of URLs.

compressor - The compressor to use (if the URLs are compressed).

features - The enabled XMLDataReader features.

loadXml

public final void loadXml(java.util.List<java.net.URL> urls,
                          XmlDataReader.Feature... features)

Loads a list of uncompressed XML URLs.

Parameters:

urls - The list of URLs.

features - The enabled XMLDataReader features.

loadXml

public final R loadXml(java.io.InputStream is,
                       java.lang.String systemId,
                       cdc.util.compress.Compressor compressor,
                       XmlDataReader.Feature... features)
                throws java.io.IOException

Loads an XML input stream, possibly compressed.

Parameters:

is - The input stream.

systemId - The system id.

compressor - The compressor to use (if the input stream is compressed).

features - The enabled XMLDataReader features.

Returns:

The result.

Throws:

java.io.IOException - When an IO exception occurs.

loadXml

public final R loadXml(java.io.InputStream is,
                       java.lang.String systemId,
                       XmlDataReader.Feature... features)
                throws java.io.IOException

Loads an uncompressed XML input stream.

Parameters:

is - The input stream.

systemId - The system id.

features - The enabled XMLDataReader features.

Returns:

The result.

Throws:

java.io.IOException - When an IO exception occurs.

loadRoot

protected abstract R loadRoot(Element root)
                       throws java.io.IOException

Method that must be implemented by concrete classes to load the file.

Parameters:

root - The root element.

Returns:

The result.

Throws:

java.io.IOException - When an IO exception occurs.

onError

protected final void onError(java.lang.String message)

Function that either keeps silent, warns or raises an exception, depending on error reaction.

Parameters:

message - The error message.

Throws:

DataException - When error reaction is FailureReaction.FAIL.

onError

protected final <T> T onError(java.lang.String message,
                              T def)

Function that either silently returns a value, warns and returns a value or raises an exception, depending on error reaction.

Type Parameters:

T - The return type.

Parameters:

message - The error message.

def - The default return value.

Returns:

def if error reaction is FailureReaction.DEFAULT or FailureReaction.WARN.

Throws:

DataException - When error reaction is FailureReaction.FAIL.

onResult

protected final <T> T onResult(T result,
                               java.lang.String message,
                               T def)

Function that returns a computed value if it is not null, or silently returns a default value, warns and returns a default value or throws an exception.

Type Parameters:

T - The return type.

Parameters:

result - The computed result.

message - The error message.

def - The default return value.

Returns:

result if it is not null, or def if error reaction is FailureReaction.DEFAULT or FailureReaction.WARN.

Throws:

DataException - When result is null and error reaction is FailureReaction.FAIL.

unexpectedElement

protected final void unexpectedElement(Element element,
                                       java.lang.String... expected)

unexpectedElement

protected final <V> V unexpectedElement(Element element,
                                        V def,
                                        java.lang.String... expected)