Feature.java

/*
 * Copyright 2018-2022 the original author or authors.
 *
 * 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.bremersee.geojson.model;

import static io.swagger.v3.oas.annotations.media.Schema.RequiredMode.REQUIRED;
import static org.bremersee.geojson.GeoJsonConstants.BBOX;
import static org.bremersee.geojson.GeoJsonConstants.FEATURE;
import static org.bremersee.geojson.GeoJsonConstants.GEOMETRY;
import static org.bremersee.geojson.GeoJsonConstants.ID;
import static org.bremersee.geojson.GeoJsonConstants.PROPERTIES;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonValue;
import io.swagger.v3.oas.annotations.media.Schema;
import java.io.Serial;
import java.io.Serializable;
import lombok.Builder;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
import lombok.ToString;
import org.bremersee.geojson.GeoJsonConstants;

/**
 * A Feature object represents a spatially bounded thing.
 *
 * @author Christian Bremer
 */
@Schema(description = "A Feature object represents a spatially bounded thing.")
@JsonIgnoreProperties(ignoreUnknown = true)
@Getter
@EqualsAndHashCode
@ToString
@NoArgsConstructor
public class Feature implements Serializable {

  @Serial
  private static final long serialVersionUID = 2L;

  /**
   * The geo json type.
   */
  @Schema(description = "The feature type, must be 'Feature'.", requiredMode = REQUIRED)
  @JsonProperty(value = FEATURE, required = true)
  private TypeEnum type = TypeEnum.FEATURE;

  /**
   * The identifier of this feature.
   */
  @Setter
  @Schema(description = "The identifier of this feature.")
  @JsonProperty(ID)
  private String id = null;

  /**
   * The bounding box.
   */
  @Setter
  @Schema(description = "The bounding box.")
  @JsonProperty(BBOX)
  private BoundingBox bbox = null;

  /**
   * The geometry.
   */
  @Setter
  @Schema(description = "The geometry.")
  @JsonProperty(GEOMETRY)
  private Geometry geometry = null;

  /**
   * The feature properties.
   */
  @Setter
  @Schema(description = "The feature properties.")
  @JsonProperty(PROPERTIES)
  private Object properties = null;

  /**
   * Instantiates a new feature.
   *
   * @param id the id
   * @param bbox the bbox
   * @param geometry the geometry
   * @param properties the properties
   */
  @Builder(toBuilder = true)
  public Feature(
      String id,
      BoundingBox bbox,
      Geometry geometry,
      Object properties) {

    setId(id);
    setBbox(bbox);
    setGeometry(geometry);
    setProperties(properties);
  }

  /**
   * The feature type.
   */
  public enum TypeEnum {
    /**
     * Feature type enum.
     */
    FEATURE(GeoJsonConstants.FEATURE);

    private final String value;

    TypeEnum(String value) {
      this.value = value;
    }

    @Override
    @JsonValue
    public String toString() {
      return value;
    }

    /**
     * From value.
     *
     * @param value the value
     * @return the type enum
     */
    @JsonCreator
    public static TypeEnum fromValue(String value) {
      if (GeoJsonConstants.FEATURE.equals(value)) {
        return FEATURE;
      }
      throw new IllegalArgumentException(String
          .format("Value '%s' must be '%s'.", value, GeoJsonConstants.FEATURE));
    }

  }

}