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

Modifier and Type	Class	Description
static enum	Modifiable­Metadata.State	Whether the metadata is still editable or has been made final.

Field Summary

Fields inherited from class ISOMetadata

identifiers

Modifier and Type	Field	Description
protected Collection<Identifier>	identifiers	All identifiers associated with this metadata, or null if none.

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

Modifier and Type	Method	Description
protected Identifier	get­Identifier()	Returns the first identifier which is presumed to be defined by ISO 19115 conceptual model.
Identifier­Map	get­Identifier­Map()	A map view of the identifiers collection as (authority, code) entries.
Collection<Identifier>	get­Identifiers()	Returns all identifiers associated with this object (from conceptual model and from XML document).
Metadata­Standard	get­Standard()	Returns the metadata standard implemented by subclasses, which is ISO 19115.
protected void	set­Identifier(Identifier new­Value)	Sets the identifier for metadata objects that are expected to contain at most one ISO 19115 identifier.

Methods inherited from class ModifiableMetadata

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

Modifier and Type	Method	Description
protected void	check­Write­Permission(Object current)	Checks if changes in the metadata are allowed.
protected static <E> Collection<E>	copy­Collection(Collection<? extends E> source, Class<E> element­Type)	Creates a list or set with the content of the source collection, or returns null if the source is null or empty.
protected static <E> List<E>	copy­List(Collection<? extends E> source, Class<E> element­Type)	Creates a list with the content of the source collection, or returns null if the source is null or empty.
protected static <K,V> Map<K,V>	copy­Map(Map<? extends K, ? extends V> source, Class<K> key­Type)	Creates a map with the content of the source map, or returns null if the source is null or empty.
protected static <E> Set<E>	copy­Set(Collection<? extends E> source, Class<E> element­Type)	Creates a set with the content of the source collection, or returns null if the source is null or empty.
Modifiable­Metadata	deep­Copy(Modifiable­Metadata.State target)	Copies (if necessary) this metadata and all its children.
void	merge(Object source)	Merges the data from the given source into this metadata.
protected final <E> Collection<E>	non­Null­Collection(Collection<E> current, Class<E> element­Type)	Returns the specified collection, or a new one if current is null.
protected final <E> List<E>	non­Null­List(List<E> current, Class<E> element­Type)	Returns the specified list, or a new one if current is null.
protected final <K,V> Map<K,V>	non­Null­Map(Map<K,V> current, Class<K> key­Type)	Returns the specified map, or a new one if current is null.
protected final <E> Set<E>	non­Null­Set(Set<E> current, Class<E> element­Type)	Returns the specified set, or a new one if current is null.
protected static <E> Collection<E>	singleton(E value, Class<E> element­Type)	Creates a singleton list or set containing only the given value, if non-null.
Modifiable­Metadata.State	state()	Tells whether this instance of metadata is editable.
protected final <E> Collection<E>	write­Collection(Collection<? extends E> source, Collection<E> target, Class<E> element­Type)	Writes the content of the source collection into the target list or set, creating it if needed.
protected final <E> List<E>	write­List(Collection<? extends E> source, List<E> target, Class<E> element­Type)	Writes the content of the source collection into the target list, creating it if needed.
protected final <K,V> Map<K,V>	write­Map(Map<? extends K, ? extends V> source, Map<K,V> target, Class<K> key­Type)	Writes the content of the source map into the target map, creating it if needed.
protected final <E> Set<E>	write­Set(Collection<? extends E> source, Set<E> target, Class<E> element­Type)	Writes the content of the source collection into the target set, creating it if needed.

Methods inherited from class AbstractMetadata

as­Map, as­Tree­Table, clone, equals, equals, get­Interface, get­Standard­Type, hash­Code, is­Empty, nil­Reasons, prune, to­String

Modifier and Type	Method	Description
Map<String,Object>	as­Map()	Returns a view of the property values in a Map.
Tree­Table	as­Tree­Table()	Returns the property types and values as a tree table.
protected Abstract­Metadata	clone()	Returns a shallow clone of this metadata.
final boolean	equals(Object object)	Performs a strict comparison of this metadata with the given object.
boolean	equals(Object object, Comparison­Mode mode)	Compares this metadata with the specified object for equality.
final Class<?>	get­Interface()	Deprecated, for removal: This API element is subject to removal in a future version. Renamed Abstract­Metadata.get­Standard­Type() for integration with Lenient­Comparable.
Type	get­Standard­Type()	Returns the metadata interface implemented by this class.
int	hash­Code()	Computes a hash code value for this metadata using Java reflection.
boolean	is­Empty()	Returns true if this metadata contains only null, nil or empty properties.
Map<String, Nil­Reason>	nil­Reasons()	Returns a view of the reasons why some properties are missing.
void	prune()	Removes all references to empty properties.
String	to­String()	Returns a string representation of this metadata.

Methods inherited from class Object

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.