de.gerdiproject.harvest.utils.data

Class DiskIO

java.lang.Object

de.gerdiproject.harvest.utils.data.DiskIO

All Implemented Interfaces:

IDataRetriever

public class DiskIO
extends Object
implements IDataRetriever

This class provides methods for reading files from disk.

Author:

Robin Weiss

Constructor Summary

Constructors

Constructor and Description
DiskIO(DiskIO other) Constructor that copies over settings from another DiskIO.
DiskIO(com.google.gson.Gson gson, Charset charset) Constructor that sets the GSON (de-)serializer for reading and writing JSON objects.

Method Summary

Modifier and Type	Method and Description
org.jsoup.nodes.Document	getHtml(String filePath) Tries to parse the content from a specified path as a HTML document.
<T> T	getObject(File file, Class<T> targetClass) Tries to parse the content of a specified file as an object.
<T> T	getObject(File file, Type targetType) Tries to parse the content of a specified file as an object.
<T> T	getObject(String filePath, Class<T> targetClass) Tries to parse the content from a specified path as a JSON object.
<T> T	getObject(String filePath, Type targetType) Tries to parse the content from a specified path as a JSON object.
String	getString(File file) Tries to parse the content of a specified file as a string.
String	getString(String filePath) Tries to parse the content from a specified path as a string.
void	setCharset(Charset charset) Changes the charset used for (de-)serializing requests.
String	writeObjectToFile(File file, Object obj) Attempts to transform an object to a JSON object and writes it to a file on disk.
String	writeObjectToFile(String filePath, Object obj) Attempts to transform an object to a JSON object and writes it to a file on disk.
String	writeStringToFile(File file, String fileContent) Writes a string to a file on disk.
String	writeStringToFile(String filePath, String fileContent) Writes a string to a file on disk.

Methods inherited from class java.lang.Object

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

Constructor Detail

DiskIO

public DiskIO(com.google.gson.Gson gson,
              Charset charset)

Constructor that sets the GSON (de-)serializer for reading and writing JSON objects.

Parameters:

gson - the GSON (de-)serializer for reading and writing JSON objects

charset - the charset of the files to be read and written

DiskIO

public DiskIO(DiskIO other)

Constructor that copies over settings from another DiskIO.

Parameters:

other - the DiskIO of which the settings are copied

Method Detail

writeStringToFile

public String writeStringToFile(String filePath,
                                String fileContent)

Writes a string to a file on disk.

Parameters:

filePath - the complete path to the file

fileContent - the string that is to be written to the file

Returns:

a String that describes the status of the operation

writeStringToFile

public String writeStringToFile(File file,
                                String fileContent)

Writes a string to a file on disk.

Parameters:

file - the file to which the String is written

fileContent - the string that is to be written to the file

Returns:

a String that describes the status of the operation

writeObjectToFile

public String writeObjectToFile(String filePath,
                                Object obj)

Attempts to transform an object to a JSON object and writes it to a file on disk.

Parameters:

filePath - the complete path to the file

obj - the object that is to be written to the file

Returns:

a String that describes the status of the operation

writeObjectToFile

public String writeObjectToFile(File file,
                                Object obj)

Attempts to transform an object to a JSON object and writes it to a file on disk.

Parameters:

file - the file to which the object should be written

obj - the object that is to be written to the file

Returns:

a String that describes the status of the operation

getString

public String getString(File file)

Tries to parse the content of a specified file as a string.

Parameters:

file - the file that is to be parsed

Returns:

a string, or null if the file could not be parsed

getObject

public <T> T getObject(File file,
                       Class<T> targetClass)

Tries to parse the content of a specified file as an object.

Type Parameters:

T - the type of the object that is to be read

Parameters:

file - a JSON file representing the object

targetClass - the class of the object that is read

Returns:

an object, or null if the file could not be parsed

getObject

public <T> T getObject(File file,
                       Type targetType)

Tries to parse the content of a specified file as an object.

Type Parameters:

T - the type of the object that is to be read

Parameters:

file - a JSON file representing the object

targetType - the type of the object that is read

Returns:

an object, or null if the file could not be parsed

getString

public String getString(String filePath)

Description copied from interface: IDataRetriever

Tries to parse the content from a specified path as a string.

Specified by:

getString in interface IDataRetriever

Parameters:

filePath - the path to a HTML file

Returns:

a text, or null if the file could not be parsed

getObject

public <T> T getObject(String filePath,
                       Class<T> targetClass)

Description copied from interface: IDataRetriever

Tries to parse the content from a specified path as a JSON object.

Specified by:

getObject in interface IDataRetriever

Type Parameters:

T - the type of the object that is to be read

Parameters:

filePath - the path to a JSON file

targetClass - the class of the object that is read from disc

Returns:

an object, or null if the file could not be parsed

getObject

public <T> T getObject(String filePath,
                       Type targetType)

Description copied from interface: IDataRetriever

Tries to parse the content from a specified path as a JSON object.

Specified by:

getObject in interface IDataRetriever

Type Parameters:

T - the type of the object that is to be read

Parameters:

filePath - the path to a JSON file

targetType - the type of the object that is read from disc

Returns:

an object, or null if the file could not be parsed

getHtml

public org.jsoup.nodes.Document getHtml(String filePath)

Description copied from interface: IDataRetriever

Tries to parse the content from a specified path as a HTML document.

Specified by:

getHtml in interface IDataRetriever

Parameters:

filePath - the path to a HTML file

Returns:

a HTML document, or null if the file could not be parsed

setCharset

public void setCharset(Charset charset)

Description copied from interface: IDataRetriever

Changes the charset used for (de-)serializing requests.

Specified by:

setCharset in interface IDataRetriever

Parameters:

charset - the new charset