de.gerdiproject.harvest.etls.loaders

Class DiskLoader

java.lang.Object

de.gerdiproject.harvest.etls.loaders.AbstractIteratorLoader<de.gerdiproject.json.datacite.DataCiteJson>

de.gerdiproject.harvest.etls.loaders.DiskLoader

All Implemented Interfaces:

ILoader<Iterator<de.gerdiproject.json.datacite.DataCiteJson>>

public class DiskLoader
extends AbstractIteratorLoader<de.gerdiproject.json.datacite.DataCiteJson>

This class offers functions for saving a harvest result to disk.

Author:

Robin Weiss

Field Summary

Fields inherited from class de.gerdiproject.harvest.etls.loaders.AbstractIteratorLoader

dedicatedEtl, hasLoadedDocuments

Constructor Summary

Constructors

Constructor and Description
DiskLoader() Constructor that sets the parser and save folder.

Method Summary

Modifier and Type	Method and Description
void	clear() Attempts to close the writer.
File	createTargetFile(String fileName) Returns the file to which the documents are saved.
void	init(AbstractETL<?,?> etl) Initializes the loader for a new harvest.
void	load(Iterator<de.gerdiproject.json.datacite.DataCiteJson> documents) Loads the document to a targeted search index.
void	loadElement(de.gerdiproject.json.datacite.DataCiteJson document) Loads a single element of the Iterator.
void	unregisterParameters() If the Loader created parameters in the Configuration, this method should unregister all of them.

Methods inherited from class de.gerdiproject.harvest.etls.loaders.AbstractIteratorLoader

loadElementAndIncrement

Methods inherited from class java.lang.Object

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

Constructor Detail

DiskLoader

public DiskLoader()

Constructor that sets the parser and save folder.

Method Detail

unregisterParameters

public void unregisterParameters()

Description copied from interface: ILoader

If the Loader created parameters in the Configuration, this method should unregister all of them. It's called when a different Loader is used.

createTargetFile

public File createTargetFile(String fileName)

Returns the file to which the documents are saved. The file location is determined by the deployment specific cache folder root and the subfolder determined by a StringParameter.

Parameters:

fileName - the name of the file without extension

Returns:

the File to which the documents are saved, or null if init() was not called before

load

public void load(Iterator<de.gerdiproject.json.datacite.DataCiteJson> documents)
          throws LoaderException

Description copied from interface: ILoader

Loads the document to a targeted search index.

Specified by:

load in interface ILoader<Iterator<de.gerdiproject.json.datacite.DataCiteJson>>

Overrides:

load in class AbstractIteratorLoader<de.gerdiproject.json.datacite.DataCiteJson>

Parameters:

documents - the document that is to be loaded

Throws:

LoaderException - when the load did not work properly

init

public void init(AbstractETL<?,?> etl)

Description copied from interface: ILoader

Initializes the loader for a new harvest.

Specified by:

init in interface ILoader<Iterator<de.gerdiproject.json.datacite.DataCiteJson>>

Overrides:

init in class AbstractIteratorLoader<de.gerdiproject.json.datacite.DataCiteJson>

Parameters:

etl - the AbstractETL to which the loader belongs

clear

public void clear()

Attempts to close the writer.

Throws:

LoaderException - thrown if there is an error closing the writer

loadElement

public void loadElement(de.gerdiproject.json.datacite.DataCiteJson document)
                 throws LoaderException

Description copied from class: AbstractIteratorLoader

Loads a single element of the Iterator.

Specified by:

loadElement in class AbstractIteratorLoader<de.gerdiproject.json.datacite.DataCiteJson>

Parameters:

document - a document that is to be loaded

Throws:

LoaderException - when the load failed