Class ToCsv
- java.lang.Object
-
- uk.gov.gchq.gaffer.operation.impl.output.ToCsv
-
- All Implemented Interfaces:
Closeable
,AutoCloseable
,Input<Iterable<? extends Element>>
,InputOutput<Iterable<? extends Element>,Iterable<? extends String>>
,MultiInput<Element>
,Output<Iterable<? extends String>>
,Operation
public class ToCsv extends Object implements InputOutput<Iterable<? extends Element>,Iterable<? extends String>>, MultiInput<Element>
AToMap
operation takes in anIterable
of items and uses aCsvGenerator
to convert each item into a CSV String.- See Also:
ToCsv.Builder
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ToCsv.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 ToCsv()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CsvGenerator
getCsvGenerator()
Iterable<? extends Element>
getInput()
Map<String,String>
getOptions()
com.fasterxml.jackson.core.type.TypeReference<Iterable<? extends String>>
getOutputTypeReference()
boolean
isIncludeHeader()
void
setCsvGenerator(CsvGenerator csvGenerator)
void
setIncludeHeader(boolean includeHeader)
void
setInput(Iterable<? extends Element> input)
void
setOptions(Map<String,String> options)
ToCsv
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.io.MultiInput
createInputArray, setInput
-
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
-
-
-
-
Method Detail
-
getCsvGenerator
public CsvGenerator getCsvGenerator()
-
setCsvGenerator
public void setCsvGenerator(CsvGenerator csvGenerator)
-
isIncludeHeader
public boolean isIncludeHeader()
-
setIncludeHeader
public void setIncludeHeader(boolean includeHeader)
-
getOutputTypeReference
public com.fasterxml.jackson.core.type.TypeReference<Iterable<? extends String>> getOutputTypeReference()
- Specified by:
getOutputTypeReference
in interfaceOutput<Iterable<? extends String>>
-
shallowClone
public ToCsv 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 interfaceOperation
- Returns:
- shallow clone
-
getOptions
public Map<String,String> getOptions()
- Specified by:
getOptions
in interfaceOperation
- 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 interfaceOperation
- 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.
-
-