Package uk.gov.gchq.gaffer.operation.impl.add

Class AddElementsFromFile

java.lang.Object

uk.gov.gchq.gaffer.operation.impl.add.AddElementsFromFile

All Implemented Interfaces:

Closeable, AutoCloseable, Operation, Validatable

public class AddElementsFromFile
extends Object
implements Operation, Validatable

An AddElementsFromFile operation takes a filename, converts each line of the file to a Gaffer Element using the provided ElementGenerator then adds these elements to the Graph.

See Also:

AddElementsFromFile.Builder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AddElementsFromFile.Builder

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

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

Constructor Summary

Constructors

Constructor	Description
AddElementsFromFile()

Method Summary

Modifier and Type	Method	Description
Class<? extends Function<Iterable<? extends String>,Iterable<? extends Element>>>	getElementGenerator()
String	getFilename()
Map<String,String>	getOptions()
Integer	getParallelism()
boolean	isSkipInvalidElements()
boolean	isValidate()
void	setElementGenerator(Class<? extends Function<Iterable<? extends String>,Iterable<? extends Element>>> elementGenerator)
void	setFilename(String filename)
void	setOptions(Map<String,String> options)
void	setParallelism(Integer parallelism)
void	setSkipInvalidElements(boolean skipInvalidElements)
void	setValidate(boolean validate)
AddElementsFromFile	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.Operation

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

Constructor Detail

AddElementsFromFile

public AddElementsFromFile()

Method Detail

getFilename

public String getFilename()

setFilename

public void setFilename(String filename)

setParallelism

public void setParallelism(Integer parallelism)

getParallelism

public Integer getParallelism()

getElementGenerator

public Class<? extends Function<Iterable<? extends String>,Iterable<? extends Element>>> getElementGenerator()

setElementGenerator

public void setElementGenerator(Class<? extends Function<Iterable<? extends String>,Iterable<? extends Element>>> elementGenerator)

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.

isSkipInvalidElements

public boolean isSkipInvalidElements()

Specified by:

isSkipInvalidElements in interface Validatable

Returns:

true if invalid elements should be skipped. Otherwise false if the operation should fail.

setSkipInvalidElements

public void setSkipInvalidElements(boolean skipInvalidElements)

Specified by:

setSkipInvalidElements in interface Validatable

Parameters:

skipInvalidElements - true if invalid elements should be skipped. Otherwise false if the operation should fail.

isValidate

public boolean isValidate()

Specified by:

isValidate in interface Validatable

Returns:

true if the operation should be validated. Otherwise false.

setValidate

public void setValidate(boolean validate)

Specified by:

setValidate in interface Validatable

Parameters:

validate - true if the operation should be validated. Otherwise false.

shallowClone

public AddElementsFromFile shallowClone()

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