org.opengis.metadata.content.ImagingCondition Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of geoapi Show documentation
Show all versions of geoapi Show documentation
The development community in building GIS solutions is sustaining an enormous level
of effort. The GeoAPI project aims to reduce duplication and increase interoperability
by providing neutral, interface-only APIs derived from OGC/ISO Standards.
/*
* GeoAPI - Java interfaces for OGC/ISO standards
* http://www.geoapi.org
*
* Copyright (C) 2004-2011 Open Geospatial Consortium, Inc.
* All Rights Reserved. http://www.opengeospatial.org/ogc/legal
*
* Permission to use, copy, and modify this software and its documentation, with
* or without modification, for any purpose and without fee or royalty is hereby
* granted, provided that you include the following on ALL copies of the software
* and documentation or portions thereof, including modifications, that you make:
*
* 1. The full text of this NOTICE in a location viewable to users of the
* redistributed or derivative work.
* 2. Notice of any changes or modifications to the OGC files, including the
* date changes were made.
*
* THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE
* NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
* TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT
* THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY
* PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
*
* COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR
* CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENTATION.
*
* The name and trademarks of copyright holders may NOT be used in advertising or
* publicity pertaining to the software without specific, written prior permission.
* Title to copyright in this software and any associated documentation will at all
* times remain with copyright holders.
*/
package org.opengis.metadata.content;
import java.util.List;
import java.util.ArrayList;
import org.opengis.util.CodeList;
import org.opengis.annotation.UML;
import static org.opengis.annotation.Obligation.*;
import static org.opengis.annotation.Specification.*;
/**
* Code which indicates conditions which may affect the image.
*
* @author Martin Desruisseaux (IRD)
* @version 3.0
* @since 2.0
*/
@UML(identifier="MD_ImagingConditionCode", specification=ISO_19115)
public final class ImagingCondition extends CodeList {
/**
* Serial number for compatibility with different versions.
*/
private static final long serialVersionUID = -1948380148063658761L;
/**
* List of all enumerations of this type.
* Must be declared before any enum declaration.
*/
private static final List VALUES = new ArrayList(11);
/**
* Portion of the image is blurred.
*/
@UML(identifier="blurredImage", obligation=CONDITIONAL, specification=ISO_19115)
public static final ImagingCondition BLURRED_IMAGE = new ImagingCondition("BLURRED_IMAGE");
/**
* Portion of the image is partially obscured by cloud cover
*/
@UML(identifier="cloud", obligation=CONDITIONAL, specification=ISO_19115)
public static final ImagingCondition CLOUD = new ImagingCondition("CLOUD");
/**
* Acute angle between the plane of the ecliptic (the plane of the Earth's orbit) and
* the plane of the celestial equator.
*/
@UML(identifier="degradingObliquity", obligation=CONDITIONAL, specification=ISO_19115)
public static final ImagingCondition DEGRADING_OBLIQUITY = new ImagingCondition("DEGRADING_OBLIQUITY");
/**
* Portion of the image is partially obscured by fog.
*/
@UML(identifier="fog", obligation=CONDITIONAL, specification=ISO_19115)
public static final ImagingCondition FOG = new ImagingCondition("FOG");
/**
* Portion of the image is partially obscured by heavy smoke or dust.
*/
@UML(identifier="heavySmokeOrDust", obligation=CONDITIONAL, specification=ISO_19115)
public static final ImagingCondition HEAVY_SMOKE_OR_DUST = new ImagingCondition("HEAVY_SMOKE_OR_DUST");
/**
* Image was taken at night.
*/
@UML(identifier="night", obligation=CONDITIONAL, specification=ISO_19115)
public static final ImagingCondition NIGHT = new ImagingCondition("NIGHT");
/**
* Image was taken during rainfall.
*/
@UML(identifier="rain", obligation=CONDITIONAL, specification=ISO_19115)
public static final ImagingCondition RAIN = new ImagingCondition("RAIN");
/**
* Image was taken during semi-dark conditions or twilight conditions.
*/
@UML(identifier="semiDarkness", obligation=CONDITIONAL, specification=ISO_19115)
public static final ImagingCondition SEMI_DARKNESS = new ImagingCondition("SEMI_DARKNESS");
/**
* Portion of the image is obscured by shadow.
*/
@UML(identifier="shadow", obligation=CONDITIONAL, specification=ISO_19115)
public static final ImagingCondition SHADOW = new ImagingCondition("SHADOW");
/**
* Portion of the image is obscured by snow.
*/
@UML(identifier="snow", obligation=CONDITIONAL, specification=ISO_19115)
public static final ImagingCondition SNOW = new ImagingCondition("SNOW");
/**
* The absence of collection data of a given point or area caused by the relative
* location of topographic features which obstruct the collection path between the
* collector(s) and the subject(s) of interest.
*/
@UML(identifier="terrainMasking", obligation=CONDITIONAL, specification=ISO_19115)
public static final ImagingCondition TERRAIN_MASKING = new ImagingCondition("TERRAIN_MASKING");
/**
* Constructs an enum with the given name. The new enum is
* automatically added to the list returned by {@link #values}.
*
* @param name The enum name. This name must not be in use by an other enum of this type.
*/
private ImagingCondition(final String name) {
super(name, VALUES);
}
/**
* Returns the list of {@code ImagingCondition}s.
*
* @return The list of codes declared in the current JVM.
*/
public static ImagingCondition[] values() {
synchronized (VALUES) {
return VALUES.toArray(new ImagingCondition[VALUES.size()]);
}
}
/**
* Returns the list of enumerations of the same kind than this enum.
*/
public ImagingCondition[] family() {
return values();
}
/**
* Returns the imaging condition that matches the given string, or returns a
* new one if none match it.
*
* @param code The name of the code to fetch or to create.
* @return A code matching the given name.
*/
public static ImagingCondition valueOf(String code) {
return valueOf(ImagingCondition.class, code);
}
}