org.geotoolkit.metadata.iso.identification.DefaultBrowseGraphic 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.net.URI;
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.util.InternationalString;
import org.opengis.metadata.identification.BrowseGraphic;
import org.geotoolkit.metadata.iso.MetadataEntity;
/**
* Graphic that provides an illustration of the dataset (should include a legend for the graphic).
*
* @author Martin Desruisseaux (IRD, Geomatys)
* @author Touraïvane (IRD)
* @author Cédric Briançon (Geomatys)
* @version 3.19
*
* @since 2.1
* @module
*/
@ThreadSafe
@XmlType(name = "MD_BrowseGraphic_Type", propOrder={
"fileName",
"fileDescription",
"fileType"
})
@XmlRootElement(name = "MD_BrowseGraphic")
public class DefaultBrowseGraphic extends MetadataEntity implements BrowseGraphic {
/**
* Serial number for compatibility with different versions.
*/
private static final long serialVersionUID = 1715873406472953616L;
/**
* Name of the file that contains a graphic that provides an illustration of the dataset.
*/
private URI fileName;
/**
* Text description of the illustration.
*/
private InternationalString fileDescription;
/**
* Format in which the illustration is encoded.
* Examples: CGM, EPS, GIF, JPEG, PBM, PS, TIFF, XWD.
*/
private String fileType;
/**
* Constructs an initially empty browse graphic.
*/
public DefaultBrowseGraphic() {
}
/**
* 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 DefaultBrowseGraphic(final BrowseGraphic source) {
super(source);
}
/**
* Creates a browse graphics initialized to the specified URI.
*
* @param fileName The name of the file that contains a graphic.
*/
public DefaultBrowseGraphic(final URI fileName) {
setFileName(fileName);
}
/**
* 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 get as 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 DefaultBrowseGraphic castOrCopy(final BrowseGraphic object) {
return (object == null) || (object instanceof DefaultBrowseGraphic)
? (DefaultBrowseGraphic) object : new DefaultBrowseGraphic(object);
}
/**
* @deprecated Renamed {@link #castOrCopy castOrCopy}.
* @param object The object to get as a Geotk implementation, or {@code null} if none.
* @return The given object as a Geotk implementation.
*/
@Deprecated
public static DefaultBrowseGraphic wrap(final BrowseGraphic object) {
return castOrCopy(object);
}
/**
* Returns the name of the file that contains a graphic that provides an illustration of the dataset.
*/
@Override
@XmlElement(name = "fileName", required = true)
public synchronized URI getFileName() {
return fileName;
}
/**
* Sets the name of the file that contains a graphic that provides an illustration of the
* dataset.
*
* @param newValue The new filename.
*/
public synchronized void setFileName(final URI newValue) {
checkWritePermission();
fileName = newValue;
}
/**
* Returns the text description of the illustration.
*/
@Override
@XmlElement(name = "fileDescription")
public synchronized InternationalString getFileDescription() {
return fileDescription;
}
/**
* Sets the text description of the illustration.
*
* @param newValue The new file description.
*/
public synchronized void setFileDescription(final InternationalString newValue) {
checkWritePermission();
fileDescription = newValue;
}
/**
* Format in which the illustration is encoded.
* Examples: CGM, EPS, GIF, JPEG, PBM, PS, TIFF, XWD.
*/
@Override
@XmlElement(name = "fileType")
public synchronized String getFileType() {
return fileType;
}
/**
* Sets the format in which the illustration is encoded.
*
* @param newValue The new fime type.
*/
public synchronized void setFileType(final String newValue) {
checkWritePermission();
fileType = newValue;
}
}