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.constraint;
033
034 import java.util.List;
035 import java.util.ArrayList;
036
037 import org.opengis.util.CodeList;
038 import org.opengis.annotation.UML;
039
040 import static org.opengis.annotation.Obligation.*;
041 import static org.opengis.annotation.Specification.*;
042
043
044 /**
045 * Limitation(s) placed upon the access or use of the data.
046 *
047 * @author Martin Desruisseaux (IRD)
048 * @version 3.0
049 * @since 2.0
050 */
051 @UML(identifier="MD_RestrictionCode", specification=ISO_19115)
052 public final class Restriction extends CodeList<Restriction> {
053 /**
054 * Serial number for compatibility with different versions.
055 */
056 private static final long serialVersionUID = 7949159742645339894L;
057
058 /**
059 * List of all enumerations of this type.
060 * Must be declared before any enum declaration.
061 */
062 private static final List<Restriction> VALUES = new ArrayList<Restriction>(8);
063
064 /**
065 * Exclusive right to the publication, production, or sale of the rights to a literary,
066 * dramatic, musical, or artistic work, or to the use of a commercial print or label,
067 * granted by law for a specified period of time to an author, composer, artist, distributor.
068 */
069 @UML(identifier="copyright", obligation=CONDITIONAL, specification=ISO_19115)
070 public static final Restriction COPYRIGHT = new Restriction("COPYRIGHT");
071
072 /**
073 * Government has granted exclusive right to make, sell, use or license an invention
074 * or discovery.
075 */
076 @UML(identifier="patent", obligation=CONDITIONAL, specification=ISO_19115)
077 public static final Restriction PATENT = new Restriction("PATENT");
078
079 /**
080 * Produced or sold information awaiting a patent.
081 */
082 @UML(identifier="patentPending", obligation=CONDITIONAL, specification=ISO_19115)
083 public static final Restriction PATENT_PENDING = new Restriction("PATENT_PENDING");
084
085 /**
086 * A name, symbol, or other device identifying a product, officially registered and
087 * legally restricted to the use of the owner or manufacturer.
088 */
089 @UML(identifier="trademark", obligation=CONDITIONAL, specification=ISO_19115)
090 public static final Restriction TRADEMARK = new Restriction("TRADEMARK");
091
092 /**
093 * Formal permission to do something.
094 */
095 @UML(identifier="license", obligation=CONDITIONAL, specification=ISO_19115)
096 public static final Restriction LICENSE = new Restriction("LICENSE");
097
098 /**
099 * Rights to financial benefit from and control of distribution of non-tangible property
100 * that is a result of creativity.
101 */
102 @UML(identifier="intellectualPropertyRights", obligation=CONDITIONAL, specification=ISO_19115)
103 public static final Restriction INTELLECTUAL_PROPERTY_RIGHTS = new Restriction("INTELLECTUAL_PROPERTY_RIGHTS");
104
105 /**
106 * Withheld from general circulation or disclosure.
107 */
108 @UML(identifier="restricted", obligation=CONDITIONAL, specification=ISO_19115)
109 public static final Restriction RESTRICTED = new Restriction("RESTRICTED");
110
111 /**
112 * Limitation not listed.
113 */
114 @UML(identifier="otherRestrictions", obligation=CONDITIONAL, specification=ISO_19115)
115 public static final Restriction OTHER_RESTRICTIONS = new Restriction("OTHER_RESTRICTIONS");
116
117 /**
118 * Constructs an element of the given name. The new element is
119 * automatically added to the list returned by {@link #values()}.
120 *
121 * @param name The name of the new element.
122 * This name must not be in use by an other element of this type.
123 */
124 private Restriction(final String name) {
125 super(name, VALUES);
126 }
127
128 /**
129 * Returns the list of {@code Restriction}s.
130 *
131 * @return The list of codes declared in the current JVM.
132 */
133 public static Restriction[] values() {
134 synchronized (VALUES) {
135 return VALUES.toArray(new Restriction[VALUES.size()]);
136 }
137 }
138
139 /**
140 * Returns the list of codes of the same kind than this code list element.
141 * Invoking this method is equivalent to invoking {@link #values()}, except that
142 * this method can be invoked on an instance of the parent {@code CodeList} class.
143 */
144 @Override
145 public Restriction[] family() {
146 return values();
147 }
148
149 /**
150 * Returns the restriction that matches the given string, or returns a
151 * new one if none match it. More specifically, this methods returns the first instance for
152 * which <code>{@linkplain #name() name()}.{@linkplain String#equals equals}(code)</code>
153 * returns {@code true}. If no existing instance is found, then a new one is created for
154 * the given name.
155 *
156 * @param code The name of the code to fetch or to create.
157 * @return A code matching the given name.
158 */
159 public static Restriction valueOf(String code) {
160 return valueOf(Restriction.class, code);
161 }
162 }