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 javax.measure.unit.Unit;
036 import org.opengis.util.InternationalString;
037 import org.opengis.annotation.UML;
038
039 import static org.opengis.annotation.Obligation.*;
040 import static org.opengis.annotation.Specification.*;
041
042
043 /**
044 * Information about the media on which the resource can be distributed.
045 *
046 * @author Martin Desruisseaux (IRD)
047 * @version 3.0
048 * @since 2.0
049 *
050 * @navassoc 1 - - MediumName
051 * @navassoc - - - MediumFormat
052 */
053 @UML(identifier="MD_Medium", specification=ISO_19115)
054 public interface Medium {
055 /**
056 * Name of the medium on which the resource can be received.
057 *
058 * @return Name of the medium, or {@code null}.
059 */
060 @UML(identifier="name", obligation=OPTIONAL, specification=ISO_19115)
061 MediumName getName();
062
063 /**
064 * Density at which the data is recorded.
065 * The numbers shall be greater than zero.
066 *
067 * @return Density at which the data is recorded, or {@code null}.
068 */
069 @UML(identifier="density", obligation=OPTIONAL, specification=ISO_19115)
070 Collection<Double> getDensities();
071
072 /**
073 * Units of measure for the recording density.
074 *
075 * @return Units of measure for the recording density, or {@code null}.
076 *
077 * @condition {@link #getDensities()} must be documented.
078 */
079 @UML(identifier="densityUnits", obligation=CONDITIONAL, specification=ISO_19115)
080 Unit<?> getDensityUnits();
081
082 /**
083 * Number of items in the media identified.
084 * Returns {@code null} if unknown.
085 *
086 * @return Number of items in the media identified, or {@code null}.
087 */
088 @UML(identifier="volumes", obligation=OPTIONAL, specification=ISO_19115)
089 Integer getVolumes();
090
091 /**
092 * Method used to write to the medium.
093 *
094 * @return Method used to write to the medium, or {@code null}.
095 */
096 @UML(identifier="mediumFormat", obligation=OPTIONAL, specification=ISO_19115)
097 Collection<MediumFormat> getMediumFormats();
098
099 /**
100 * Description of other limitations or requirements for using the medium.
101 *
102 * @return Description of other limitations for using the medium, or {@code null}.
103 */
104 @UML(identifier="mediumNote", obligation=OPTIONAL, specification=ISO_19115)
105 InternationalString getMediumNote();
106 }