Class QRecordToTsvAdapter

java.lang.Object

com.kingsrook.qqq.backend.core.adapters.QRecordToTsvAdapter

public class QRecordToTsvAdapter
extends Object

Class to convert QRecords to TSV (Tab Separated Value) Strings. By default, escapes \n, \t, \r, and \ chars within values as \n, \t, \r, and \\ This behavior can be customized via sanitizationType property.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	QRecordToTsvAdapter.SanitizationType	options for how special-char values (\n, \t, \r, and \\) should be sanitized

Constructor Summary

Constructors

Constructor	Description
QRecordToTsvAdapter()

Method Summary

Modifier and Type	Method	Description
QRecordToTsvAdapter.SanitizationType	getSanitizationType()	Getter for sanitizationType
String	recordToTsv(QTableMetaData table, QRecord record)	Convert one record (with all of its table's fields) to TSV.
String	recordToTsv(QTableMetaData table, QRecord record, List<QFieldMetaData> fields)	Convert one record (with all of its table's fields) to TSV, with a specified set of fields.
void	setSanitizationType(QRecordToTsvAdapter.SanitizationType sanitizationType)	Setter for sanitizationType
QRecordToTsvAdapter	withSanitizationType(QRecordToTsvAdapter.SanitizationType sanitizationType)	Fluent setter for sanitizationType

Methods inherited from class java.lang.Object

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

Constructor Details

QRecordToTsvAdapter

public QRecordToTsvAdapter()

Method Details

recordToTsv

public String recordToTsv(QTableMetaData table,
 QRecord record)

Convert one record (with all of its table's fields) to TSV.

Parameters:

table - the table that the record is from

record - the record full of values

Returns:

TSV string - ENDING with newline (\n)!

recordToTsv

public String recordToTsv(QTableMetaData table,
 QRecord record,
 List<QFieldMetaData> fields)

Convert one record (with all of its table's fields) to TSV, with a specified set of fields.

Parameters:

table - the table that the record is from

record - the record full of values

fields - list of fields to include. "joinTable.field" notation will work if the record contains joined fields.

Returns:

TSV string - ENDING with newline (\n)!

getSanitizationType

public QRecordToTsvAdapter.SanitizationType getSanitizationType()

Getter for sanitizationType

See Also:

• withSanitizationType(SanitizationType)

setSanitizationType

public void setSanitizationType(QRecordToTsvAdapter.SanitizationType sanitizationType)

Setter for sanitizationType

See Also:

• withSanitizationType(SanitizationType)

withSanitizationType

public QRecordToTsvAdapter withSanitizationType(QRecordToTsvAdapter.SanitizationType sanitizationType)

Fluent setter for sanitizationType

Parameters:

sanitizationType - how tsv-special chars should be handled by this instance.

Returns:

this