uk.gov.gchq.gaffer.data.generator

Class CsvGenerator

java.lang.Object

uk.gov.gchq.gaffer.data.generator.CsvGenerator

All Implemented Interfaces:

Function<Iterable<? extends Element>,Iterable<? extends String>>, ObjectGenerator<String>, OneToOneObjectGenerator<String>

public class CsvGenerator
extends Object
implements OneToOneObjectGenerator<String>

Generates a CSV string for each Element, based on the fields and constants provided.

For example, if you provide:

  fields=[prop1, SOURCE, DESTINATION, prop2, GROUP] and constants=["constant1", "constant2"]
 

The output will be:

  prop1Value,sourceValue,destinationValue,prop2,groupValue,constant1,constant2
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CsvGenerator.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMMA
static String	GROUP

Constructor Summary

Constructors

Constructor and Description
CsvGenerator()

Method Summary

Modifier and Type	Method and Description
String	_apply(Element element)
String	getCommaReplacement()
LinkedHashMap<String,String>	getConstants()
LinkedHashMap<String,String>	getFields()
String	getHeader() Generates a CSV String from, if present, the fields and constants
boolean	isQuoted()
void	setCommaReplacement(String commaReplacement)
void	setConstants(LinkedHashMap<String,String> constants)
void	setFields(LinkedHashMap<String,String> fields)
void	setQuoted(boolean quoted)

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.gov.gchq.gaffer.data.generator.OneToOneObjectGenerator

apply

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Field Detail

GROUP

public static final String GROUP

See Also:

Constant Field Values

COMMA

public static final String COMMA

See Also:

Constant Field Values

Constructor Detail

CsvGenerator

public CsvGenerator()

Method Detail

getFields

public LinkedHashMap<String,String> getFields()

setFields

public void setFields(LinkedHashMap<String,String> fields)

getConstants

public LinkedHashMap<String,String> getConstants()

setConstants

public void setConstants(LinkedHashMap<String,String> constants)

_apply

public String _apply(Element element)

Specified by:

_apply in interface OneToOneObjectGenerator<String>

Parameters:

element - the element to convert

Returns:

the generated domain object

getHeader

public String getHeader()

Generates a CSV String from, if present, the fields and constants

Returns:

a CSV String of all fields, or constants, or both.

isQuoted

public boolean isQuoted()

setQuoted

public void setQuoted(boolean quoted)

getCommaReplacement

public String getCommaReplacement()

setCommaReplacement

public void setCommaReplacement(String commaReplacement)