Package org.openmetadata.csv

Class EntityCsv<T extends EntityInterface>

java.lang.Object

org.openmetadata.csv.EntityCsv<T>

Direct Known Subclasses:

GlossaryRepository.GlossaryCsv, TeamRepository.TeamCsv, UserRepository.UserCsv

public abstract class EntityCsv<T extends EntityInterface>
extends Object

EntityCsv provides export and import capabilities for an entity. Each entity must implement the abstract methods to provide entity specific processing functionality to export an entity to a CSV record, and import an entity from a CSV record.

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,T>	dryRunCreatedEntities
static String	ENTITY_CREATED
static String	ENTITY_UPDATED
static String	FIELD_ERROR_MSG
static String	IMPORT_STATUS_DETAILS
static String	IMPORT_STATUS_FAILED
static String	IMPORT_STATUS_HEADER
static String	IMPORT_STATUS_SUCCESS
protected boolean	processRecord

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EntityCsv(String entityType, List<CsvHeader> csvHeaders, String importedBy)

Method Summary

Modifier and Type	Method	Description
static String	entityNotFound(int field, String fqn)
String	exportCsv(List<T> entities)
String	failed(String exception, CsvErrorType errorType)
static String	fieldRequired(int field)
protected Boolean	getBoolean(org.apache.commons.csv.CSVPrinter printer, org.apache.commons.csv.CSVRecord csvRecord, int fieldNumber)
static CsvDocumentation	getCsvDocumentation(String entityType)
protected EntityInterface	getEntityByName(String entityType, String fqn)
protected EntityReference	getEntityReference(org.apache.commons.csv.CSVPrinter printer, org.apache.commons.csv.CSVRecord csvRecord, int fieldNumber, String entityType)
protected EntityReference	getEntityReference(org.apache.commons.csv.CSVPrinter printer, org.apache.commons.csv.CSVRecord csvRecord, int fieldNumber, String entityType, String fqn)
protected List<EntityReference>	getEntityReferences(org.apache.commons.csv.CSVPrinter printer, org.apache.commons.csv.CSVRecord csvRecord, int fieldNumber, String entityType)
EntityReference	getOwner(org.apache.commons.csv.CSVPrinter printer, org.apache.commons.csv.CSVRecord csvRecord, int fieldNumber)	Owner field is in entityType;entityName format
EntityReference	getOwnerAsUser(org.apache.commons.csv.CSVPrinter printer, org.apache.commons.csv.CSVRecord csvRecord, int fieldNumber)	Owner field is in entityName format
static String[]	getResultHeaders(List<CsvHeader> csvHeaders)
protected List<TagLabel>	getTagLabels(org.apache.commons.csv.CSVPrinter printer, org.apache.commons.csv.CSVRecord csvRecord, int fieldNumber)
protected List<EntityReference>	getUserOrTeamEntityReferences(org.apache.commons.csv.CSVPrinter printer, org.apache.commons.csv.CSVRecord csvRecord, int fieldNumber, String entityType)
CsvImportResult	importCsv(String csv, boolean dryRun)	Import entities from a CSV file
protected void	importFailure(org.apache.commons.csv.CSVPrinter printer, String failedReason, org.apache.commons.csv.CSVRecord inputRecord)
static String	invalidBoolean(int field, String fieldValue)
static String	invalidField(int field, String error)
static String	invalidFieldCount(int expectedFieldCount, int actualFieldCount)
static String	invalidHeader(String expected, String actual)
static String	invalidOwner(int field)
protected abstract T	toEntity(org.apache.commons.csv.CSVPrinter resultsPrinter, org.apache.commons.csv.CSVRecord csvRecord)	Implement this method to a CSV record and turn it into an entity
protected abstract List<String>	toRecord(T entity)	Implement this method to export an entity into a list of fields to create a CSV record

Methods inherited from class java.lang.Object

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

Field Detail

FIELD_ERROR_MSG

public static final String FIELD_ERROR_MSG

See Also:

Constant Field Values

IMPORT_STATUS_HEADER

public static final String IMPORT_STATUS_HEADER

See Also:

Constant Field Values

IMPORT_STATUS_DETAILS

public static final String IMPORT_STATUS_DETAILS

See Also:

Constant Field Values

IMPORT_STATUS_SUCCESS

public static final String IMPORT_STATUS_SUCCESS

See Also:

Constant Field Values

IMPORT_STATUS_FAILED

public static final String IMPORT_STATUS_FAILED

See Also:

Constant Field Values

ENTITY_CREATED

public static final String ENTITY_CREATED

See Also:

Constant Field Values

ENTITY_UPDATED

public static final String ENTITY_UPDATED

See Also:

Constant Field Values

processRecord

protected boolean processRecord

dryRunCreatedEntities

protected final Map<String,T extends EntityInterface> dryRunCreatedEntities

Constructor Detail

EntityCsv

protected EntityCsv(String entityType,
                    List<CsvHeader> csvHeaders,
                    String importedBy)

Method Detail

importCsv

public final CsvImportResult importCsv(String csv,
                                       boolean dryRun)
                                throws IOException

Import entities from a CSV file

Throws:

IOException

toEntity

protected abstract T toEntity(org.apache.commons.csv.CSVPrinter resultsPrinter,
                              org.apache.commons.csv.CSVRecord csvRecord)
                       throws IOException

Implement this method to a CSV record and turn it into an entity

Throws:

IOException

exportCsv

public final String exportCsv(List<T> entities)
                       throws IOException

Throws:

IOException

getCsvDocumentation

public static CsvDocumentation getCsvDocumentation(String entityType)

toRecord

protected abstract List<String> toRecord(T entity)

Implement this method to export an entity into a list of fields to create a CSV record

getOwner

public EntityReference getOwner(org.apache.commons.csv.CSVPrinter printer,
                                org.apache.commons.csv.CSVRecord csvRecord,
                                int fieldNumber)
                         throws IOException

Owner field is in entityType;entityName format

Throws:

IOException

getOwnerAsUser

public EntityReference getOwnerAsUser(org.apache.commons.csv.CSVPrinter printer,
                                      org.apache.commons.csv.CSVRecord csvRecord,
                                      int fieldNumber)
                               throws IOException

Owner field is in entityName format

Throws:

IOException

getBoolean

protected final Boolean getBoolean(org.apache.commons.csv.CSVPrinter printer,
                                   org.apache.commons.csv.CSVRecord csvRecord,
                                   int fieldNumber)
                            throws IOException

Throws:

IOException

getEntityReference

protected final EntityReference getEntityReference(org.apache.commons.csv.CSVPrinter printer,
                                                   org.apache.commons.csv.CSVRecord csvRecord,
                                                   int fieldNumber,
                                                   String entityType)
                                            throws IOException

Throws:

IOException

getEntityByName

protected EntityInterface getEntityByName(String entityType,
                                          String fqn)

getEntityReference

protected final EntityReference getEntityReference(org.apache.commons.csv.CSVPrinter printer,
                                                   org.apache.commons.csv.CSVRecord csvRecord,
                                                   int fieldNumber,
                                                   String entityType,
                                                   String fqn)
                                            throws IOException

Throws:

IOException

getEntityReferences

protected final List<EntityReference> getEntityReferences(org.apache.commons.csv.CSVPrinter printer,
                                                          org.apache.commons.csv.CSVRecord csvRecord,
                                                          int fieldNumber,
                                                          String entityType)
                                                   throws IOException

Throws:

IOException

getUserOrTeamEntityReferences

protected final List<EntityReference> getUserOrTeamEntityReferences(org.apache.commons.csv.CSVPrinter printer,
                                                                    org.apache.commons.csv.CSVRecord csvRecord,
                                                                    int fieldNumber,
                                                                    String entityType)
                                                             throws IOException

Throws:

IOException

getTagLabels

protected final List<TagLabel> getTagLabels(org.apache.commons.csv.CSVPrinter printer,
                                            org.apache.commons.csv.CSVRecord csvRecord,
                                            int fieldNumber)
                                     throws IOException

Throws:

IOException

getResultHeaders

public static String[] getResultHeaders(List<CsvHeader> csvHeaders)

failed

public String failed(String exception,
                     CsvErrorType errorType)

invalidHeader

public static String invalidHeader(String expected,
                                   String actual)

invalidFieldCount

public static String invalidFieldCount(int expectedFieldCount,
                                       int actualFieldCount)

fieldRequired

public static String fieldRequired(int field)

invalidField

public static String invalidField(int field,
                                  String error)

entityNotFound

public static String entityNotFound(int field,
                                    String fqn)

invalidOwner

public static String invalidOwner(int field)

invalidBoolean

public static String invalidBoolean(int field,
                                    String fieldValue)

importFailure

protected void importFailure(org.apache.commons.csv.CSVPrinter printer,
                             String failedReason,
                             org.apache.commons.csv.CSVRecord inputRecord)
                      throws IOException

Throws:

IOException