Class DefaultMedium

  • All Implemented Interfaces:
    Serializable, Emptiable, Lenient­Comparable, Identified­Object, Medium

    public class DefaultMedium
    extends ISOMetadata
    implements Medium
    Information about the media on which the resource can be distributed. The following property is mandatory or conditional (i.e. mandatory under some circumstances) in a well-formed metadata according ISO 19115:
    MD_Medium   └─density­Units…… Units of measure for the recording density.

    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
    See Also:
    Serialized Form

    Defined in the sis-metadata module

    • Constructor Detail

      • DefaultMedium

        public DefaultMedium()
        Constructs an initially empty medium.
      • DefaultMedium

        public DefaultMedium​(Medium object)
        Constructs a new instance initialized with the values from the specified metadata object. This is a shallow copy constructor, since the other metadata contained in the given object are not recursively copied.
        Note on properties validation: This constructor does not verify the property values of the given metadata (e.g. whether it contains unexpected negative values). This is because invalid metadata exist in practice, and verifying their validity in this copy constructor is often too late. Note that this is not the only hole, as invalid metadata instances can also be obtained by unmarshalling an invalid XML document.
        Parameters:
        object - the metadata to copy values from, or null if none.
        See Also:
        cast­Or­Copy(Medium)
    • Method Detail

      • castOrCopy

        public static DefaultMedium castOrCopy​(Medium 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 Default­Medium, then it is returned unchanged.
        • Otherwise a new Default­Medium instance is created using the copy constructor and returned. Note that this is a shallow copy operation, since 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.
      • getName

        public MediumName getName()
        Returns the name of the medium on which the resource can be received.
        Upcoming API change
        Medium­Name may be replaced by Citation in GeoAPI 4.0.
        Specified by:
        get­Name in interface Medium
        Returns:
        name of the medium, or null.
        See Also:
        SIS-389
      • setName

        public void setName​(MediumName newValue)
        Sets the name of the medium on which the resource can be received.
        Upcoming API change
        Medium­Name may be replaced by Citation in GeoAPI 4.0.
        Parameters:
        new­Value - the new name.
      • setDensity

        public void setDensity​(Double newValue)
        Sets density at which the data is recorded. The number shall be greater than zero.
        Parameters:
        new­Value - the new density.
        Throws:
        Illegal­Argument­Exception - if the given value is NaN, zero or negative.
        Since:
        0.5
      • getDensityUnits

        public Unit<?> getDensityUnits()
        Returns the units of measure for the recording density.
        Specified by:
        get­Density­Units in interface Medium
        Returns:
        units of measure for the recording density, or null.
      • setDensityUnits

        public void setDensityUnits​(Unit<?> newValue)
        Sets the units of measure for the recording density.
        Parameters:
        new­Value - the new density units.
      • getVolumes

        @ValueRange(minimum=0.0)
        public Integer getVolumes()
        Returns the number of items in the media identified.
        Specified by:
        get­Volumes in interface Medium
        Returns:
        number of items in the media identified, or null.
      • setVolumes

        public void setVolumes​(Integer newValue)
        Sets the number of items in the media identified.
        Parameters:
        new­Value - the new volumes, or null.
        Throws:
        Illegal­Argument­Exception - if the given value is negative.
      • setMediumFormats

        public void setMediumFormats​(Collection<? extends MediumFormat> newValues)
        Sets the method used to write to the medium.
        Parameters:
        new­Values - the new medium formats.
      • getMediumNote

        public InternationalString getMediumNote()
        Returns a description of other limitations or requirements for using the medium.
        Specified by:
        get­Medium­Note in interface Medium
        Returns:
        description of other limitations for using the medium, or null.
      • setMediumNote

        public void setMediumNote​(InternationalString newValue)
        Sets a description of other limitations or requirements for using the medium.
        Parameters:
        new­Value - the new medium note.
      • setIdentifier

        public void setIdentifier​(Identifier newValue)
        Sets a unique identifier for an instance of the medium.
        Overrides:
        set­Identifier in class ISOMetadata
        Parameters:
        new­Value - the new identifier.
        Since:
        0.5