001/*
002 * Copyright 2014 Global Biodiversity Information Facility (GBIF)
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.gbif.api.model.registry.eml.temporal;
017import org.gbif.api.model.registry.eml.Keywords;
018import org.gbif.api.util.formatter.TemporalCoverageFormatterVisitor;
019
020import org.codehaus.jackson.annotate.JsonSubTypes;
021import org.codehaus.jackson.annotate.JsonTypeInfo;
022
023/**
024 * The base of all types of temporal coverages.
025 */
026@JsonTypeInfo(
027  use = JsonTypeInfo.Id.NAME,
028  include = JsonTypeInfo.As.PROPERTY,
029  property = "@type"
030)
031@JsonSubTypes({
032  @JsonSubTypes.Type(value = DateRange.class, name = "range"),
033  @JsonSubTypes.Type(value = SingleDate.class, name = "single"),
034  @JsonSubTypes.Type(value = VerbatimTimePeriod.class, name = "verbatim")
035})
036public abstract class TemporalCoverage implements Keywords {
037
038  /**
039   * Accept a TemporalCoverageFormatterVisitor for formatting purpose.
040   * The concrete class should simply returns formatter.format(this);
041   *
042   * @param formatter
043   * @return
044   */
045  public abstract String acceptFormatter(TemporalCoverageFormatterVisitor formatter);
046
047}