org.openmetadata.schema.EntityInterface Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openmetadata-spec Show documentation
There is a newer version: 1.6.0-rc1
/*
 *  Copyright 2021 Collate
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *  http://www.apache.org/licenses/LICENSE-2.0
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */

package org.openmetadata.schema;

import com.fasterxml.jackson.annotation.JsonIgnore;
import java.net.URI;
import java.util.HashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.UUID;
import org.openmetadata.common.utils.CommonUtil;
import org.openmetadata.schema.entity.type.Style;
import org.openmetadata.schema.type.*;
import org.openmetadata.schema.utils.EntityInterfaceUtil;

/** Interface to be implemented by all entities to provide a way to access all the common fields. */
@SuppressWarnings("unused")
public interface EntityInterface {
  // Lower case entity name to canonical entity name map
  Map CANONICAL_ENTITY_NAME_MAP = new HashMap<>();
  Map> ENTITY_TYPE_TO_CLASS_MAP = new HashMap<>();

  UUID getId();

  String getDescription();

  String getDisplayName();

  String getName();

  default Boolean getDeleted() {
    return null;
  }

  Double getVersion();

  String getUpdatedBy();

  Long getUpdatedAt();

  URI getHref();

  ChangeDescription getChangeDescription();

  default List getOwners() {
    return null;
  }

  default List getTags() {
    return null;
  }

  default ProviderType getProvider() {
    return null;
  }

  default List getFollowers() {
    return null;
  }

  default Votes getVotes() {
    return null;
  }

  String getFullyQualifiedName();

  default Object getExtension() {
    return null;
  }

  default List getChildren() {
    return null;
  }

  default List getReviewers() {
    return null;
  }

  default List getExperts() {
    return null;
  }

  default EntityReference getDomain() {
    return null;
  }

  default List getDataProducts() {
    return null;
  }

  default Style getStyle() {
    return null;
  }

  default LifeCycle getLifeCycle() {
    return null;
  }

  void setId(UUID id);

  void setDescription(String description);

  void setDisplayName(String displayName);

  void setName(String name);

  void setVersion(Double newVersion);

  void setChangeDescription(ChangeDescription changeDescription);

  void setFullyQualifiedName(String fullyQualifiedName);

  default void setDeleted(Boolean flag) {}

  void setUpdatedBy(String admin);

  void setUpdatedAt(Long updatedAt);

  void setHref(URI href);

  default void setTags(List tags) {
    /* no-op implementation to be overridden */
  }

  default void setOwners(List owners) {
    /* no-op implementation to be overridden */
  }

  default void setExtension(Object extension) {
    /* no-op implementation to be overridden */
  }

  default void setChildren(List entityReference) {
    /* no-op implementation to be overridden */
  }

  default void setReviewers(List entityReference) {
    /* no-op implementation to be overridden */
  }

  default void setExperts(List entityReference) {
    /* no-op implementation to be overridden */
  }

  default void setDomain(EntityReference entityReference) {
    /* no-op implementation to be overridden */
  }

  default void setDataProducts(List dataProducts) {
    /* no-op implementation to be overridden */
  }

  default void setFollowers(List followers) {
    /* no-op implementation to be overridden */
  }

  default void setVotes(Votes vote) {
    /* no-op implementation to be overridden */
  }

  default void setStyle(Style style) {
    /* no-op implementation to be overridden */
  }

  default void setLifeCycle(LifeCycle lifeCycle) {
    /* no-op implementation to be overridden */
  }

   T withHref(URI href);

  @JsonIgnore
  default EntityReference getEntityReference() {
    return new EntityReference()
        .withId(getId())
        .withName(getName())
        .withFullyQualifiedName(
            getFullyQualifiedName() == null
                ? EntityInterfaceUtil.quoteName(getName())
                : getFullyQualifiedName())
        .withDescription(getDescription())
        .withDisplayName(CommonUtil.nullOrEmpty(getDisplayName()) ? getName() : getDisplayName())
        .withType(
            CANONICAL_ENTITY_NAME_MAP.get(this.getClass().getSimpleName().toLowerCase(Locale.ROOT)))
        .withDeleted(getDeleted())
        .withHref(getHref());
  }
}