001 /*
002 * GeoAPI - Java interfaces for OGC/ISO standards
003 * http://www.geoapi.org
004 *
005 * Copyright (C) 2004-2013 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.citation;
033
034 import java.util.Collection;
035 import java.util.Date;
036 import org.opengis.metadata.Identifier;
037 import org.opengis.util.InternationalString;
038 import org.opengis.annotation.UML;
039 import org.opengis.annotation.Profile;
040 import org.opengis.annotation.Classifier;
041 import org.opengis.annotation.Stereotype;
042
043 import static org.opengis.annotation.Obligation.*;
044 import static org.opengis.annotation.Specification.*;
045 import static org.opengis.annotation.ComplianceLevel.*;
046
047
048 /**
049 * Standardized resource reference.
050 *
051 * @author Martin Desruisseaux (IRD)
052 * @author Cory Horner (Refractions Research)
053 * @version 3.1
054 * @since 1.0
055 *
056 * @navassoc - - - CitationDate
057 * @navassoc - - - Identifier
058 * @navassoc - - - ResponsibleParty
059 * @navassoc - - - PresentationForm
060 * @navassoc 1 - - Series
061 */
062 @Classifier(Stereotype.DATATYPE)
063 @UML(identifier="CI_Citation", specification=ISO_19115)
064 public interface Citation {
065 /**
066 * Name by which the cited resource is known.
067 *
068 * @return The cited resource name.
069 */
070 @Profile(level=CORE)
071 @UML(identifier="title", obligation=MANDATORY, specification=ISO_19115)
072 InternationalString getTitle();
073
074 /**
075 * Short name or other language name by which the cited information is known.
076 * Example: "DCW" as an alternative title for "Digital Chart of the World".
077 *
078 * @return Other names for the resource, or an empty collection if none.
079 */
080 @UML(identifier="alternateTitle", obligation=OPTIONAL, specification=ISO_19115)
081 Collection<? extends InternationalString> getAlternateTitles();
082
083 /**
084 * Reference date for the cited resource.
085 *
086 * @return The reference date.
087 */
088 @Profile(level=CORE)
089 @UML(identifier="date", obligation=MANDATORY, specification=ISO_19115)
090 Collection<? extends CitationDate> getDates();
091
092 /**
093 * Version of the cited resource.
094 *
095 * @return The version, or {@code null} if none.
096 */
097 @UML(identifier="edition", obligation=OPTIONAL, specification=ISO_19115)
098 InternationalString getEdition();
099
100 /**
101 * Date of the edition, or {@code null} if none.
102 * <p>
103 * <TABLE WIDTH="80%" ALIGN="center" CELLPADDING="18" BORDER="4" BGCOLOR="#FFE0B0">
104 * <TR><TD>
105 * <P align="justify"><B>Warning:</B> The return type of this method may change
106 * in GeoAPI 3.1 release. It may be replaced by a type matching more closely
107 * either ISO 19108 (<cite>Temporal Schema</cite>) or ISO 19103.</P>
108 * </TD></TR>
109 * </TABLE>
110 *
111 * @return The edition date, or {@code null} if none.
112 */
113 @UML(identifier="editionDate", obligation=OPTIONAL, specification=ISO_19115)
114 Date getEditionDate();
115
116 /**
117 * Unique identifier for the resource. Example: Universal Product Code (UPC),
118 * National Stock Number (NSN).
119 *
120 * @return The identifiers, or an empty collection if none.
121 */
122 @UML(identifier="identifier", obligation=OPTIONAL, specification=ISO_19115)
123 Collection<? extends Identifier> getIdentifiers();
124
125 /**
126 * Name and position information for an individual or organization that is responsible
127 * for the resource. Returns an empty collection if there is none.
128 *
129 * @return The individual or organization that is responsible, or an empty collection if none.
130 */
131 @UML(identifier="citedResponsibleParty", obligation=OPTIONAL, specification=ISO_19115)
132 Collection<? extends ResponsibleParty> getCitedResponsibleParties();
133
134 /**
135 * Mode in which the resource is represented, or an empty collection if none.
136 *
137 * @return The presentation mode, or an empty collection if none.
138 */
139 @UML(identifier="presentationForm", obligation=OPTIONAL, specification=ISO_19115)
140 Collection<PresentationForm> getPresentationForms();
141
142 /**
143 * Information about the series, or aggregate dataset, of which the dataset is a part.
144 * Returns {@code null} if none.
145 *
146 * @return The series of which the dataset is a part, or {@code null} if none.
147 */
148 @UML(identifier="series", obligation=OPTIONAL, specification=ISO_19115)
149 Series getSeries();
150
151 /**
152 * Other information required to complete the citation that is not recorded elsewhere.
153 * Returns {@code null} if none.
154 *
155 * @return Other details, or {@code null} if none.
156 */
157 @UML(identifier="otherCitationDetails", obligation=OPTIONAL, specification=ISO_19115)
158 InternationalString getOtherCitationDetails();
159
160 /**
161 * Common title with holdings note. Note: title identifies elements of a series
162 * collectively, combined with information about what volumes are available at the
163 * source cited. Returns {@code null} if there is no title.
164 *
165 * @return The common title, or {@code null} if none.
166 */
167 @UML(identifier="collectiveTitle", obligation=OPTIONAL, specification=ISO_19115)
168 InternationalString getCollectiveTitle();
169
170 /**
171 * International Standard Book Number, or {@code null} if none.
172 *
173 * @return The ISBN, or {@code null} if none.
174 */
175 @UML(identifier="ISBN", obligation=OPTIONAL, specification=ISO_19115)
176 String getISBN();
177
178 /**
179 * International Standard Serial Number, or {@code null} if none.
180 *
181 * @return The ISSN, or {@code null} if none.
182 */
183 @UML(identifier="ISSN", obligation=OPTIONAL, specification=ISO_19115)
184 String getISSN();
185 }