/*
 * Copyright 2020 Global Biodiversity Information Facility (GBIF)
 *
 * 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.gbif.api.model.registry;

import io.swagger.v3.oas.annotations.media.Schema;

import org.gbif.api.vocabulary.TagName;

import java.io.Serializable;
import java.util.Date;
import java.util.Objects;
import java.util.StringJoiner;

import javax.validation.constraints.NotNull;
import javax.validation.constraints.Null;
import javax.validation.constraints.Size;

/**
 * A tag that has a namespace, name and a value. {@code created} and {@code createdBy} are automatically set upon
 * persisting.
 */
// TODO: Document the rules regarding duplicate names and values
@SuppressWarnings("unused")
public class MachineTag implements LenientEquals<MachineTag>, Serializable {

  private static final long serialVersionUID = 3475968899219274852L;

  @Schema(
    description = "Identifier for the machine tag.",
    accessMode = Schema.AccessMode.READ_ONLY
  )
  private Integer key;

  @Schema(
    description = "The namespace for the machine tag."
  )
  private String namespace;

  @Schema(
    description = "The name (within the namespace) of the machine tag."
  )
  private String name;

  @Schema(
    description = "The value of the machine tag."
  )
  private String value;

  @Schema(
    description = "The GBIF username of the creator of the machine tag.",
    accessMode = Schema.AccessMode.READ_ONLY
  )
  private String createdBy;

  @Schema(
    description = "Timestamp of when the machine tag was created.",
    accessMode = Schema.AccessMode.READ_ONLY
  )
  private Date created;

  public static MachineTag newInstance(String namespace, String name, String value) {
    return new MachineTag(namespace, name, value);
  }

  public static MachineTag newInstance(TagName tagName, String value) {
    return new MachineTag(tagName, value);
  }

  public MachineTag() {
    // Needed
  }

  /**
   * This is the default constructor to create new Machine Tags which takes all user settable properties.
   */
  public MachineTag(String namespace, String name, String value) {
    this.namespace = namespace;
    this.name = name;
    this.value = value;
  }

  /**
   * This is the other constructor to create new Machine Tags which takes all user settable properties.
   */
  public MachineTag(TagName tagName, String value) {
    this(tagName.getNamespace().getNamespace(), tagName.getName(), value);
  }

  @Null(groups = {PrePersist.class})
  @NotNull(groups = {PostPersist.class})
  public Integer getKey() {
    return key;
  }

  public void setKey(Integer key) {
    this.key = key;
  }

  @NotNull
  @Size(min = 1, max = 255)
  public String getNamespace() {
    return namespace;
  }

  public void setNamespace(String namespace) {
    this.namespace = namespace;
  }

  @NotNull
  @Size(min = 1, max = 255)
  public String getName() {
    return name;
  }

  public void setName(String name) {
    this.name = name;
  }

  @NotNull
  @Size(min = 1, max = 700)
  public String getValue() {
    return value;
  }

  public void setValue(String value) {
    this.value = value;
  }

  @Size(min = 3)
  public String getCreatedBy() {
    return createdBy;
  }

  public void setCreatedBy(String createdBy) {
    this.createdBy = createdBy;
  }

  @Null(groups = {PrePersist.class})
  @NotNull(groups = {PostPersist.class})
  public Date getCreated() {
    return created;
  }

  public void setCreated(Date created) {
    this.created = created;
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    MachineTag that = (MachineTag) o;
    return Objects.equals(key, that.key)
        && Objects.equals(namespace, that.namespace)
        && Objects.equals(name, that.name)
        && Objects.equals(value, that.value)
        && Objects.equals(createdBy, that.createdBy)
        && Objects.equals(created, that.created);
  }

  @Override
  public int hashCode() {
    return Objects.hash(key, namespace, name, value, createdBy, created);
  }

  @Override
  public String toString() {
    return new StringJoiner(", ", MachineTag.class.getSimpleName() + "[", "]")
        .add("key=" + key)
        .add("namespace='" + namespace + "'")
        .add("name='" + name + "'")
        .add("value='" + value + "'")
        .add("createdBy='" + createdBy + "'")
        .add("created=" + created)
        .toString();
  }

  /**
   * This implementation of the {@link #equals(Object)} method does only check <em>business equality</em> and disregards
   * automatically set and maintained fields like {@code createdBy, key} and possibly others in the future.
   */
  @Override
  public boolean lenientEquals(MachineTag other) {
    if (this == other) {
      return true;
    }

    return Objects.equals(this.namespace, other.namespace)
        && Objects.equals(this.name, other.name)
        && Objects.equals(this.value, other.value);
  }
}