org.geotoolkit.metadata.iso.constraint.DefaultSecurityConstraints 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.constraint;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;
import net.jcip.annotations.ThreadSafe;
import org.opengis.util.InternationalString;
import org.opengis.metadata.constraint.Classification;
import org.opengis.metadata.constraint.SecurityConstraints;
/**
* Handling restrictions imposed on the resource for national security or similar security concerns.
*
* @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_SecurityConstraints_Type", propOrder={
"classification",
"userNote",
"classificationSystem",
"handlingDescription"
})
@XmlRootElement(name = "MD_SecurityConstraints")
public class DefaultSecurityConstraints extends DefaultConstraints implements SecurityConstraints {
/**
* Serial number for inter-operability with different versions.
*/
private static final long serialVersionUID = 6412833018607679734L;;
/**
* Name of the handling restrictions on the resource.
*/
private Classification classification;
/**
* Explanation of the application of the legal constraints or other restrictions and legal
* prerequisites for obtaining and using the resource.
*/
private InternationalString userNote;
/**
* Name of the classification system.
*/
private InternationalString classificationSystem;
/**
* Additional information about the restrictions on handling the resource.
*/
private InternationalString handlingDescription;
/**
* Creates an initially empty security constraints.
*/
public DefaultSecurityConstraints() {
}
/**
* 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 DefaultSecurityConstraints(final SecurityConstraints source) {
super(source);
}
/**
* Creates a security constraints initialized with the specified classification.
*
* @param classification The nname of the handling restrictions on the resource.
*/
public DefaultSecurityConstraints(final Classification classification) {
setClassification(classification);
}
/**
* 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 DefaultSecurityConstraints wrap(final SecurityConstraints object) {
return (object == null) || (object instanceof DefaultSecurityConstraints)
? (DefaultSecurityConstraints) object : new DefaultSecurityConstraints(object);
}
/**
* Returns the name of the handling restrictions on the resource.
*/
@Override
@XmlElement(name = "classification", required = true)
public synchronized Classification getClassification() {
return classification;
}
/**
* Sets the name of the handling restrictions on the resource.
*
* @param newValue The new classification.
*/
public synchronized void setClassification(final Classification newValue) {
checkWritePermission();
classification = newValue;
}
/**
* Returns the explanation of the application of the legal constraints or other restrictions and legal
* prerequisites for obtaining and using the resource.
*/
@Override
@XmlElement(name = "userNote")
public synchronized InternationalString getUserNote() {
return userNote;
}
/**
* Sets the explanation of the application of the legal constraints or other restrictions and legal
* prerequisites for obtaining and using the resource.
*
* @param newValue The new user note.
*/
public synchronized void setUserNote(final InternationalString newValue) {
checkWritePermission();
userNote = newValue;
}
/**
* Returns the name of the classification system.
*/
@Override
@XmlElement(name = "classificationSystem")
public synchronized InternationalString getClassificationSystem() {
return classificationSystem;
}
/**
* Sets the name of the classification system.
*
* @param newValue The new classification system.
*/
public synchronized void setClassificationSystem(final InternationalString newValue) {
checkWritePermission();
classificationSystem = newValue;
}
/**
* Returns the additional information about the restrictions on handling the resource.
*/
@Override
@XmlElement(name = "handlingDescription")
public synchronized InternationalString getHandlingDescription() {
return handlingDescription;
}
/**
* Sets the additional information about the restrictions on handling the resource.
*
* @param newValue The new handling description.
*/
public synchronized void setHandlingDescription(final InternationalString newValue) {
checkWritePermission();
handlingDescription = newValue;
}
}