org.opengis.metadata.ExtendedElementInformation 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;
import java.util.Collection;
import org.opengis.util.InternationalString;
import org.opengis.metadata.citation.ResponsibleParty;
import org.opengis.annotation.UML;
import static org.opengis.annotation.Obligation.*;
import static org.opengis.annotation.Specification.*;
/**
* New metadata element, not found in ISO 19115, which is required to describe geographic data.
*
* @author Martin Desruisseaux (IRD)
* @version 3.0
* @since 2.0
*
* @navassoc 1 - - Obligation
* @navassoc 1 - - Datatype
* @navassoc - - - ResponsibleParty
*/
@UML(identifier="MD_ExtendedElementInformation", specification=ISO_19115)
public interface ExtendedElementInformation {
/**
* Name of the extended metadata element.
*
* @return Name of the extended metadata element.
*/
@UML(identifier="name", obligation=MANDATORY, specification=ISO_19115)
String getName();
/**
* Short form suitable for use in an implementation method such as XML or SGML.
* Returns {@code null} if the {@linkplain #getDataType data type}
* is {@linkplain Datatype#CODE_LIST_ELEMENT code list element}, in which case
* {@link #getDomainCode()} may be used instead.
*
* @return Short form suitable for use in an implementation method such as XML or SGML,
* or {@code null}.
*
* @condition {@linkplain #getDataType Data type} not equal
* {@link Datatype#CODE_LIST_ELEMENT CODE_LIST_ELEMENT}.
*/
@UML(identifier="shortName", obligation=CONDITIONAL, specification=ISO_19115)
String getShortName();
/**
* Three digit code assigned to the extended element.
* Returns a non-null value only if the {@linkplain #getDataType data type}
* is {@linkplain Datatype#CODE_LIST_ELEMENT code list element}, in which case
* {@link #getShortName()} may be used instead.
*
* @return Three digit code assigned to the extended element, or {@code null}.
*
* @condition {@linkplain #getDataType Data type} not equal
* {@link Datatype#CODE_LIST_ELEMENT CODE_LIST_ELEMENT}.
*/
@UML(identifier="domainCode", obligation=CONDITIONAL, specification=ISO_19115)
Integer getDomainCode();
/**
* Definition of the extended element.
*
* @return Definition of the extended element.
*/
@UML(identifier="definition", obligation=MANDATORY, specification=ISO_19115)
InternationalString getDefinition();
/**
* Obligation of the extended element.
*
* @return Obligation of the extended element, or {@code null}.
*
* @condition {@linkplain #getDataType Data type} not equal
* {@link Datatype#CODE_LIST CODE_LIST} or
* {@link Datatype#ENUMERATION ENUMERATION} or
* {@link Datatype#CODE_LIST_ELEMENT CODE_LIST_ELEMENT}.
*/
@UML(identifier="obligation", obligation=CONDITIONAL, specification=ISO_19115)
Obligation getObligation();
/**
* Condition under which the extended element is mandatory.
* Returns a non-null value only if the {@linkplain #getObligation obligation}
* is {@linkplain Obligation#CONDITIONAL conditional}.
*
* @return The condition under which the extended element is mandatory, or {@code null}.
*
* @condition {@linkplain #getObligation Obligation} equals
* {@link Obligation#CONDITIONAL CONDITIONAL}.
*/
@UML(identifier="condition", obligation=CONDITIONAL, specification=ISO_19115)
InternationalString getCondition();
/**
* Code which identifies the kind of value provided in the extended element.
*
* @return The kind of value provided in the extended element.
*/
@UML(identifier="dataType", obligation=MANDATORY, specification=ISO_19115)
Datatype getDataType();
/**
* Maximum occurrence of the extended element.
* Returns {@code null} if it doesn't apply, for example if the
* {@linkplain #getDataType data type} is {@linkplain Datatype#ENUMERATION enumeration},
* {@linkplain Datatype#CODE_LIST code list} or {@linkplain Datatype#CODE_LIST_ELEMENT
* code list element}.
*
* @return Maximum occurrence of the extended element, or {@code null}.
*/
@UML(identifier="maximumOccurrence", obligation=CONDITIONAL, specification=ISO_19115)
Integer getMaximumOccurrence();
/**
* Valid values that can be assigned to the extended element.
* Returns {@code null} if it doesn't apply, for example if the
* {@linkplain #getDataType data type} is {@linkplain Datatype#ENUMERATION enumeration},
* {@linkplain Datatype#CODE_LIST code list} or {@linkplain Datatype#CODE_LIST_ELEMENT
* code list element}.
*
* @return Valid values that can be assigned to the extended element, or {@code null}.
*
* @condition {@linkplain #getDataType Data type} not {@link Datatype#ENUMERATION ENUMERATION},
* {@link Datatype#CODE_LIST CODE_LIST} or {@link Datatype#CODE_LIST_ELEMENT
* CODE_LIST_ELEMENT}.
*/
@UML(identifier="domainValue", obligation=CONDITIONAL, specification=ISO_19115)
InternationalString getDomainValue();
/**
* Name of the metadata entity(s) under which this extended metadata element may appear.
* The name(s) may be standard metadata element(s) or other extended metadata element(s).
*
* @return Name of the metadata entity(s) under which this extended metadata element may appear.
*/
@UML(identifier="parentEntity", obligation=MANDATORY, specification=ISO_19115)
Collection getParentEntity();
/**
* Specifies how the extended element relates to other existing elements and entities.
*
* @return How the extended element relates to other existing elements and entities.
*/
@UML(identifier="rule", obligation=MANDATORY, specification=ISO_19115)
InternationalString getRule();
/**
* Reason for creating the extended element.
*
* @return Reason for creating the extended element.
*/
@UML(identifier="rationale", obligation=OPTIONAL, specification=ISO_19115)
Collection getRationales();
/**
* Name of the person or organization creating the extended element.
*
* @return Name of the person or organization creating the extended element.
*/
@UML(identifier="source", obligation=MANDATORY, specification=ISO_19115)
Collection getSources();
}