Package uk.gov.gchq.gaffer.operation.impl.export.localfile

Class ExportToLocalFile

java.lang.Object

uk.gov.gchq.gaffer.operation.impl.export.localfile.ExportToLocalFile

All Implemented Interfaces:

Closeable, AutoCloseable, Export, ExportTo<Iterable<? extends String>>, Input<Iterable<? extends String>>, InputOutput<Iterable<? extends String>,Iterable<? extends String>>, Output<Iterable<? extends String>>, Operation

public class ExportToLocalFile
extends Object
implements ExportTo<Iterable<? extends String>>

A ExportToLocalFile operation that takes an Iterable of Strings and writes them to a local file.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExportToLocalFile.Builder

Nested classes/interfaces inherited from interface uk.gov.gchq.gaffer.operation.Operation

Operation.BaseBuilder<OP extends Operation,B extends Operation.BaseBuilder<OP,?>>

Field Summary

Fields inherited from interface uk.gov.gchq.gaffer.operation.export.Export

DEFAULT_KEY

Constructor Summary

Constructors

Constructor	Description
ExportToLocalFile()

Method Summary

Modifier and Type	Method	Description
String	getFilePath()
Iterable<? extends String>	getInput()
String	getKey()
Map<String,String>	getOptions()
com.fasterxml.jackson.core.type.TypeReference<Iterable<? extends String>>	getOutputTypeReference()
void	setFilePath(String filePath)
void	setInput(Iterable<? extends String> input)
void	setKey(String key)
void	setOptions(Map<String,String> options)
ExportToLocalFile	shallowClone()	Operation implementations should ensure a ShallowClone method is implemented.

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.gov.gchq.gaffer.operation.export.Export

getKeyOrDefault

Methods inherited from interface uk.gov.gchq.gaffer.operation.io.Input

close

Methods inherited from interface uk.gov.gchq.gaffer.operation.Operation

_getNullOrOptions, addOption, containsOption, getOption, getOption, validate, validateRequiredFieldPresent

Methods inherited from interface uk.gov.gchq.gaffer.operation.io.Output

castToOutputType, getOutputClass, getOutputType

Constructor Detail

ExportToLocalFile

public ExportToLocalFile()

Method Detail

getFilePath

public final String getFilePath()

setFilePath

public void setFilePath(String filePath)

shallowClone

public ExportToLocalFile shallowClone()
                               throws org.apache.commons.lang3.exception.CloneFailedException

Description copied from interface: Operation

Operation implementations should ensure a ShallowClone method is implemented. Performs a shallow clone. Creates a new instance and copies the fields across. It does not clone the fields. If the operation contains nested operations, these must also be cloned.

Specified by:

shallowClone in interface Operation

Returns:

shallow clone

Throws:

org.apache.commons.lang3.exception.CloneFailedException - if a Clone error occurs

getOptions

public Map<String,String> getOptions()

Specified by:

getOptions in interface Operation

Returns:

the operation options. This may contain store specific options such as authorisation strings or and other properties required for the operation to be executed. Note these options will probably not be interpreted in the same way by every store implementation.

setOptions

public void setOptions(Map<String,String> options)

Specified by:

setOptions in interface Operation

Parameters:

options - the operation options. This may contain store specific options such as authorisation strings or and other properties required for the operation to be executed. Note these options will probably not be interpreted in the same way by every store implementation.

getKey

public final String getKey()

Specified by:

getKey in interface Export

setKey

public void setKey(String key)

Specified by:

setKey in interface Export

getInput

public final Iterable<? extends String> getInput()

Specified by:

getInput in interface Input<Iterable<? extends String>>

setInput

public void setInput(Iterable<? extends String> input)

Specified by:

setInput in interface Input<Iterable<? extends String>>

getOutputTypeReference

public com.fasterxml.jackson.core.type.TypeReference<Iterable<? extends String>> getOutputTypeReference()

Specified by:

getOutputTypeReference in interface Output<Iterable<? extends String>>