Package org.openmetadata.service.util

Class EntityUtil

java.lang.Object

org.openmetadata.service.util.EntityUtil

public final class EntityUtil
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EntityUtil.Fields

Field Summary

Fields

Modifier and Type	Field	Description
static final BiPredicate<Column,Column>	columnMatch
static final BiPredicate<Column,Column>	columnNameMatch
static final Comparator<ChangeEvent>	compareChangeEvent
static final Comparator<CustomProperty>	compareCustomProperty
static final Comparator<EntityReference>	compareEntityReference
static final Comparator<EntityReference>	compareEntityReferenceById
static final Comparator<FieldChange>	compareFieldChange
static final Comparator<GlossaryTerm>	compareGlossaryTerm
static final Comparator<TableConstraint>	compareTableConstraint
static final Comparator<TagLabel>	compareTagLabel
static final Comparator<CollectionDAO.EntityVersionPair>	compareVersion
static final BiPredicate<ContainerFileFormat,ContainerFileFormat>	containerFileFormatMatch
static final BiPredicate<CustomProperty,CustomProperty>	customFieldMatch
static final BiPredicate<EntityReference,EntityReference>	entityReferenceMatch
static final BiPredicate<GlossaryTerm,GlossaryTerm>	glossaryTermMatch
static final BiPredicate<MlFeature,MlFeature>	mlFeatureMatch
static final BiPredicate<MlHyperParameter,MlHyperParameter>	mlHyperParameterMatch
static final BiPredicate<Object,Object>	objectMatch
static final BiPredicate<Rule,Rule>	ruleMatch
static final BiPredicate<Field,Field>	schemaFieldMatch
static final BiPredicate<SearchIndexField,SearchIndexField>	searchIndexFieldMatch
static final BiPredicate<String,String>	stringMatch
static final BiPredicate<TableConstraint,TableConstraint>	tableConstraintMatch
static final BiPredicate<TagLabel,TagLabel>	tagLabelMatch
static final BiPredicate<Task,Task>	taskMatch
static final BiPredicate<TermReference,TermReference>	termReferenceMatch

Method Summary

Modifier and Type	Method	Description
static String	addField(String fields, String newField)
static void	copy(EntityReference from, EntityReference to)
static MetadataOperation	createOrUpdateOperation(ResourceContext<?> resourceContext)
static void	fieldAdded(ChangeDescription change, String fieldName, Object newValue)
static void	fieldDeleted(ChangeDescription change, String fieldName, Object oldValue)
static void	fieldUpdated(ChangeDescription change, String fieldName, Object oldValue, Object newValue)
static Column	findColumn(List<Column> columns, String columnName)
static Column	getColumn(Table table, String columnName)
static String	getColumnField(Column column, String columnField)	Return column field name of format "columns".columnName.columnFieldName
static String	getCustomField(CustomProperty property, String propertyFieldName)	Return customer property field name of format "customProperties".propertyName
static EntityReference	getEntityReference(String entityType, String fqn)
static EntityReference	getEntityReference(EntityInterface entity)
static List<EntityReference>	getEntityReferences(String entityType, List<String> fqns)
static List<EntityReference>	getEntityReferences(List<EntityReference> entities, Include include)	This method is used to populate the entity with all details of EntityReference Users/Tools can send minimum details required to set relationship as id, type are the only required fields in entity reference, whereas we need to send fully populated object such that ElasticSearch index has all the details.
static List<EntityReference>	getEntityReferences(List<CollectionDAO.EntityRelationshipRecord> list)
static String	getExtensionField(String key)	Return extension field name of format "extension".fieldName
static String	getFieldName(String... strings)
static <T extends FieldInterface> List<T>	getFlattenedEntityField(List<T> fields)
static String	getFqn(EntityInterface entity)
static String	getFqn(EntityReference ref)
static List<String>	getFqns(List<EntityReference> refs)
static UUID	getId(EntityReference ref)
static List<String>	getJsonDataResources(String path)
static UsageDetails	getLatestUsage(CollectionDAO.UsageDAO usageDAO, UUID entityId)
static String	getLocalColumnName(String tableFqn, String columnFqn)
static String	getRuleField(Rule rule, String ruleField)	Return rule field name of format "rules".ruleName.ruleFieldName
static String	getSchemaField(Topic topic, Field field, String fieldName)	Return schema field name of format "schemaFields".fieldName.fieldName
static String	getSearchIndexField(SearchIndex searchIndex, SearchIndexField field, String fieldName)	Return searchIndex field name of format "fields".fieldName.fieldName
static Double	getVersion(String extension)
static String	getVersionExtension(String entityType, Double version)	Entity version extension name formed by entityType.version.versionNumber.
static String	getVersionExtensionPrefix(String entityType)	Entity version extension name prefix formed by `entityType.version`.
static String	hash(String input)
static boolean	isApprovalTask(TaskType taskType)
static <T> boolean	isDescriptionRequired(Class<T> clz)
static boolean	isDescriptionTask(TaskType taskType)
static boolean	isTagTask(TaskType taskType)
static boolean	isTestCaseFailureResolutionTask(TaskType taskType)
static void	mergeTags(List<TagLabel> mergeTo, List<TagLabel> mergeFrom)	Merge two sets of tags
static Double	nextMajorVersion(Double version)
static Double	nextVersion(Double version)
static List<EntityReference>	populateEntityReferences(List<EntityReference> list)
static List<EntityReference>	populateEntityReferencesById(List<UUID> list, String entityType)
static Double	previousVersion(Double version)
static List<UUID>	refToIds(List<EntityReference> refs)
static void	sortByFQN(List<? extends EntityInterface> entities)
static List<UUID>	strToIds(List<String> list)
static List<EntityReference>	toEntityReferences(List<UUID> ids, String entityType)
static <T extends EntityInterface> List<String>	toFQNs(List<T> entities)
static TagLabel	toTagLabel(Tag tag)
static TagLabel	toTagLabel(GlossaryTerm term)
static List<TagLabel>	toTagLabels(Tag... tags)
static List<TagLabel>	toTagLabels(GlossaryTerm... terms)
static <T> T	validate(Object id, String json, Class<T> clz)	Validate that JSON payload can be turned into POJO object
static EntityReference	validateEntityLink(MessageParser.EntityLink entityLink)
static void	validateProfileSample(String profileSampleType, double profileSampleValue)

Methods inherited from class java.lang.Object

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

Field Details

compareEntityReference

public static final Comparator<EntityReference> compareEntityReference

compareEntityReferenceById

public static final Comparator<EntityReference> compareEntityReferenceById

compareVersion

public static final Comparator<CollectionDAO.EntityVersionPair> compareVersion

compareTagLabel

public static final Comparator<TagLabel> compareTagLabel

compareFieldChange

public static final Comparator<FieldChange> compareFieldChange

compareTableConstraint

public static final Comparator<TableConstraint> compareTableConstraint

compareChangeEvent

public static final Comparator<ChangeEvent> compareChangeEvent

compareGlossaryTerm

public static final Comparator<GlossaryTerm> compareGlossaryTerm

compareCustomProperty

public static final Comparator<CustomProperty> compareCustomProperty

objectMatch

public static final BiPredicate<Object,Object> objectMatch

entityReferenceMatch

public static final BiPredicate<EntityReference,EntityReference> entityReferenceMatch

tagLabelMatch

public static final BiPredicate<TagLabel,TagLabel> tagLabelMatch

taskMatch

public static final BiPredicate<Task,Task> taskMatch

stringMatch

public static final BiPredicate<String,String> stringMatch

columnMatch

public static final BiPredicate<Column,Column> columnMatch

columnNameMatch

public static final BiPredicate<Column,Column> columnNameMatch

tableConstraintMatch

public static final BiPredicate<TableConstraint,TableConstraint> tableConstraintMatch

mlFeatureMatch

public static final BiPredicate<MlFeature,MlFeature> mlFeatureMatch

mlHyperParameterMatch

public static final BiPredicate<MlHyperParameter,MlHyperParameter> mlHyperParameterMatch

glossaryTermMatch

public static final BiPredicate<GlossaryTerm,GlossaryTerm> glossaryTermMatch

containerFileFormatMatch

public static final BiPredicate<ContainerFileFormat,ContainerFileFormat> containerFileFormatMatch

termReferenceMatch

public static final BiPredicate<TermReference,TermReference> termReferenceMatch

customFieldMatch

public static final BiPredicate<CustomProperty,CustomProperty> customFieldMatch

ruleMatch

public static final BiPredicate<Rule,Rule> ruleMatch

schemaFieldMatch

public static final BiPredicate<Field,Field> schemaFieldMatch

searchIndexFieldMatch

public static final BiPredicate<SearchIndexField,SearchIndexField> searchIndexFieldMatch

Method Details

validate

public static <T> T validate(Object id,
 String json,
 Class<T> clz)
                      throws javax.ws.rs.WebApplicationException

Validate that JSON payload can be turned into POJO object

Throws:

javax.ws.rs.WebApplicationException

populateEntityReferences

public static List<EntityReference> populateEntityReferences(List<EntityReference> list)

getEntityReferences

public static List<EntityReference> getEntityReferences(List<CollectionDAO.EntityRelationshipRecord> list)

populateEntityReferencesById

public static List<EntityReference> populateEntityReferencesById(List<UUID> list,
 String entityType)

validateEntityLink

public static EntityReference validateEntityLink(MessageParser.EntityLink entityLink)

getLatestUsage

public static UsageDetails getLatestUsage(CollectionDAO.UsageDAO usageDAO,
 UUID entityId)

mergeTags

public static void mergeTags(List<TagLabel> mergeTo,
 List<TagLabel> mergeFrom)

Merge two sets of tags

getJsonDataResources

public static List<String> getJsonDataResources(String path)
                                         throws IOException

Throws:

IOException

toFQNs

public static <T extends EntityInterface>
List<String> toFQNs(List<T> entities)

strToIds

public static List<UUID> strToIds(List<String> list)

toEntityReferences

public static List<EntityReference> toEntityReferences(List<UUID> ids,
 String entityType)

refToIds

public static List<UUID> refToIds(List<EntityReference> refs)

isDescriptionRequired

public static <T> boolean isDescriptionRequired(Class<T> clz)

getVersionExtension

public static String getVersionExtension(String entityType,
 Double version)

Entity version extension name formed by entityType.version.versionNumber. Example - `table.version.0.1`

getVersionExtensionPrefix

public static String getVersionExtensionPrefix(String entityType)

Entity version extension name prefix formed by `entityType.version`. Example - `table.version`

getVersion

public static Double getVersion(String extension)

getLocalColumnName

public static String getLocalColumnName(String tableFqn,
 String columnFqn)

getFieldName

public static String getFieldName(String... strings)

getColumnField

public static String getColumnField(Column column,
 String columnField)

Return column field name of format "columns".columnName.columnFieldName

getSchemaField

public static String getSchemaField(Topic topic,
 Field field,
 String fieldName)

Return schema field name of format "schemaFields".fieldName.fieldName

getSearchIndexField

public static String getSearchIndexField(SearchIndex searchIndex,
 SearchIndexField field,
 String fieldName)

Return searchIndex field name of format "fields".fieldName.fieldName

getRuleField

public static String getRuleField(Rule rule,
 String ruleField)

Return rule field name of format "rules".ruleName.ruleFieldName

getCustomField

public static String getCustomField(CustomProperty property,
 String propertyFieldName)

Return customer property field name of format "customProperties".propertyName

getExtensionField

public static String getExtensionField(String key)

Return extension field name of format "extension".fieldName

previousVersion

public static Double previousVersion(Double version)

nextVersion

public static Double nextVersion(Double version)

nextMajorVersion

public static Double nextMajorVersion(Double version)

copy

public static void copy(EntityReference from,
 EntityReference to)

toTagLabels

public static List<TagLabel> toTagLabels(GlossaryTerm... terms)

toTagLabels

public static List<TagLabel> toTagLabels(Tag... tags)

toTagLabel

public static TagLabel toTagLabel(GlossaryTerm term)

toTagLabel

public static TagLabel toTagLabel(Tag tag)

addField

public static String addField(String fields,
 String newField)

fieldAdded

public static void fieldAdded(ChangeDescription change,
 String fieldName,
 Object newValue)

fieldDeleted

public static void fieldDeleted(ChangeDescription change,
 String fieldName,
 Object oldValue)

fieldUpdated

public static void fieldUpdated(ChangeDescription change,
 String fieldName,
 Object oldValue,
 Object newValue)

createOrUpdateOperation

public static MetadataOperation createOrUpdateOperation(ResourceContext<?> resourceContext)

getId

public static UUID getId(EntityReference ref)

getFqn

public static String getFqn(EntityReference ref)

getFqn

public static String getFqn(EntityInterface entity)

getFqns

public static List<String> getFqns(List<EntityReference> refs)

getEntityReference

public static EntityReference getEntityReference(EntityInterface entity)

getEntityReference

public static EntityReference getEntityReference(String entityType,
 String fqn)

getEntityReferences

public static List<EntityReference> getEntityReferences(String entityType,
 List<String> fqns)

getColumn

public static Column getColumn(Table table,
 String columnName)

sortByFQN

public static void sortByFQN(List<? extends EntityInterface> entities)

getEntityReferences

public static List<EntityReference> getEntityReferences(List<EntityReference> entities,
 Include include)

This method is used to populate the entity with all details of EntityReference Users/Tools can send minimum details required to set relationship as id, type are the only required fields in entity reference, whereas we need to send fully populated object such that ElasticSearch index has all the details.

validateProfileSample

public static void validateProfileSample(String profileSampleType,
 double profileSampleValue)

hash

public static String hash(String input)

isDescriptionTask

public static boolean isDescriptionTask(TaskType taskType)

isTagTask

public static boolean isTagTask(TaskType taskType)

isApprovalTask

public static boolean isApprovalTask(TaskType taskType)

isTestCaseFailureResolutionTask

public static boolean isTestCaseFailureResolutionTask(TaskType taskType)

findColumn

public static Column findColumn(List<Column> columns,
 String columnName)

getFlattenedEntityField

public static <T extends FieldInterface> List<T> getFlattenedEntityField(List<T> fields)