Package org.apache.sis.metadata.iso.constraint

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:

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      Serial number for inter-operability with different versions.
      See Also:

    • classification

      private org.opengis.metadata.constraint.Classification classification
      Name of the handling restrictions on the resource.

    • userNote

      private org.opengis.util.InternationalString userNote
      Explanation 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 classificationSystem
      Name of the classification system.

    • handlingDescription

      private org.opengis.util.InternationalString handlingDescription
      Additional information about the restrictions on handling the resource.

  • Constructor Details

    • DefaultSecurityConstraints

      public DefaultSecurityConstraints()
      Creates an initially empty security constraints.

    • DefaultSecurityConstraints

      public DefaultSecurityConstraints(CharSequence useLimitation)
      Constructs a new constraints with the given use limitation.
      Parameters:
      useLimitation - the use limitation, or null 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, or null.

    • 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, or null 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 returns null.
      • 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, or null 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.

    • getClassification

      public org.opengis.metadata.constraint.Classification getClassification()
      Returns the name of the handling restrictions on the resource.
      Specified by:
      getClassification in interface org.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 interface org.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 interface org.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 interface org.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.