Class DefaultMedium
Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
DefaultMedium
- All Implemented Interfaces:
- Serializable,- Emptiable,- LenientComparable,- IdentifiedObject,- 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
   └─densityUnits…… 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 XMLinstead.
- Since:
- 0.3
- See Also:
Defined in the sis-metadata module
- 
Nested Class SummaryNested classes/interfaces inherited from class ModifiableMetadataModifiableMetadata.State
- 
Field SummaryFields inherited from class ISOMetadataidentifiers
- 
Constructor SummaryConstructorsConstructorDescriptionConstructs an initially empty medium.DefaultMedium(Medium object) Constructs a new instance initialized with the values from the specified metadata object.
- 
Method SummaryModifier and TypeMethodDescriptionstatic DefaultMediumcastOrCopy(Medium object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.Deprecated.Returns the density at which the data is recorded.Unit<?>Returns the units of measure for the recording density.Returns a unique identifier for an instance of the medium.Returns the method used to write to the medium.Returns a description of other limitations or requirements for using the medium.getName()Returns the name of the medium on which the resource can be received.Returns the number of items in the media identified.voidsetDensities(Collection<? extends Double> newValues) Deprecated.As of ISO 19115:2014, replaced bysetDensity(Double).voidsetDensity(Double newValue) Sets density at which the data is recorded.voidsetDensityUnits(Unit<?> newValue) Sets the units of measure for the recording density.voidsetIdentifier(Identifier newValue) Sets a unique identifier for an instance of the medium.voidsetMediumFormats(Collection<? extends MediumFormat> newValues) Sets the method used to write to the medium.voidsetMediumNote(InternationalString newValue) Sets a description of other limitations or requirements for using the medium.voidsetName(MediumName newValue) Sets the name of the medium on which the resource can be received.voidsetVolumes(Integer newValue) Sets the number of items in the media identified.Methods inherited from class ISOMetadatagetIdentifierMap, getIdentifiers, getStandard, transitionToMethods inherited from class ModifiableMetadatacheckWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSetMethods inherited from class AbstractMetadataasMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
- 
Constructor Details- 
DefaultMediumpublic DefaultMedium()Constructs an initially empty medium.
- 
DefaultMediumConstructs 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.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- nullif none.
- See Also:
 
 
- 
- 
Method Details- 
castOrCopyReturns 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
       DefaultMedium, then it is returned unchanged.
- Otherwise a new DefaultMediuminstance 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- nullif none.
- Returns:
- a SIS implementation containing the values of the given object (may be the
         given object itself), or nullif the argument was null.
 
- If the given object is 
- 
getNameReturns the name of the medium on which the resource can be received.
- 
setNameSets the name of the medium on which the resource can be received.- Parameters:
- newValue- the new name.
 
- 
getDensity@ValueRange(minimum=0.0, isMinIncluded=false) @UML(identifier="density", obligation=OPTIONAL, specification=ISO_19115) public Double getDensity()Returns the density at which the data is recorded. The number shall be greater than zero.- Returns:
- density at which the data is recorded, or null.
- Since:
- 0.5
 
- 
setDensitySets density at which the data is recorded. The number shall be greater than zero.- Parameters:
- newValue- the new density.
- Throws:
- IllegalArgumentException- if the given value is NaN, zero or negative.
- Since:
- 0.5
 
- 
getDensitiesDeprecated.As of ISO 19115:2014, replaced bygetDensity().- Specified by:
- getDensitiesin interface- Medium
- Returns:
- density at which the data is recorded, or null.
 
- 
setDensitiesDeprecated.As of ISO 19115:2014, replaced bysetDensity(Double).- Parameters:
- newValues- the new densities.
 
- 
getDensityUnitsReturns the units of measure for the recording density.- Specified by:
- getDensityUnitsin interface- Medium
- Returns:
- units of measure for the recording density, or null.
 
- 
setDensityUnitsSets the units of measure for the recording density.- Parameters:
- newValue- the new density units.
 
- 
getVolumesReturns the number of items in the media identified.- Specified by:
- getVolumesin interface- Medium
- Returns:
- number of items in the media identified, or null.
 
- 
setVolumesSets the number of items in the media identified.- Parameters:
- newValue- the new volumes, or- null.
- Throws:
- IllegalArgumentException- if the given value is negative.
 
- 
getMediumFormatsReturns the method used to write to the medium.- Specified by:
- getMediumFormatsin interface- Medium
- Returns:
- method used to write to the medium, or null.
 
- 
setMediumFormatsSets the method used to write to the medium.- Parameters:
- newValues- the new medium formats.
 
- 
getMediumNoteReturns a description of other limitations or requirements for using the medium.- Specified by:
- getMediumNotein interface- Medium
- Returns:
- description of other limitations for using the medium, or null.
 
- 
setMediumNoteSets a description of other limitations or requirements for using the medium.- Parameters:
- newValue- the new medium note.
 
- 
getIdentifier@UML(identifier="identifier", obligation=OPTIONAL, specification=ISO_19115) public Identifier getIdentifier()Returns a unique identifier for an instance of the medium.- Overrides:
- getIdentifierin class- ISOMetadata
- Returns:
- unique identifier, or nullif none.
- Since:
- 0.5
 
- 
setIdentifierSets a unique identifier for an instance of the medium.- Overrides:
- setIdentifierin class- ISOMetadata
- Parameters:
- newValue- the new identifier.
- Since:
- 0.5
 
 
- 
getDensity().