Module org.apache.sis.metadata

Package org.apache.sis.metadata.iso

Class DefaultPortrayalCatalogueReference

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultPortrayalCatalogueReference

All Implemented Interfaces:

Serializable, Emptiable, Lenient­Comparable, Identified­Object, Portrayal­Catalogue­Reference

public class DefaultPortrayalCatalogueReference
extends ISOMetadata
implements PortrayalCatalogueReference

Information identifying the portrayal catalogue used. The following properties are mandatory in a well-formed metadata according ISO 19115:

MD_Portrayal­Catalogue­Reference └─portrayal­Catalogue­Citation…… Bibliographic reference to the portrayal catalogue cited. ├─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­Portrayal­Catalogue­Reference()	Construct an initially empty portrayal catalogue reference.
Default­Portrayal­Catalogue­Reference(Citation portrayal­Catalogue­Citation)	Creates a portrayal catalogue reference initialized to the given reference.
Default­Portrayal­Catalogue­Reference(Portrayal­Catalogue­Reference object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
static Default­Portrayal­Catalogue­Reference	cast­Or­Copy(Portrayal­Catalogue­Reference object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Collection<Citation>	get­Portrayal­Catalogue­Citations()	Bibliographic reference to the portrayal catalogue cited.
void	set­Portrayal­Catalogue­Citations(Collection<? extends Citation> new­Values)	Sets bibliographic reference to the portrayal catalogue cited.

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

DefaultPortrayalCatalogueReference

public DefaultPortrayalCatalogueReference()

Construct an initially empty portrayal catalogue reference.

DefaultPortrayalCatalogueReference

public DefaultPortrayalCatalogueReference(Citation portrayalCatalogueCitation)

Creates a portrayal catalogue reference initialized to the given reference.

Parameters:

portrayal­Catalogue­Citation - the bibliographic reference, or null if none.

DefaultPortrayalCatalogueReference

public DefaultPortrayalCatalogueReference(PortrayalCatalogueReference 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(Portrayal­Catalogue­Reference)

Method Details

castOrCopy

public static DefaultPortrayalCatalogueReference castOrCopy(PortrayalCatalogueReference 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­Portrayal­Catalogue­Reference, then it is returned unchanged.
• Otherwise a new Default­Portrayal­Catalogue­Reference 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.

getPortrayalCatalogueCitations

public Collection<Citation> getPortrayalCatalogueCitations()

Bibliographic reference to the portrayal catalogue cited.

Specified by:

get­Portrayal­Catalogue­Citations in interface Portrayal­Catalogue­Reference

Returns:

references to the portrayal catalogue cited.

setPortrayalCatalogueCitations

public void setPortrayalCatalogueCitations(Collection<? extends Citation> newValues)

Sets bibliographic reference to the portrayal catalogue cited.

Parameters:

new­Values - the new portrayal catalogue citations.