org.geotoolkit.metadata.iso.identification.DefaultDataIdentification Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of geotk-metadata Show documentation
Show all versions of geotk-metadata Show documentation
Implementations of metadata derived from ISO 19115. This module provides both an implementation
of the metadata interfaces defined in GeoAPI, and a framework for handling those metadata through
Java reflection.
/*
* Geotoolkit.org - An Open Source Java GIS Toolkit
* http://www.geotoolkit.org
*
* (C) 2004-2011, Open Source Geospatial Foundation (OSGeo)
* (C) 2009-2011, Geomatys
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation;
* version 2.1 of the License.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* This package contains documentation from OpenGIS specifications.
* OpenGIS consortium's work is fully acknowledged here.
*/
package org.geotoolkit.metadata.iso.identification;
import java.util.Collection;
import java.util.Locale;
import javax.xml.bind.annotation.XmlType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import net.jcip.annotations.ThreadSafe;
import org.opengis.metadata.extent.Extent;
import org.opengis.metadata.citation.Citation;
import org.opengis.metadata.identification.Resolution;
import org.opengis.metadata.identification.CharacterSet;
import org.opengis.metadata.identification.TopicCategory;
import org.opengis.metadata.identification.DataIdentification;
import org.opengis.metadata.spatial.SpatialRepresentationType;
import org.opengis.util.InternationalString;
/**
* Information required to identify a dataset.
*
* @author Martin Desruisseaux (IRD, Geomatys)
* @author Touraïvane (IRD)
* @author Cédric Briançon (Geomatys)
* @version 3.18
*
* @since 2.1
* @module
*/
@ThreadSafe
@XmlType(name = "MD_DataIdentification_Type", propOrder={
"spatialRepresentationTypes",
"spatialResolutions",
"languages",
"characterSets",
"topicCategories",
"environmentDescription",
"extents",
"supplementalInformation"
})
@XmlRootElement(name = "MD_DataIdentification")
public class DefaultDataIdentification extends AbstractIdentification implements DataIdentification {
/**
* Serial number for compatibility with different versions.
*/
private static final long serialVersionUID = 2099051218533426785L;
/**
* Method used to spatially represent geographic information.
*/
private Collection spatialRepresentationTypes;
/**
* Factor which provides a general understanding of the density of spatial data
* in the dataset.
*/
private Collection spatialResolutions;
/**
* Language(s) used within the dataset.
*/
private Collection languages;
/**
* Full name of the character coding standard used for the dataset.
*/
private Collection characterSets;
/**
* Main theme(s) of the datset.
*/
private Collection topicCategories;
/**
* Description of the dataset in the producers processing environment, including items
* such as the software, the computer operating system, file name, and the dataset size
*/
private InternationalString environmentDescription;
/**
* Additional extent information including the bounding polygon, vertical, and temporal
* extent of the dataset.
*/
private Collection extents;
/**
* Any other descriptive information about the dataset.
*/
private InternationalString supplementalInformation;
/**
* Constructs an initially empty data identification.
*/
public DefaultDataIdentification() {
}
/**
* Constructs a metadata entity initialized with the values from the specified metadata.
*
* @param source The metadata to copy, or {@code null} if none.
*
* @since 2.4
*/
public DefaultDataIdentification(final DataIdentification source) {
super(source);
}
/**
* Creates a data identification initialized to the specified values.
*
* @param citation The citation data for the resource(s).
* @param abstracts A brief narrative summary of the content of the resource(s).
* @param language The language(s) used within the dataset.
* @param topicCategories The main theme(s) of the dataset.
*/
public DefaultDataIdentification(final Citation citation,
final InternationalString abstracts,
final Collection language,
final Collection topicCategories)
{
super(citation, abstracts);
setLanguages(language);
setTopicCategories(topicCategories);
}
/**
* Returns a Geotk metadata implementation with the same values than the given arbitrary
* implementation. If the given object is {@code null}, then this method returns {@code null}.
* Otherwise if the given object is already a Geotk implementation, then the given object is
* returned unchanged. Otherwise a new Geotk implementation is created and initialized to the
* attribute values of the given object, using a shallow copy operation
* (i.e. attributes are not cloned).
*
* @param object The object to wrap in a Geotk implementation, or {@code null} if none.
* @return A Geotk implementation containing the values of the given object (may be the
* given object itself), or {@code null} if the argument was null.
*
* @since 3.18
*/
public static DefaultDataIdentification wrap(final DataIdentification object) {
return (object == null) || (object instanceof DefaultDataIdentification)
? (DefaultDataIdentification) object : new DefaultDataIdentification(object);
}
/**
* Returns the method used to spatially represent geographic information.
*/
@Override
@XmlElement(name = "spatialRepresentationType")
public synchronized Collection getSpatialRepresentationTypes() {
return xmlOptional(spatialRepresentationTypes = nonNullCollection(spatialRepresentationTypes,
SpatialRepresentationType.class));
}
/**
* Sets the method used to spatially represent geographic information.
*
* @param newValues The new spatial representation types.
*/
public synchronized void setSpatialRepresentationTypes(
final Collection newValues)
{
spatialRepresentationTypes = copyCollection(newValues, spatialRepresentationTypes,
SpatialRepresentationType.class);
}
/**
* Returns the factor which provides a general understanding of the density of spatial data
* in the dataset.
*/
@Override
@XmlElement(name = "spatialResolution")
public synchronized Collection getSpatialResolutions() {
return xmlOptional(spatialResolutions = nonNullCollection(spatialResolutions, Resolution.class));
}
/**
* Sets the factor which provides a general understanding of the density of spatial data
* in the dataset.
*
* @param newValues The new spatial resolutions.
*/
public synchronized void setSpatialResolutions(final Collection newValues) {
spatialResolutions = copyCollection(newValues, spatialResolutions, Resolution.class);
}
/**
* Returns the language(s) used within the dataset.
*/
@Override
@XmlElement(name = "language", required = true)
public synchronized Collection getLanguages() {
return languages = nonNullCollection(languages, Locale.class);
}
/**
* Sets the language(s) used within the dataset.
*
* @param newValues The new languages.
*/
public synchronized void setLanguages(final Collection newValues) {
languages = copyCollection(newValues, languages, Locale.class);
}
/**
* Returns the full name of the character coding standard used for the dataset.
*/
@Override
@XmlElement(name = "characterSet")
public synchronized Collection getCharacterSets() {
return xmlOptional(characterSets = nonNullCollection(characterSets, CharacterSet.class));
}
/**
* Sets the full name of the character coding standard used for the dataset.
*
* @param newValues The new character sets.
*/
public synchronized void setCharacterSets(final Collection newValues) {
characterSets = copyCollection(newValues, characterSets, CharacterSet.class);
}
/**
* Returns the main theme(s) of the dataset.
*/
@Override
@XmlElement(name = "topicCategory")
public synchronized Collection getTopicCategories() {
return xmlOptional(topicCategories = nonNullCollection(topicCategories, TopicCategory.class));
}
/**
* Sets the main theme(s) of the dataset.
*
* @param newValues The new topic categories.
*/
public synchronized void setTopicCategories(final Collection newValues) {
topicCategories = copyCollection(newValues, topicCategories, TopicCategory.class);
}
/**
* Returns a description of the dataset in the producer's processing environment. This includes
* items such as the software, the computer operating system, file name, and the dataset size.
*/
@Override
@XmlElement(name = "environmentDescription")
public synchronized InternationalString getEnvironmentDescription() {
return environmentDescription;
}
/**
* Sets the description of the dataset in the producers processing environment.
*
* @param newValue The new environment description.
*/
public synchronized void setEnvironmentDescription(final InternationalString newValue) {
checkWritePermission();
environmentDescription = newValue;
}
/**
* Returns additional extent information including the bounding polygon, vertical, and temporal
* extent of the dataset.
*/
@Override
@XmlElement(name = "extent")
public synchronized Collection getExtents() {
return xmlOptional(extents = nonNullCollection(extents, Extent.class));
}
/**
* Sets additional extent information.
*
* @param newValues The new extents
*/
public synchronized void setExtents(final Collection newValues) {
extents = copyCollection(newValues, extents, Extent.class);
}
/**
* Any other descriptive information about the dataset.
*/
@Override
@XmlElement(name = "supplementalInformation")
public synchronized InternationalString getSupplementalInformation() {
return supplementalInformation;
}
/**
* Sets any other descriptive information about the dataset.
*
* @param newValue The new supplemental information.
*/
public synchronized void setSupplementalInformation(final InternationalString newValue) {
checkWritePermission();
supplementalInformation = newValue;
}
}