org.opengis.metadata.distribution.Format Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gt-opengis Show documentation
Standard interfaces implemented throughout the library.
The newest version!
/*
 *    GeoTools - The Open Source Java GIS Toolkit
 *    http://geotools.org
 *
 *    (C) 2011, Open Source Geospatial Foundation (OSGeo)
 *    (C) 2004-2005, Open Geospatial Consortium Inc.
 *
 *    All Rights Reserved. http://www.opengis.org/legal/
 */
package org.opengis.metadata.distribution;

import static org.opengis.annotation.ComplianceLevel.*;
import static org.opengis.annotation.Obligation.*;
import static org.opengis.annotation.Specification.*;

import java.util.Collection;
import org.opengis.annotation.Profile;
import org.opengis.annotation.UML;
import org.opengis.util.InternationalString;

/**
 * Description of the computer language construct that specifies the representation of data objects
 * in a record, file, message, storage device or transmission channel.
 *
 * @version ISO 19115
 * @author Martin Desruisseaux (IRD)
 * @since GeoAPI 2.0
 */
@Profile(level = CORE)
@UML(identifier = "MD_Format", specification = ISO_19115)
public interface Format {
    /**
     * Name of the data transfer format(s).
     *
     * @return Name of the data transfer format(s).
     */
    @Profile(level = CORE)
    @UML(identifier = "name", obligation = MANDATORY, specification = ISO_19115)
    InternationalString getName();

    /**
     * Version of the format (date, number, etc.).
     *
     * @return Version of the format.
     */
    @Profile(level = CORE)
    @UML(identifier = "version", obligation = MANDATORY, specification = ISO_19115)
    InternationalString getVersion();

    /**
     * Amendment number of the format version.
     *
     * @return Amendment number of the format version, or {@code null}.
     */
    @UML(identifier = "amendmentNumber", obligation = OPTIONAL, specification = ISO_19115)
    InternationalString getAmendmentNumber();

    /**
     * Name of a subset, profile, or product specification of the format.
     *
     * @return Name of a subset, profile, or product specification of the format, or {@code null}.
     */
    @UML(identifier = "specification", obligation = OPTIONAL, specification = ISO_19115)
    InternationalString getSpecification();

    /**
     * Recommendations of algorithms or processes that can be applied to read or expand resources to
     * which compression techniques have been applied.
     *
     * @return Processes that can be applied to read resources to which compression techniques have
     *     been applied, or {@code null}.
     */
    @UML(
        identifier = "fileDecompressionTechnique",
        obligation = OPTIONAL,
        specification = ISO_19115
    )
    InternationalString getFileDecompressionTechnique();

    /**
     * Provides information about the distributor's format.
     *
     * @return Information about the distributor's format.
     */
    @UML(identifier = "formatDistributor", obligation = OPTIONAL, specification = ISO_19115)
    Collection getFormatDistributors();
}