Module org.apache.sis.metadata

Package org.apache.sis.metadata.iso.distribution

Class DefaultDistribution

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultDistribution

All Implemented Interfaces:

Serializable, Emptiable, Lenient­Comparable, Identified­Object, Distribution

@TitleProperty(name="description")
public class DefaultDistribution
extends ISOMetadata
implements 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 └─distribution­Format……………………………………… Description of the format of the data to be distributed. └─format­Specification­Citation…… 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

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ModifiableMetadata

Modifiable­Metadata.State

Field Summary

Fields inherited from class ISOMetadata

identifiers

Constructor Summary

Constructors

Constructor	Description
Default­Distribution()	Constructs an initially empty distribution.
Default­Distribution(Distribution object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
static Default­Distribution	cast­Or­Copy(Distribution object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
International­String	get­Description()	Returns a brief description of a set of distribution options.
Collection<Format>	get­Distribution­Formats()	Provides a description of the format of the data to be distributed.
Collection<Distributor>	get­Distributors()	Provides information about the distributor.
Collection<Digital­Transfer­Options>	get­Transfer­Options()	Provides information about technical means and media by which a resource is obtained from the distributor.
void	set­Description(International­String new­Value)	Sets a brief description of a set of distribution options.
void	set­Distribution­Formats(Collection<? extends Format> new­Values)	Sets a description of the format of the data to be distributed.
void	set­Distributors(Collection<? extends Distributor> new­Values)	Sets information about the distributor.
void	set­Transfer­Options(Collection<? extends Digital­Transfer­Options> new­Values)	Sets information about technical means and media by which a resource is obtained from the distributor.

Methods inherited from class ISOMetadata

get­Identifier, get­Identifier­Map, get­Identifiers, get­Standard, set­Identifier, transition­To

Methods inherited from class ModifiableMetadata

check­Write­Permission, collection­Type, copy­Collection, copy­List, copy­Map, copy­Set, deep­Copy, non­Null­Collection, non­Null­List, non­Null­Map, non­Null­Set, singleton, state, write­Collection, write­List, write­Map, write­Set

Methods inherited from class AbstractMetadata

as­Map, as­Tree­Table, equals, equals, get­Interface, hash­Code, is­Empty, prune, to­String

Methods inherited from class Object

clone, finalize, get­Class, notify, notify­All, wait, wait, wait

Constructor Details

DefaultDistribution

public DefaultDistribution()

Constructs an initially empty distribution.

DefaultDistribution

public DefaultDistribution(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, or null if none.

See Also:

• cast­Or­Copy(Distribution)

Method Details

castOrCopy

public static DefaultDistribution castOrCopy(Distribution 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­Distribution, then it is returned unchanged.
• Otherwise a new Default­Distribution 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.

getDescription

@UML(identifier="description",
     obligation=OPTIONAL,
     specification=ISO_19115)
public 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(InternationalString newValue)

Sets a brief description of a set of distribution options.

Parameters:

new­Value - the new description.

Since:

0.5

getDistributionFormats

public Collection<Format> getDistributionFormats()

Provides a description of the format of the data to be distributed.

Specified by:

get­Distribution­Formats in interface Distribution

Returns:

description of the format of the data to be distributed.

See Also:

• Abstract­Identification.get­Resource­Formats()

setDistributionFormats

public void setDistributionFormats(Collection<? extends Format> newValues)

Sets a description of the format of the data to be distributed.

Parameters:

new­Values - the new distribution formats.

See Also:

• Abstract­Identification.set­Resource­Formats(Collection)

getDistributors

public Collection<Distributor> getDistributors()

Provides information about the distributor.

Specified by:

get­Distributors in interface Distribution

Returns:

information about the distributor.

setDistributors

public void setDistributors(Collection<? extends Distributor> newValues)

Sets information about the distributor.

Parameters:

new­Values - the new distributors.

getTransferOptions

public Collection<DigitalTransferOptions> getTransferOptions()

Provides information about technical means and media by which a resource is obtained from the distributor.

Specified by:

get­Transfer­Options in interface Distribution

Returns:

technical means and media by which a resource is obtained from the distributor.

setTransferOptions

public void setTransferOptions(Collection<? extends DigitalTransferOptions> newValues)

Sets information about technical means and media by which a resource is obtained from the distributor.

Parameters:

new­Values - the new transfer options.