001 /*
002 * GeoAPI - Java interfaces for OGC/ISO standards
003 * http://www.geoapi.org
004 *
005 * Copyright (C) 2004-2012 Open Geospatial Consortium, Inc.
006 * All Rights Reserved. http://www.opengeospatial.org/ogc/legal
007 *
008 * Permission to use, copy, and modify this software and its documentation, with
009 * or without modification, for any purpose and without fee or royalty is hereby
010 * granted, provided that you include the following on ALL copies of the software
011 * and documentation or portions thereof, including modifications, that you make:
012 *
013 * 1. The full text of this NOTICE in a location viewable to users of the
014 * redistributed or derivative work.
015 * 2. Notice of any changes or modifications to the OGC files, including the
016 * date changes were made.
017 *
018 * THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE
019 * NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
020 * TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT
021 * THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY
022 * PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
023 *
024 * COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR
025 * CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENTATION.
026 *
027 * The name and trademarks of copyright holders may NOT be used in advertising or
028 * publicity pertaining to the software without specific, written prior permission.
029 * Title to copyright in this software and any associated documentation will at all
030 * times remain with copyright holders.
031 */
032 package org.opengis.metadata.distribution;
033
034 import java.util.Collection;
035 import org.opengis.util.InternationalString;
036 import org.opengis.annotation.UML;
037 import org.opengis.annotation.Profile;
038
039 import static org.opengis.annotation.Obligation.*;
040 import static org.opengis.annotation.Specification.*;
041 import static org.opengis.annotation.ComplianceLevel.*;
042
043
044 /**
045 * Description of the computer language construct that specifies the representation
046 * of data objects in a record, file, message, storage device or transmission channel.
047 *
048 * @author Martin Desruisseaux (IRD)
049 * @version 3.0
050 * @since 2.0
051 *
052 * @navassoc - - - Distributor
053 */
054 @UML(identifier="MD_Format", specification=ISO_19115)
055 public interface Format {
056 /**
057 * Name of the data transfer format(s).
058 *
059 * @return Name of the data transfer format(s).
060 */
061 @Profile(level=CORE)
062 @UML(identifier="name", obligation=MANDATORY, specification=ISO_19115)
063 InternationalString getName();
064
065 /**
066 * Version of the format (date, number, <i>etc</i>).
067 *
068 * @return Version of the format.
069 */
070 @Profile(level=CORE)
071 @UML(identifier="version", obligation=MANDATORY, specification=ISO_19115)
072 InternationalString getVersion();
073
074 /**
075 * Amendment number of the format version.
076 *
077 * @return Amendment number of the format version, or {@code null}.
078 */
079 @UML(identifier="amendmentNumber", obligation=OPTIONAL, specification=ISO_19115)
080 InternationalString getAmendmentNumber();
081
082 /**
083 * Name of a subset, profile, or product specification of the format.
084 *
085 * @return Name of a subset, profile, or product specification of the format, or {@code null}.
086 */
087 @UML(identifier="specification", obligation=OPTIONAL, specification=ISO_19115)
088 InternationalString getSpecification();
089
090 /**
091 * Recommendations of algorithms or processes that can be applied to read or
092 * expand resources to which compression techniques have been applied.
093 *
094 * @return Processes that can be applied to read resources to which compression techniques have
095 * been applied, or {@code null}.
096 */
097 @UML(identifier="fileDecompressionTechnique", obligation=OPTIONAL, specification=ISO_19115)
098 InternationalString getFileDecompressionTechnique();
099
100 /**
101 * Provides information about the distributor's format.
102 *
103 * @return Information about the distributor's format.
104 */
105 @UML(identifier="formatDistributor", obligation=OPTIONAL, specification=ISO_19115)
106 Collection<? extends Distributor> getFormatDistributors();
107 }