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