Class DefaultSecurityConstraints
java.lang.Object
org.apache.sis.metadata.AbstractMetadata
org.apache.sis.metadata.ModifiableMetadata
org.apache.sis.metadata.iso.ISOMetadata
org.apache.sis.metadata.iso.constraint.DefaultConstraints
org.apache.sis.metadata.iso.constraint.DefaultSecurityConstraints
- All Implemented Interfaces:
Serializable
,Emptiable
,LenientComparable
,IdentifiedObject
,org.opengis.metadata.constraint.Constraints
,org.opengis.metadata.constraint.SecurityConstraints
- Direct Known Subclasses:
SecurityConstraints
public class DefaultSecurityConstraints
extends DefaultConstraints
implements org.opengis.metadata.constraint.SecurityConstraints
Handling restrictions imposed on the resource for national security or similar security concerns.
The following property is mandatory in a well-formed metadata according ISO 19115:
MD_SecurityConstraints
└─classification…………
Name of the handling restrictions on the resource.Limitations
- Instances of this class are not synchronized for multi-threading. Synchronization, if needed, is caller's responsibility.
- Serialized objects of this class are not guaranteed to be compatible with future Apache SIS releases.
Serialization support is appropriate for short term storage or RMI between applications running the
same version of Apache SIS. For long term storage, use
XML
instead.
- Since:
- 0.3
- Version:
- 1.0
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.sis.metadata.ModifiableMetadata
ModifiableMetadata.State
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate org.opengis.metadata.constraint.Classification
Name of the handling restrictions on the resource.private org.opengis.util.InternationalString
Name of the classification system.private org.opengis.util.InternationalString
Additional information about the restrictions on handling the resource.private static final long
Serial number for inter-operability with different versions.private org.opengis.util.InternationalString
Explanation of the application of the legal constraints or other restrictions and legal prerequisites for obtaining and using the resource.Fields inherited from class org.apache.sis.metadata.iso.ISOMetadata
identifiers
-
Constructor Summary
ConstructorsConstructorDescriptionCreates an initially empty security constraints.DefaultSecurityConstraints
(CharSequence useLimitation) Constructs a new constraints with the given use limitation.DefaultSecurityConstraints
(org.opengis.metadata.constraint.Classification classification) Creates a security constraints initialized with the specified classification.DefaultSecurityConstraints
(org.opengis.metadata.constraint.SecurityConstraints object) Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultSecurityConstraints
castOrCopy
(org.opengis.metadata.constraint.SecurityConstraints object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.org.opengis.metadata.constraint.Classification
Returns the name of the handling restrictions on the resource.org.opengis.util.InternationalString
Returns the name of the classification system.org.opengis.util.InternationalString
Returns the additional information about the restrictions on handling the resource.org.opengis.util.InternationalString
Returns the explanation of the application of the legal constraints or other restrictions and legal prerequisites for obtaining and using the resource.void
setClassification
(org.opengis.metadata.constraint.Classification newValue) Sets the name of the handling restrictions on the resource.void
setClassificationSystem
(org.opengis.util.InternationalString newValue) Sets the name of the classification system.void
setHandlingDescription
(org.opengis.util.InternationalString newValue) Sets the additional information about the restrictions on handling the resource.void
setUserNote
(org.opengis.util.InternationalString newValue) Sets the explanation of the application of the legal constraints or other restrictions and legal prerequisites for obtaining and using the resource.Methods inherited from class org.apache.sis.metadata.iso.constraint.DefaultConstraints
castOrCopy, getConstraintApplicationScope, getGraphics, getReferences, getReleasability, getResponsibleParties, getUseLimitations, setConstraintApplicationScope, setGraphics, setReferences, setReleasability, setResponsibleParties, setUseLimitations
Methods inherited from class org.apache.sis.metadata.iso.ISOMetadata
getIdentifier, getIdentifierMap, getIdentifiers, getStandard, setIdentifier, transitionTo
Methods inherited from class org.apache.sis.metadata.ModifiableMetadata
checkWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSet
Methods inherited from class org.apache.sis.metadata.AbstractMetadata
asMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.opengis.metadata.constraint.Constraints
getUseLimitations
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDSerial number for inter-operability with different versions.- See Also:
-
classification
private org.opengis.metadata.constraint.Classification classificationName of the handling restrictions on the resource. -
userNote
private org.opengis.util.InternationalString userNoteExplanation of the application of the legal constraints or other restrictions and legal prerequisites for obtaining and using the resource. -
classificationSystem
private org.opengis.util.InternationalString classificationSystemName of the classification system. -
handlingDescription
private org.opengis.util.InternationalString handlingDescriptionAdditional information about the restrictions on handling the resource.
-
-
Constructor Details
-
DefaultSecurityConstraints
public DefaultSecurityConstraints()Creates an initially empty security constraints. -
DefaultSecurityConstraints
Constructs a new constraints with the given use limitation.- Parameters:
useLimitation
- the use limitation, ornull
if none.
-
DefaultSecurityConstraints
public DefaultSecurityConstraints(org.opengis.metadata.constraint.Classification classification) Creates a security constraints initialized with the specified classification.- Parameters:
classification
- the name of the handling restrictions on the resource, ornull
.
-
DefaultSecurityConstraints
public DefaultSecurityConstraints(org.opengis.metadata.constraint.SecurityConstraints object) Constructs a new instance initialized with the values from the specified metadata object. This is a shallow copy constructor, because the other metadata contained in the given object are not recursively copied.- Parameters:
object
- the metadata to copy values from, ornull
if none.- See Also:
-
-
Method Details
-
castOrCopy
public static DefaultSecurityConstraints castOrCopy(org.opengis.metadata.constraint.SecurityConstraints object) Returns a SIS metadata implementation with the values of the given arbitrary implementation. This method performs the first applicable action in the following choices:- If the given object is
null
, then this method returnsnull
. - Otherwise if the given object is already an instance of
DefaultSecurityConstraints
, then it is returned unchanged. - Otherwise a new
DefaultSecurityConstraints
instance is created using the copy constructor and returned. Note that this is a shallow copy operation, because the other metadata contained in the given object are not recursively copied.
- Parameters:
object
- the object to get as a SIS implementation, ornull
if none.- Returns:
- a SIS implementation containing the values of the given object (may be the
given object itself), or
null
if the argument was null.
- If the given object is
-
getClassification
public org.opengis.metadata.constraint.Classification getClassification()Returns the name of the handling restrictions on the resource.- Specified by:
getClassification
in interfaceorg.opengis.metadata.constraint.SecurityConstraints
- Returns:
- name of the handling restrictions on the resource, or
null
.
-
setClassification
public void setClassification(org.opengis.metadata.constraint.Classification newValue) Sets the name of the handling restrictions on the resource.- Parameters:
newValue
- the new classification.
-
getUserNote
public org.opengis.util.InternationalString getUserNote()Returns the explanation of the application of the legal constraints or other restrictions and legal prerequisites for obtaining and using the resource.- Specified by:
getUserNote
in interfaceorg.opengis.metadata.constraint.SecurityConstraints
- Returns:
- explanation of the application of the legal constraints, or
null
.
-
setUserNote
public void setUserNote(org.opengis.util.InternationalString newValue) Sets the explanation of the application of the legal constraints or other restrictions and legal prerequisites for obtaining and using the resource.- Parameters:
newValue
- the new user note.
-
getClassificationSystem
public org.opengis.util.InternationalString getClassificationSystem()Returns the name of the classification system.- Specified by:
getClassificationSystem
in interfaceorg.opengis.metadata.constraint.SecurityConstraints
- Returns:
- name of the classification system, or
null
.
-
setClassificationSystem
public void setClassificationSystem(org.opengis.util.InternationalString newValue) Sets the name of the classification system.- Parameters:
newValue
- the new classification system.
-
getHandlingDescription
public org.opengis.util.InternationalString getHandlingDescription()Returns the additional information about the restrictions on handling the resource.- Specified by:
getHandlingDescription
in interfaceorg.opengis.metadata.constraint.SecurityConstraints
- Returns:
- additional information about the restrictions, or
null
.
-
setHandlingDescription
public void setHandlingDescription(org.opengis.util.InternationalString newValue) Sets the additional information about the restrictions on handling the resource.- Parameters:
newValue
- the new handling description.
-