Class DefaultDistribution
java.lang.Object
org.apache.sis.metadata.AbstractMetadata
org.apache.sis.metadata.ModifiableMetadata
org.apache.sis.metadata.iso.ISOMetadata
org.apache.sis.metadata.iso.distribution.DefaultDistribution
- All Implemented Interfaces:
Serializable
,Emptiable
,LenientComparable
,IdentifiedObject
,org.opengis.metadata.distribution.Distribution
@TitleProperty(name="description")
public class DefaultDistribution
extends ISOMetadata
implements org.opengis.metadata.distribution.Distribution
Information about the distributor of and options for obtaining the resource.
The following properties are mandatory or conditional (i.e. mandatory under some circumstances)
in a well-formed metadata according ISO 19115:
MD_Distribution
└─distributionFormat………………………………………
Description of the format of the data to be distributed.
└─formatSpecificationCitation……
Citation/URL of the specification format.
├─title……………………………………………………
Name by which the cited resource is known.
└─date………………………………………………………
Reference date for the cited 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.util.InternationalString
Brief description of a set of distribution options.private Collection
<org.opengis.metadata.distribution.Format> Provides a description of the format of the data to be distributed.private Collection
<org.opengis.metadata.distribution.Distributor> Provides information about the distributor.private static final long
Serial number for inter-operability with different versions.private Collection
<org.opengis.metadata.distribution.DigitalTransferOptions> Provides information about technical means and media by which a resource is obtained from the distributor.Fields inherited from class org.apache.sis.metadata.iso.ISOMetadata
identifiers
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs an initially empty distribution.DefaultDistribution
(org.opengis.metadata.distribution.Distribution object) Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultDistribution
castOrCopy
(org.opengis.metadata.distribution.Distribution object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.org.opengis.util.InternationalString
Returns a brief description of a set of distribution options.Collection
<org.opengis.metadata.distribution.Format> Provides a description of the format of the data to be distributed.Collection
<org.opengis.metadata.distribution.Distributor> Provides information about the distributor.Collection
<org.opengis.metadata.distribution.DigitalTransferOptions> Provides information about technical means and media by which a resource is obtained from the distributor.void
setDescription
(org.opengis.util.InternationalString newValue) Sets a brief description of a set of distribution options.void
setDistributionFormats
(Collection<? extends org.opengis.metadata.distribution.Format> newValues) Sets a description of the format of the data to be distributed.void
setDistributors
(Collection<? extends org.opengis.metadata.distribution.Distributor> newValues) Sets information about the distributor.void
setTransferOptions
(Collection<? extends org.opengis.metadata.distribution.DigitalTransferOptions> newValues) Sets information about technical means and media by which a resource is obtained from the distributor.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
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDSerial number for inter-operability with different versions.- See Also:
-
description
private org.opengis.util.InternationalString descriptionBrief description of a set of distribution options. -
distributionFormats
Provides a description of the format of the data to be distributed. -
distributors
Provides information about the distributor. -
transferOptions
Provides information about technical means and media by which a resource is obtained from the distributor.
-
-
Constructor Details
-
DefaultDistribution
public DefaultDistribution()Constructs an initially empty distribution. -
DefaultDistribution
public DefaultDistribution(org.opengis.metadata.distribution.Distribution 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
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
DefaultDistribution
, then it is returned unchanged. - Otherwise a new
DefaultDistribution
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
-
getDescription
@UML(identifier="description", obligation=OPTIONAL, specification=ISO_19115) public org.opengis.util.InternationalString getDescription()Returns a brief description of a set of distribution options.- Returns:
- brief description of a set of distribution options.
- Since:
- 0.5
-
setDescription
public void setDescription(org.opengis.util.InternationalString newValue) Sets a brief description of a set of distribution options.- Parameters:
newValue
- the new description.- Since:
- 0.5
-
getDistributionFormats
Provides a description of the format of the data to be distributed.- Specified by:
getDistributionFormats
in interfaceorg.opengis.metadata.distribution.Distribution
- Returns:
- description of the format of the data to be distributed.
- See Also:
-
setDistributionFormats
public void setDistributionFormats(Collection<? extends org.opengis.metadata.distribution.Format> newValues) Sets a description of the format of the data to be distributed.- Parameters:
newValues
- the new distribution formats.- See Also:
-
getDistributors
Provides information about the distributor.- Specified by:
getDistributors
in interfaceorg.opengis.metadata.distribution.Distribution
- Returns:
- information about the distributor.
-
setDistributors
public void setDistributors(Collection<? extends org.opengis.metadata.distribution.Distributor> newValues) Sets information about the distributor.- Parameters:
newValues
- the new distributors.
-
getTransferOptions
Provides information about technical means and media by which a resource is obtained from the distributor.- Specified by:
getTransferOptions
in interfaceorg.opengis.metadata.distribution.Distribution
- Returns:
- technical means and media by which a resource is obtained from the distributor.
-
setTransferOptions
public void setTransferOptions(Collection<? extends org.opengis.metadata.distribution.DigitalTransferOptions> newValues) Sets information about technical means and media by which a resource is obtained from the distributor.- Parameters:
newValues
- the new transfer options.
-